Class ActionDeclaration

java.lang.Object
software.amazon.awssdk.services.codepipeline.model.ActionDeclaration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ActionDeclaration.Builder,ActionDeclaration>

@Generated("software.amazon.awssdk:codegen") public final class ActionDeclaration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ActionDeclaration.Builder,ActionDeclaration>

Represents information about an action declaration.

See Also:
  • Method Details

    • name

      public final String name()

      The action declaration's name.

      Returns:
      The action declaration's name.
    • actionTypeId

      public final ActionTypeId actionTypeId()

      Specifies the action type and the provider of the action.

      Returns:
      Specifies the action type and the provider of the action.
    • runOrder

      public final Integer runOrder()

      The order in which actions are run.

      Returns:
      The order in which actions are run.
    • hasConfiguration

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

      public final Map<String,String> configuration()

      The action's configuration. These are key-value pairs that specify input values for an action. For more information, see Action Structure Requirements in CodePipeline. For the list of configuration properties for the CloudFormation action type in CodePipeline, see Configuration Properties Reference in the CloudFormation User Guide. For template snippets with examples, see Using Parameter Override Functions with CodePipeline Pipelines in the CloudFormation User Guide.

      The values can be represented in either JSON or YAML format. For example, the JSON configuration item format is as follows:

      JSON:

      "Configuration" : { Key : Value },

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

      Returns:
      The action's configuration. These are key-value pairs that specify input values for an action. For more information, see Action Structure Requirements in CodePipeline. For the list of configuration properties for the CloudFormation action type in CodePipeline, see Configuration Properties Reference in the CloudFormation User Guide. For template snippets with examples, see Using Parameter Override Functions with CodePipeline Pipelines in the CloudFormation User Guide.

      The values can be represented in either JSON or YAML format. For example, the JSON configuration item format is as follows:

      JSON:

      "Configuration" : { Key : Value },

    • hasOutputArtifacts

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

      public final List<OutputArtifact> outputArtifacts()

      The name or ID of the result of the action declaration, such as a test or build artifact.

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

      Returns:
      The name or ID of the result of the action declaration, such as a test or build artifact.
    • hasInputArtifacts

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

      public final List<InputArtifact> inputArtifacts()

      The name or ID of the artifact consumed by the action, such as a test or build artifact.

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

      Returns:
      The name or ID of the artifact consumed by the action, such as a test or build artifact.
    • roleArn

      public final String roleArn()

      The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.

      Returns:
      The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.
    • region

      public final String region()

      The action declaration's Amazon Web Services Region, such as us-east-1.

      Returns:
      The action declaration's Amazon Web Services Region, such as us-east-1.
    • namespace

      public final String namespace()

      The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.

      Returns:
      The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.
    • timeoutInMinutes

      public final Integer timeoutInMinutes()

      A timeout duration in minutes that can be applied against the ActionType’s default timeout value specified in Quotas for CodePipeline . This attribute is available only to the manual approval ActionType.

      Returns:
      A timeout duration in minutes that can be applied against the ActionType’s default timeout value specified in Quotas for CodePipeline . This attribute is available only to the manual approval ActionType.
    • toBuilder

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

      public static ActionDeclaration.Builder builder()
    • serializableBuilderClass

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