Interface StatusEvent
-
- All Superinterfaces:
BaseEvent,UpdateTracking
- All Known Implementing Classes:
ImmutableStatusEvent
@Immutable public interface StatusEvent extends BaseEvent, UpdateTracking
Triggered when the status of a Git commit changes.Events of this type are not visible in timelines. These events are only used to trigger hooks.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description List<Branch>branches()An array of branch objects containing the status' SHA.CommitItemcommit()Related git commitStringcontext()A string label to differentiate this status from the status of other systems.Optional<String>description()The optional human-readable description added to the status.Longid()Status event idStringname()Full repository name.Stringsha()The Commit SHA.Stringstate()The new state.Optional<URI>targetUrl()The optional link added to the status.-
Methods inherited from interface com.spotify.github.v3.activity.events.BaseEvent
eventInstallation, repository, sender
-
Methods inherited from interface com.spotify.github.UpdateTracking
createdAt, updatedAt
-
-
-
-
Method Detail
-
id
@Nullable Long id()
Status event id
-
sha
@Nullable String sha()
The Commit SHA.
-
name
@Nullable String name()
Full repository name. E.g. organization/repo-name
-
context
@Nullable String context()
A string label to differentiate this status from the status of other systems. Example: continuous-integration/jenkins Default: "default"
-
description
Optional<String> description()
The optional human-readable description added to the status.
-
state
@Nullable String state()
The new state. Can be pending, success, failure, or error.
-
commit
@Nullable CommitItem commit()
Related git commit
-
-