Package org.jenkinsci.plugins.github.extension

Class GHSubscriberEvent

java.lang.Object
jenkins.scm.api.SCMEvent<String>
org.jenkinsci.plugins.github.extension.GHSubscriberEvent
public class GHSubscriberEvent extends jenkins.scm.api.SCMEvent<String>
An event for a GHEventsSubscriber.
Since:
1.26.0

  • Nested Class Summary

    Nested classes/interfaces inherited from class jenkins.scm.api.SCMEvent

    jenkins.scm.api.SCMEvent.Dispatcher<E extends jenkins.scm.api.SCMEvent<?>>, jenkins.scm.api.SCMEvent.EventQueueMetrics, jenkins.scm.api.SCMEvent.Type

  • Field Summary

    Fields inherited from class jenkins.scm.api.SCMEvent

    ORIGIN_UNKNOWN

  • Constructor Summary

    Constructors
    Constructor
    Description
    GHSubscriberEvent(String eventGuid, String origin, org.kohsuke.github.GHEvent ghEvent, String payload)
    Constructs a new GHSubscriberEvent.
    GHSubscriberEvent(String origin, org.kohsuke.github.GHEvent ghEvent, String payload)
    Deprecated.
    use GHSubscriberEvent(String, String, GHEvent, String) instead.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getEventGuid()
     
    org.kohsuke.github.GHEvent
    getGHEvent()
    Gets the type of event received.

    Methods inherited from class jenkins.scm.api.SCMEvent

    asCauses, closeExecutorService, description, equals, executorService, getDate, getEventProcessingMetrics, getOrigin, getPayload, getTimestamp, getType, hashCode, originOf, originOf, toString

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • GHSubscriberEvent

      @Deprecated public GHSubscriberEvent(@CheckForNull String origin, @NonNull org.kohsuke.github.GHEvent ghEvent, @NonNull String payload)
      Deprecated.
      use GHSubscriberEvent(String, String, GHEvent, String) instead.

    • GHSubscriberEvent

      public GHSubscriberEvent(@CheckForNull String eventGuid, @CheckForNull String origin, @NonNull org.kohsuke.github.GHEvent ghEvent, @NonNull String payload)
      Constructs a new GHSubscriberEvent.
      Parameters:
      eventGuid - the globally unique identifier (GUID) to identify the event; value of request header GitHubWebHook.X_GITHUB_DELIVERY.
      origin - the origin (see SCMEvent.originOf(HttpServletRequest)) or null.
      ghEvent - the type of event received from GitHub.
      payload - the event payload.

  • Method Details

    • getGHEvent

      public org.kohsuke.github.GHEvent getGHEvent()
      Gets the type of event received.
      Returns:
      the type of event received.

    • getEventGuid

      @CheckForNull public String getEventGuid()