Package software.amazon.awssdk.services.codepipeline.model

Class PipelineExecution

java.lang.Object
software.amazon.awssdk.services.codepipeline.model.PipelineExecution
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<PipelineExecution.Builder,PipelineExecution>
@Generated("software.amazon.awssdk:codegen") public final class PipelineExecution extends Object implements SdkPojo, Serializable, ToCopyableBuilder<PipelineExecution.Builder,PipelineExecution>

Represents information about an execution of a pipeline.

See Also:

  • Method Details

    • pipelineName

      public final String pipelineName()

      The name of the pipeline with the specified pipeline execution.

      Returns:
      The name of the pipeline with the specified pipeline execution.

    • pipelineVersion

      public final Integer pipelineVersion()

      The version number of the pipeline with the specified pipeline execution.

      Returns:
      The version number of the pipeline with the specified pipeline execution.

    • pipelineExecutionId

      public final String pipelineExecutionId()

      The ID of the pipeline execution.

      Returns:
      The ID of the pipeline execution.

    • status

      public final PipelineExecutionStatus status()

      The status of the pipeline execution.

      • Cancelled: The pipeline’s definition was updated before the pipeline execution could be completed.

      • InProgress: The pipeline execution is currently running.

      • Stopped: The pipeline execution was manually stopped. For more information, see Stopped Executions.

      • Stopping: The pipeline execution received a request to be manually stopped. Depending on the selected stop mode, the execution is either completing or abandoning in-progress actions. For more information, see Stopped Executions.

      • Succeeded: The pipeline execution was completed successfully.

      • Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution advanced and continued through the pipeline instead. For more information, see Superseded Executions.

      • Failed: The pipeline execution was not completed successfully.

      If the service returns an enum value that is not available in the current SDK version, status will return PipelineExecutionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The status of the pipeline execution.

      • Cancelled: The pipeline’s definition was updated before the pipeline execution could be completed.

      • InProgress: The pipeline execution is currently running.

      • Stopped: The pipeline execution was manually stopped. For more information, see Stopped Executions.

      • Stopping: The pipeline execution received a request to be manually stopped. Depending on the selected stop mode, the execution is either completing or abandoning in-progress actions. For more information, see Stopped Executions.

      • Succeeded: The pipeline execution was completed successfully.

      • Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution advanced and continued through the pipeline instead. For more information, see Superseded Executions.

      • Failed: The pipeline execution was not completed successfully.

      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the pipeline execution.

      • Cancelled: The pipeline’s definition was updated before the pipeline execution could be completed.

      • InProgress: The pipeline execution is currently running.

      • Stopped: The pipeline execution was manually stopped. For more information, see Stopped Executions.

      • Stopping: The pipeline execution received a request to be manually stopped. Depending on the selected stop mode, the execution is either completing or abandoning in-progress actions. For more information, see Stopped Executions.

      • Succeeded: The pipeline execution was completed successfully.

      • Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution advanced and continued through the pipeline instead. For more information, see Superseded Executions.

      • Failed: The pipeline execution was not completed successfully.

      If the service returns an enum value that is not available in the current SDK version, status will return PipelineExecutionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The status of the pipeline execution.

      • Cancelled: The pipeline’s definition was updated before the pipeline execution could be completed.

      • InProgress: The pipeline execution is currently running.

      • Stopped: The pipeline execution was manually stopped. For more information, see Stopped Executions.

      • Stopping: The pipeline execution received a request to be manually stopped. Depending on the selected stop mode, the execution is either completing or abandoning in-progress actions. For more information, see Stopped Executions.

      • Succeeded: The pipeline execution was completed successfully.

      • Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution advanced and continued through the pipeline instead. For more information, see Superseded Executions.

      • Failed: The pipeline execution was not completed successfully.

      See Also:

    • statusSummary

      public final String statusSummary()

      A summary that contains a description of the pipeline execution status.

      Returns:
      A summary that contains a description of the pipeline execution status.

    • hasArtifactRevisions

      public final boolean hasArtifactRevisions()
      For responses, this returns true if the service returned a value for the ArtifactRevisions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • artifactRevisions

      public final List<ArtifactRevision> artifactRevisions()

      A list of ArtifactRevision objects included in a pipeline execution.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasArtifactRevisions() method.

      Returns:
      A list of ArtifactRevision objects included in a pipeline execution.

    • trigger

      public final ExecutionTrigger trigger()
      Returns the value of the Trigger property for this object.
      Returns:
      The value of the Trigger property for this object.

    • hasVariables

      public final boolean hasVariables()
      For responses, this returns true if the service returned a value for the Variables property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • variables

      public final List<ResolvedPipelineVariable> variables()

      A list of pipeline variables used for the pipeline execution.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasVariables() method.

      Returns:
      A list of pipeline variables used for the pipeline execution.

    • toBuilder

      public PipelineExecution.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<PipelineExecution.Builder,PipelineExecution>
      Returns:
      a builder for type T

    • builder

      public static PipelineExecution.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PipelineExecution.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.