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 origin, org.kohsuke.github.GHEvent ghEvent, String payload)
    Constructs a new GHSubscriberEvent.
  • Method Summary

    Modifier and Type
    Method
    Description
    org.kohsuke.github.GHEvent
    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, toString

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • GHSubscriberEvent

      public GHSubscriberEvent(@CheckForNull String origin, @NonNull org.kohsuke.github.GHEvent ghEvent, @NonNull String payload)
      Constructs a new GHSubscriberEvent.
      Parameters:
      origin - the origin (see SCMEvent.originOf(javax.servlet.http.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.