Class PipelineSummary

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

Returns a summary of a pipeline.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the pipeline.

      Returns:
      The name of the pipeline.

    • version

      public final Integer version()

      The version number of the pipeline.

      Returns:
      The version number of the pipeline.

    • pipelineType

      public final PipelineType pipelineType()

      CodePipeline provides the following pipeline types, which differ in characteristics and price, so that you can tailor your pipeline features and cost to the needs of your applications.

      • V1 type pipelines have a JSON structure that contains standard pipeline, stage, and action-level parameters.

      • V2 type pipelines have the same structure as a V1 type, along with additional parameters for release safety and trigger configuration.

      Including V2 parameters, such as triggers on Git tags, in the pipeline JSON when creating or updating a pipeline will result in the pipeline having the V2 type of pipeline and the associated costs.

      For information about pricing for CodePipeline, see Pricing.

      For information about which type of pipeline to choose, see What type of pipeline is right for me?.

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

      Returns:
      CodePipeline provides the following pipeline types, which differ in characteristics and price, so that you can tailor your pipeline features and cost to the needs of your applications.

      • V1 type pipelines have a JSON structure that contains standard pipeline, stage, and action-level parameters.

      • V2 type pipelines have the same structure as a V1 type, along with additional parameters for release safety and trigger configuration.

      Including V2 parameters, such as triggers on Git tags, in the pipeline JSON when creating or updating a pipeline will result in the pipeline having the V2 type of pipeline and the associated costs.

      For information about pricing for CodePipeline, see Pricing.

      For information about which type of pipeline to choose, see What type of pipeline is right for me?.

      See Also:

    • pipelineTypeAsString

      public final String pipelineTypeAsString()

      CodePipeline provides the following pipeline types, which differ in characteristics and price, so that you can tailor your pipeline features and cost to the needs of your applications.

      • V1 type pipelines have a JSON structure that contains standard pipeline, stage, and action-level parameters.

      • V2 type pipelines have the same structure as a V1 type, along with additional parameters for release safety and trigger configuration.

      Including V2 parameters, such as triggers on Git tags, in the pipeline JSON when creating or updating a pipeline will result in the pipeline having the V2 type of pipeline and the associated costs.

      For information about pricing for CodePipeline, see Pricing.

      For information about which type of pipeline to choose, see What type of pipeline is right for me?.

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

      Returns:
      CodePipeline provides the following pipeline types, which differ in characteristics and price, so that you can tailor your pipeline features and cost to the needs of your applications.

      • V1 type pipelines have a JSON structure that contains standard pipeline, stage, and action-level parameters.

      • V2 type pipelines have the same structure as a V1 type, along with additional parameters for release safety and trigger configuration.

      Including V2 parameters, such as triggers on Git tags, in the pipeline JSON when creating or updating a pipeline will result in the pipeline having the V2 type of pipeline and the associated costs.

      For information about pricing for CodePipeline, see Pricing.

      For information about which type of pipeline to choose, see What type of pipeline is right for me?.

      See Also:

    • executionMode

      public final ExecutionMode executionMode()

      The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.

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

      Returns:
      The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.
      See Also:

    • executionModeAsString

      public final String executionModeAsString()

      The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.

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

      Returns:
      The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.
      See Also:

    • created

      public final Instant created()

      The date and time the pipeline was created, in timestamp format.

      Returns:
      The date and time the pipeline was created, in timestamp format.

    • updated

      public final Instant updated()

      The date and time of the last update to the pipeline, in timestamp format.

      Returns:
      The date and time of the last update to the pipeline, in timestamp format.

    • toBuilder

      public PipelineSummary.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<PipelineSummary.Builder,PipelineSummary>
      Returns:
      a builder for type T

    • builder

      public static PipelineSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PipelineSummary.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.