@Generated(value="software.amazon.awssdk:codegen") public final class ActionDeclaration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ActionDeclaration.Builder,ActionDeclaration>
Represents information about an action declaration.
Modifier and Type | Class and Description |
---|---|
static interface |
ActionDeclaration.Builder |
Modifier and Type | Method and Description |
---|---|
ActionTypeId |
actionTypeId()
Specifies the action type and the provider of the action.
|
static ActionDeclaration.Builder |
builder() |
Map<String,String> |
configuration()
The action's configuration.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasConfiguration()
Returns true if the Configuration property was specified by the sender (it may be empty), or false if the sender
did not specify the value (it will be empty).
|
int |
hashCode() |
boolean |
hasInputArtifacts()
Returns true if the InputArtifacts property was specified by the sender (it may be empty), or false if the sender
did not specify the value (it will be empty).
|
boolean |
hasOutputArtifacts()
Returns true if the OutputArtifacts property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
List<InputArtifact> |
inputArtifacts()
The name or ID of the artifact consumed by the action, such as a test or build artifact.
|
String |
name()
The action declaration's name.
|
String |
namespace()
The variable namespace associated with the action.
|
List<OutputArtifact> |
outputArtifacts()
The name or ID of the result of the action declaration, such as a test or build artifact.
|
String |
region()
The action declaration's AWS Region, such as us-east-1.
|
String |
roleArn()
The ARN of the IAM service role that performs the declared action.
|
Integer |
runOrder()
The order in which actions are run.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends ActionDeclaration.Builder> |
serializableBuilderClass() |
ActionDeclaration.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
copy
public final String name()
The action declaration's name.
public final ActionTypeId actionTypeId()
Specifies the action type and the provider of the action.
public final Integer runOrder()
The order in which actions are run.
public final boolean hasConfiguration()
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 AWS CloudFormation action type in CodePipeline, see Configuration Properties Reference in the AWS CloudFormation User Guide. For template snippets with examples, see Using Parameter Override Functions with CodePipeline Pipelines in the AWS 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.
You can use hasConfiguration()
to see if a value was sent in this field.
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 },
public final boolean hasOutputArtifacts()
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.
You can use hasOutputArtifacts()
to see if a value was sent in this field.
public final boolean hasInputArtifacts()
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.
You can use hasInputArtifacts()
to see if a value was sent in this field.
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.
public final String region()
The action declaration's AWS Region, such as us-east-1.
public final String namespace()
The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.
public ActionDeclaration.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<ActionDeclaration.Builder,ActionDeclaration>
public static ActionDeclaration.Builder builder()
public static Class<? extends ActionDeclaration.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
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.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()