Module org.kohsuke.github.api
Package org.kohsuke.github

Class GHDeployment

java.lang.Object
org.kohsuke.github.GHObject
org.kohsuke.github.GHDeployment
public class GHDeployment extends GHObject
Represents a deployment.
See Also:

  • Field Details

    • creator

      protected GHUser creator
      The creator.

    • description

      protected String description
      The description.

    • environment

      protected String environment
      The environment.

    • originalEnvironment

      protected String originalEnvironment
      The original environment.

    • payload

      protected Object payload
      The payload.

    • productionEnvironment

      protected boolean productionEnvironment
      The production environment.

    • ref

      protected String ref
      The ref.

    • repositoryUrl

      protected String repositoryUrl
      The repository url.

    • sha

      protected String sha
      The sha.

    • statusesUrl

      protected String statusesUrl
      The statuses url.

    • task

      protected String task
      The task.

    • transientEnvironment

      protected boolean transientEnvironment
      The transient environment.

  • Constructor Details

    • GHDeployment

      public GHDeployment()
      Create default GHDeployment instance

  • Method Details

    • createStatus

      public GHDeploymentStatusBuilder createStatus(GHDeploymentState state)
      Create status gh deployment status builder.
      Parameters:
      state - the state
      Returns:
      the gh deployment status builder

    • getCreator

      public GHUser getCreator()
      Gets creator.
      Returns:
      the creator

    • getEnvironment

      public String getEnvironment()
      Gets environment.
      Returns:
      the environment

    • getOriginalEnvironment

      public String getOriginalEnvironment()
      The environment defined when the deployment was first created.
      Returns:
      the original deployment environment

    • getPayload

      public String getPayload()
      Gets payload. NOTE: only use this method if you can guarantee the payload will be a simple string, otherwise use getPayloadObject().
      Returns:
      the payload

    • getPayloadMap

      public Map<String,Object> getPayloadMap()
      Gets payload. NOTE: only use this method if you can guarantee the payload will be a JSON object (Map), otherwise use getPayloadObject().
      Returns:
      the payload

    • getPayloadObject

      public Object getPayloadObject()
      Gets payload without assuming its type. It could be a String or a Map.
      Returns:
      the payload

    • getRef

      public String getRef()
      Gets ref.
      Returns:
      the ref

    • getRepositoryUrl

      public URL getRepositoryUrl()
      Gets repository url.
      Returns:
      the repository url

    • getSha

      public String getSha()
      Gets sha.
      Returns:
      the sha

    • getStatusesUrl

      public URL getStatusesUrl()
      Gets statuses url.
      Returns:
      the statuses url

    • getTask

      public String getTask()
      Gets task.
      Returns:
      the task

    • isProductionEnvironment

      public boolean isProductionEnvironment()
      Specifies if the given environment is one that end-users directly interact with.
      Returns:
      the environment is used by end-users directly

    • isTransientEnvironment

      public boolean isTransientEnvironment()
      Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future.
      Returns:
      the environment is transient

    • listStatuses

      public PagedIterable<GHDeploymentStatus> listStatuses()
      List statuses paged iterable.
      Returns:
      the paged iterable