com.amazonaws.services.codepipeline.model

Class RuleExecutionInput

java.lang.Object

com.amazonaws.services.codepipeline.model.RuleExecutionInput

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RuleExecutionInput
extends Object
implements Serializable, Cloneable, StructuredPojo

Input information used for a rule execution.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
RuleExecutionInput()

Method Summary

Modifier and Type	Method and Description
RuleExecutionInput	addConfigurationEntry(String key, String value) Add a single Configuration entry
RuleExecutionInput	addResolvedConfigurationEntry(String key, String value) Add a single ResolvedConfiguration entry
RuleExecutionInput	clearConfigurationEntries() Removes all the entries added into Configuration.
RuleExecutionInput	clearResolvedConfigurationEntries() Removes all the entries added into ResolvedConfiguration.
RuleExecutionInput	clone()
boolean	equals(Object obj)
Map<String,String>	getConfiguration() Configuration data for a rule execution, such as the resolved values for that run.
List<ArtifactDetail>	getInputArtifacts() Details of input artifacts of the rule that correspond to the rule execution.
String	getRegion() The Amazon Web Services Region for the rule, such as us-east-1.
Map<String,String>	getResolvedConfiguration() Configuration data for a rule execution with all variable references replaced with their real values for the execution.
String	getRoleArn() The ARN of the IAM service role that performs the declared rule.
RuleTypeId	getRuleTypeId() The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setConfiguration(Map<String,String> configuration) Configuration data for a rule execution, such as the resolved values for that run.
void	setInputArtifacts(Collection<ArtifactDetail> inputArtifacts) Details of input artifacts of the rule that correspond to the rule execution.
void	setRegion(String region) The Amazon Web Services Region for the rule, such as us-east-1.
void	setResolvedConfiguration(Map<String,String> resolvedConfiguration) Configuration data for a rule execution with all variable references replaced with their real values for the execution.
void	setRoleArn(String roleArn) The ARN of the IAM service role that performs the declared rule.
void	setRuleTypeId(RuleTypeId ruleTypeId) The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.
String	toString() Returns a string representation of this object.
RuleExecutionInput	withConfiguration(Map<String,String> configuration) Configuration data for a rule execution, such as the resolved values for that run.
RuleExecutionInput	withInputArtifacts(ArtifactDetail... inputArtifacts) Details of input artifacts of the rule that correspond to the rule execution.
RuleExecutionInput	withInputArtifacts(Collection<ArtifactDetail> inputArtifacts) Details of input artifacts of the rule that correspond to the rule execution.
RuleExecutionInput	withRegion(String region) The Amazon Web Services Region for the rule, such as us-east-1.
RuleExecutionInput	withResolvedConfiguration(Map<String,String> resolvedConfiguration) Configuration data for a rule execution with all variable references replaced with their real values for the execution.
RuleExecutionInput	withRoleArn(String roleArn) The ARN of the IAM service role that performs the declared rule.
RuleExecutionInput	withRuleTypeId(RuleTypeId ruleTypeId) The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RuleExecutionInput

public RuleExecutionInput()

Method Detail

setRuleTypeId

public void setRuleTypeId(RuleTypeId ruleTypeId)

The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.

Parameters:

ruleTypeId - The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.

getRuleTypeId

public RuleTypeId getRuleTypeId()

The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.

Returns:

The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.

withRuleTypeId

public RuleExecutionInput withRuleTypeId(RuleTypeId ruleTypeId)

The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.

Parameters:

ruleTypeId - The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.

Returns:

Returns a reference to this object so that method calls can be chained together.

getConfiguration

public Map<String,String> getConfiguration()

Configuration data for a rule execution, such as the resolved values for that run.

Returns:

Configuration data for a rule execution, such as the resolved values for that run.

setConfiguration

public void setConfiguration(Map<String,String> configuration)

Configuration data for a rule execution, such as the resolved values for that run.

Parameters:

configuration - Configuration data for a rule execution, such as the resolved values for that run.

withConfiguration

