ActionDeclaration (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.codepipeline.model.ActionDeclaration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ActionDeclaration
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Represents information about an action declaration.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ActionDeclaration()

Constructors
Constructor and Description
`ActionDeclaration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ActionDeclaration`	`addConfigurationEntry(String key, String value)` Add a single Configuration entry
`ActionDeclaration`	`clearConfigurationEntries()` Removes all the entries added into Configuration.
`ActionDeclaration`	`clone()`
`boolean`	`equals(Object obj)`
`ActionTypeId`	`getActionTypeId()` Specifies the action type and the provider of the action.
`Map<String,String>`	`getConfiguration()` The action's configuration.
`List<InputArtifact>`	`getInputArtifacts()` The name or ID of the artifact consumed by the action, such as a test or build artifact.
`String`	`getName()` The action declaration's name.
`String`	`getNamespace()` The variable namespace associated with the action.
`List<OutputArtifact>`	`getOutputArtifacts()` The name or ID of the result of the action declaration, such as a test or build artifact.
`String`	`getRegion()` The action declaration's Amazon Web Services Region, such as us-east-1.
`String`	`getRoleArn()` The ARN of the IAM service role that performs the declared action.
`Integer`	`getRunOrder()` The order in which actions are run.
`Integer`	`getTimeoutInMinutes()` A timeout duration in minutes that can be applied against the ActionType’s default timeout value specified in Quotas for CodePipeline .
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setActionTypeId(ActionTypeId actionTypeId)` Specifies the action type and the provider of the action.
`void`	`setConfiguration(Map<String,String> configuration)` The action's configuration.
`void`	`setInputArtifacts(Collection<InputArtifact> inputArtifacts)` The name or ID of the artifact consumed by the action, such as a test or build artifact.
`void`	`setName(String name)` The action declaration's name.
`void`	`setNamespace(String namespace)` The variable namespace associated with the action.
`void`	`setOutputArtifacts(Collection<OutputArtifact> outputArtifacts)` The name or ID of the result of the action declaration, such as a test or build artifact.
`void`	`setRegion(String region)` The action declaration's Amazon Web Services Region, such as us-east-1.
`void`	`setRoleArn(String roleArn)` The ARN of the IAM service role that performs the declared action.
`void`	`setRunOrder(Integer runOrder)` The order in which actions are run.
`void`	`setTimeoutInMinutes(Integer timeoutInMinutes)` A timeout duration in minutes that can be applied against the ActionType’s default timeout value specified in Quotas for CodePipeline .
`String`	`toString()` Returns a string representation of this object.
`ActionDeclaration`	`withActionTypeId(ActionTypeId actionTypeId)` Specifies the action type and the provider of the action.
`ActionDeclaration`	`withConfiguration(Map<String,String> configuration)` The action's configuration.
`ActionDeclaration`	`withInputArtifacts(Collection<InputArtifact> inputArtifacts)` The name or ID of the artifact consumed by the action, such as a test or build artifact.
`ActionDeclaration`	`withInputArtifacts(InputArtifact... inputArtifacts)` The name or ID of the artifact consumed by the action, such as a test or build artifact.
`ActionDeclaration`	`withName(String name)` The action declaration's name.
`ActionDeclaration`	`withNamespace(String namespace)` The variable namespace associated with the action.
`ActionDeclaration`	`withOutputArtifacts(Collection<OutputArtifact> outputArtifacts)` The name or ID of the result of the action declaration, such as a test or build artifact.
`ActionDeclaration`	`withOutputArtifacts(OutputArtifact... outputArtifacts)` The name or ID of the result of the action declaration, such as a test or build artifact.
`ActionDeclaration`	`withRegion(String region)` The action declaration's Amazon Web Services Region, such as us-east-1.
`ActionDeclaration`	`withRoleArn(String roleArn)` The ARN of the IAM service role that performs the declared action.
`ActionDeclaration`	`withRunOrder(Integer runOrder)` The order in which actions are run.
`ActionDeclaration`	`withTimeoutInMinutes(Integer timeoutInMinutes)` A timeout duration in minutes that can be applied against the ActionType’s default timeout value specified in Quotas for CodePipeline .

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ActionDeclaration
```
public ActionDeclaration()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The action declaration's name.
    
    Parameters:
    
    name - The action declaration's name.
  - getName
```
public String getName()
```
    The action declaration's name.
    
    Returns:
    
    The action declaration's name.
  - withName
```
public ActionDeclaration withName(String name)
```
    The action declaration's name.
    
    Parameters:
    
    name - The action declaration's name.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setActionTypeId
```
public void setActionTypeId(ActionTypeId actionTypeId)
```
    Specifies the action type and the provider of the action.
    
    Parameters:
    
    actionTypeId - Specifies the action type and the provider of the action.
  - getActionTypeId
```
public ActionTypeId getActionTypeId()
```
    Specifies the action type and the provider of the action.
    
    Returns:
    
    Specifies the action type and the provider of the action.
  - withActionTypeId
```
public ActionDeclaration withActionTypeId(ActionTypeId actionTypeId)
```
    Specifies the action type and the provider of the action.
    
    Parameters:
    
    actionTypeId - Specifies the action type and the provider of the action.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRunOrder
```
public void setRunOrder(Integer runOrder)
```
    The order in which actions are run.
    
    Parameters:
    
    runOrder - The order in which actions are run.
  - getRunOrder
```
public Integer getRunOrder()
```
    The order in which actions are run.
    
    Returns:
    
    The order in which actions are run.
  - withRunOrder
```
public ActionDeclaration withRunOrder(Integer runOrder)
```
    The order in which actions are run.
    
    Parameters:
    
    runOrder - The order in which actions are run.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getConfiguration
```
public Map<String,String> getConfiguration()
```
    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 },
    
    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 },
  - setConfiguration
```
public void setConfiguration(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 },
    
    Parameters:
    
    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 },
  - withConfiguration
```
public ActionDeclaration withConfiguration(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 },
    
    Parameters:
    
    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 },
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addConfigurationEntry
```
public ActionDeclaration addConfigurationEntry(String key,
                                               String value)
```
    Add a single Configuration entry
    
    See Also:
    
    withConfiguration(java.util.Map<java.lang.String, java.lang.String>)
  - clearConfigurationEntries
```
public ActionDeclaration clearConfigurationEntries()
```
    Removes all the entries added into Configuration.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getOutputArtifacts
```
public List<OutputArtifact> getOutputArtifacts()
```
    The name or ID of the result of the action declaration, such as a test or build artifact.
    
    Returns:
    
    The name or ID of the result of the action declaration, such as a test or build artifact.
  - setOutputArtifacts
```
public void setOutputArtifacts(Collection<OutputArtifact> outputArtifacts)
```
    The name or ID of the result of the action declaration, such as a test or build artifact.
    
    Parameters:
    
    outputArtifacts - The name or ID of the result of the action declaration, such as a test or build artifact.
  - withOutputArtifacts
```
public ActionDeclaration withOutputArtifacts(OutputArtifact... outputArtifacts)
```
    The name or ID of the result of the action declaration, such as a test or build artifact.
    
    NOTE: This method appends the values to the existing list (if any). Use setOutputArtifacts(java.util.Collection) or withOutputArtifacts(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    outputArtifacts - The name or ID of the result of the action declaration, such as a test or build artifact.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withOutputArtifacts
```
public ActionDeclaration withOutputArtifacts(Collection<OutputArtifact> outputArtifacts)
```
    The name or ID of the result of the action declaration, such as a test or build artifact.
    
    Parameters:
    
    outputArtifacts - The name or ID of the result of the action declaration, such as a test or build artifact.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getInputArtifacts
```
public List<InputArtifact> getInputArtifacts()
```
    The name or ID of the artifact consumed by the action, such as a test or build artifact.
    
    Returns:
    
    The name or ID of the artifact consumed by the action, such as a test or build artifact.
  - setInputArtifacts
```
public void setInputArtifacts(Collection<InputArtifact> inputArtifacts)
```
    The name or ID of the artifact consumed by the action, such as a test or build artifact.
    
    Parameters:
    
    inputArtifacts - The name or ID of the artifact consumed by the action, such as a test or build artifact.
  - withInputArtifacts
```
public ActionDeclaration withInputArtifacts(InputArtifact... inputArtifacts)
```
    The name or ID of the artifact consumed by the action, such as a test or build artifact.
    
    NOTE: This method appends the values to the existing list (if any). Use setInputArtifacts(java.util.Collection) or withInputArtifacts(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    inputArtifacts - The name or ID of the artifact consumed by the action, such as a test or build artifact.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withInputArtifacts
```
public ActionDeclaration withInputArtifacts(Collection<InputArtifact> inputArtifacts)
```
    The name or ID of the artifact consumed by the action, such as a test or build artifact.
    
    Parameters:
    
    inputArtifacts - The name or ID of the artifact consumed by the action, such as a test or build artifact.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRoleArn
```
public void setRoleArn(String roleArn)
```
    The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.
    
    Parameters:
    
    roleArn - The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.
  - getRoleArn
```
public String getRoleArn()
```
    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.
  - withRoleArn
```
public ActionDeclaration withRoleArn(String roleArn)
```
    The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.
    
    Parameters:
    
    roleArn - The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRegion
```
public void setRegion(String region)
```
    The action declaration's Amazon Web Services Region, such as us-east-1.
    
    Parameters:
    
    region - The action declaration's Amazon Web Services Region, such as us-east-1.
  - getRegion
```
public String getRegion()
```
    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.
  - withRegion
```
public ActionDeclaration withRegion(String region)
```
    The action declaration's Amazon Web Services Region, such as us-east-1.
    
    Parameters:
    
    region - The action declaration's Amazon Web Services Region, such as us-east-1.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNamespace
```
public void setNamespace(String namespace)
```
    The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.
    
    Parameters:
    
    namespace - The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.
  - getNamespace
```
public String getNamespace()
```
    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.
  - withNamespace
```
public ActionDeclaration withNamespace(String namespace)
```
    The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.
    
    Parameters:
    
    namespace - The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTimeoutInMinutes
```
public void setTimeoutInMinutes(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.
    
    Parameters:
    
    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.
  - getTimeoutInMinutes
```
public Integer getTimeoutInMinutes()
```
    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.
  - withTimeoutInMinutes
```
public ActionDeclaration withTimeoutInMinutes(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ActionDeclaration clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.771

Class ActionDeclaration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ActionDeclaration

Method Detail

setName

getName

withName

setActionTypeId

getActionTypeId

withActionTypeId

setRunOrder

getRunOrder

withRunOrder

getConfiguration

setConfiguration

withConfiguration

addConfigurationEntry

clearConfigurationEntries

getOutputArtifacts

setOutputArtifacts

withOutputArtifacts

withOutputArtifacts

getInputArtifacts

setInputArtifacts

withInputArtifacts

withInputArtifacts

setRoleArn

getRoleArn

withRoleArn

setRegion

getRegion

withRegion

setNamespace

getNamespace

withNamespace

setTimeoutInMinutes

getTimeoutInMinutes

withTimeoutInMinutes

toString

equals

hashCode

clone

marshall