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

Class PipelineDeclaration

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

Represents the structure of actions and stages to be performed in the pipeline.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the pipeline.

      Returns:
      The name of the pipeline.

    • roleArn

      public final String roleArn()

      The Amazon Resource Name (ARN) for CodePipeline to use to either perform actions with no actionRoleArn, or to use to assume roles for actions with an actionRoleArn.

      Returns:
      The Amazon Resource Name (ARN) for CodePipeline to use to either perform actions with no actionRoleArn, or to use to assume roles for actions with an actionRoleArn.

    • artifactStore

      public final ArtifactStore artifactStore()

      Represents information about the S3 bucket where artifacts are stored for the pipeline.

      You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.

      Returns:
      Represents information about the S3 bucket where artifacts are stored for the pipeline.

      You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.

    • hasArtifactStores

      public final boolean hasArtifactStores()
      For responses, this returns true if the service returned a value for the ArtifactStores 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.

    • artifactStores

      public final Map<String,ArtifactStore> artifactStores()

      A mapping of artifactStore objects and their corresponding Amazon Web Services Regions. There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline.

      You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.

      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 hasArtifactStores() method.

      Returns:
      A mapping of artifactStore objects and their corresponding Amazon Web Services Regions. There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline.

      You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.

    • hasStages

      public final boolean hasStages()
      For responses, this returns true if the service returned a value for the Stages 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.

    • stages

      public final List<StageDeclaration> stages()

      The stage in which to perform the action.

      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 hasStages() method.

      Returns:
      The stage in which to perform the action.

    • version

      public final Integer version()

      The version number of the pipeline. A new pipeline always has a version number of 1. This number is incremented when a pipeline is updated.

      Returns:
      The version number of the pipeline. A new pipeline always has a version number of 1. This number is incremented when a pipeline is updated.

    • 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:

    • 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:

    • 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<PipelineVariableDeclaration> variables()

      A list that defines the pipeline variables for a pipeline resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9@\-_]+.

      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 that defines the pipeline variables for a pipeline resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9@\-_]+.

    • hasTriggers

      public final boolean hasTriggers()
      For responses, this returns true if the service returned a value for the Triggers 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.

    • triggers

      public final List<PipelineTriggerDeclaration> triggers()

      The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.

      When a trigger configuration is specified, default change detection for repository and branch commits is disabled.

      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 hasTriggers() method.

      Returns:
      The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.

      When a trigger configuration is specified, default change detection for repository and branch commits is disabled.

    • toBuilder

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

    • builder

      public static PipelineDeclaration.Builder builder()

    • serializableBuilderClass

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