public RuleExecutionInput withConfiguration(Map<String,String> configuration)

Configuration data for a rule execution, such as the resolved values for that run.

Parameters:

configuration - Configuration data for a rule execution, such as the resolved values for that run.

Returns:

Returns a reference to this object so that method calls can be chained together.

addConfigurationEntry

public RuleExecutionInput addConfigurationEntry(String key,
                                                String value)

Add a single Configuration entry

See Also:

withConfiguration(java.util.Map<java.lang.String, java.lang.String>)

clearConfigurationEntries

public RuleExecutionInput clearConfigurationEntries()

Removes all the entries added into Configuration.

Returns:

Returns a reference to this object so that method calls can be chained together.

getResolvedConfiguration

public Map<String,String> getResolvedConfiguration()

Configuration data for a rule execution with all variable references replaced with their real values for the execution.

Returns:

Configuration data for a rule execution with all variable references replaced with their real values for the execution.

setResolvedConfiguration

public void setResolvedConfiguration(Map<String,String> resolvedConfiguration)

Configuration data for a rule execution with all variable references replaced with their real values for the execution.

Parameters:

resolvedConfiguration - Configuration data for a rule execution with all variable references replaced with their real values for the execution.

withResolvedConfiguration

public RuleExecutionInput withResolvedConfiguration(Map<String,String> resolvedConfiguration)

Configuration data for a rule execution with all variable references replaced with their real values for the execution.

Parameters:

resolvedConfiguration - Configuration data for a rule execution with all variable references replaced with their real values for the execution.

Returns:

Returns a reference to this object so that method calls can be chained together.

addResolvedConfigurationEntry

public RuleExecutionInput addResolvedConfigurationEntry(String key,
                                                        String value)

Add a single ResolvedConfiguration entry

See Also:

withResolvedConfiguration(java.util.Map<java.lang.String, java.lang.String>)

clearResolvedConfigurationEntries

public RuleExecutionInput clearResolvedConfigurationEntries()

Removes all the entries added into ResolvedConfiguration.

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 rule. This is assumed through the roleArn for the pipeline.

Parameters:

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

getRoleArn

public String getRoleArn()

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

Returns:

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

withRoleArn

public RuleExecutionInput withRoleArn(String roleArn)

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

Parameters:

roleArn - The ARN of the IAM service role that performs the declared rule. 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 Amazon Web Services Region for the rule, such as us-east-1.

Parameters:

region - The Amazon Web Services Region for the rule, such as us-east-1.

getRegion

public String getRegion()

The Amazon Web Services Region for the rule, such as us-east-1.

Returns:

The Amazon Web Services Region for the rule, such as us-east-1.

withRegion

public RuleExecutionInput withRegion(String region)

The Amazon Web Services Region for the rule, such as us-east-1.

Parameters:

region - The Amazon Web Services Region for the rule, such as us-east-1.

Returns:

Returns a reference to this object so that method calls can be chained together.

getInputArtifacts

public List<ArtifactDetail> getInputArtifacts()

Details of input artifacts of the rule that correspond to the rule execution.

Returns:

Details of input artifacts of the rule that correspond to the rule execution.

setInputArtifacts

public void setInputArtifacts(Collection<ArtifactDetail> inputArtifacts)

Details of input artifacts of the rule that correspond to the rule execution.

Parameters:

inputArtifacts - Details of input artifacts of the rule that correspond to the rule execution.

withInputArtifacts

public RuleExecutionInput withInputArtifacts(ArtifactDetail... inputArtifacts)

Details of input artifacts of the rule that correspond to the rule execution.

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 - Details of input artifacts of the rule that correspond to the rule execution.

Returns:

Returns a reference to this object so that method calls can be chained together.

withInputArtifacts

public RuleExecutionInput withInputArtifacts(Collection<ArtifactDetail> inputArtifacts)

Details of input artifacts of the rule that correspond to the rule execution.

Parameters:

inputArtifacts - Details of input artifacts of the rule that correspond to the rule execution.

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 RuleExecutionInput clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo