Class ActionDeclaration
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ActionDeclaration.Builder,
ActionDeclaration>
Represents information about an action declaration.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal ActionTypeId
Specifies the action type and the provider of the action.static ActionDeclaration.Builder
builder()
The action's configuration.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the Configuration property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the InputArtifacts property.final boolean
For responses, this returns true if the service returned a value for the OutputArtifacts property.final List
<InputArtifact> The name or ID of the artifact consumed by the action, such as a test or build artifact.final String
name()
The action declaration's name.final String
The variable namespace associated with the action.final List
<OutputArtifact> The name or ID of the result of the action declaration, such as a test or build artifact.final String
region()
The action declaration's Amazon Web Services Region, such as us-east-1.final String
roleArn()
The ARN of the IAM service role that performs the declared action.final Integer
runOrder()
The order in which actions are run.static Class
<? extends ActionDeclaration.Builder> final Integer
A timeout duration in minutes that can be applied against the ActionType’s default timeout value specified in Quotas for CodePipeline .Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The action declaration's name.
- Returns:
- The action declaration's name.
-
actionTypeId
Specifies the action type and the provider of the action.
- Returns:
- Specifies the action type and the provider of the action.
-
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 theisEmpty()
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
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 theisEmpty()
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
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 theisEmpty()
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
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
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
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
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
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
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 interfaceToCopyableBuilder<ActionDeclaration.Builder,
ActionDeclaration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-