RuleDeclaration (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.codepipeline.model

Class RuleDeclaration

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RuleDeclaration
extends Object
implements Serializable, Cloneable, StructuredPojo 
```
Represents information about the rule to be created for an associated condition. An example would be creating a new rule for an entry condition, such as a rule that checks for a test result before allowing the run to enter the deployment stage.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

RuleDeclaration ()

Constructors
Constructor and Description
`RuleDeclaration ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`RuleDeclaration`	`addConfigurationEntry (String key, String value)` Add a single Configuration entry
`RuleDeclaration`	`clearConfigurationEntries ()` Removes all the entries added into Configuration.
`RuleDeclaration`	`clone ()`
`boolean`	`equals (Object obj)`
`Map<String,String>`	`getConfiguration ()` The action configuration fields for the rule.
`List<InputArtifact>`	`getInputArtifacts ()` The input artifacts fields for the rule, such as specifying an input file for the rule.
`String`	`getName ()` The name of the rule that is created for the condition, such as CheckAllResults.
`String`	`getRegion ()` The Region for the condition associated with the rule.
`String`	`getRoleArn ()` The pipeline role ARN associated with the rule.
`RuleTypeId`	`getRuleTypeId ()` The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.
`Integer`	`getTimeoutInMinutes ()` The action timeout for the rule.
`int`	`hashCode ()`
`void`	`marshall (ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setConfiguration (Map<String,String> configuration)` The action configuration fields for the rule.
`void`	`setInputArtifacts (Collection<InputArtifact> inputArtifacts)` The input artifacts fields for the rule, such as specifying an input file for the rule.
`void`	`setName (String name)` The name of the rule that is created for the condition, such as CheckAllResults.
`void`	`setRegion (String region)` The Region for the condition associated with the rule.
`void`	`setRoleArn (String roleArn)` The pipeline role ARN associated with the 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.
`void`	`setTimeoutInMinutes (Integer timeoutInMinutes)` The action timeout for the rule.
`String`	`toString ()` Returns a string representation of this object.
`RuleDeclaration`	`withConfiguration (Map<String,String> configuration)` The action configuration fields for the rule.
`RuleDeclaration`	`withInputArtifacts (Collection<InputArtifact> inputArtifacts)` The input artifacts fields for the rule, such as specifying an input file for the rule.
`RuleDeclaration`	`withInputArtifacts (InputArtifact... inputArtifacts)` The input artifacts fields for the rule, such as specifying an input file for the rule.
`RuleDeclaration`	`withName (String name)` The name of the rule that is created for the condition, such as CheckAllResults.
`RuleDeclaration`	`withRegion (String region)` The Region for the condition associated with the rule.
`RuleDeclaration`	`withRoleArn (String roleArn)` The pipeline role ARN associated with the rule.
`RuleDeclaration`	`withRuleTypeId (RuleTypeId ruleTypeId)` The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.
`RuleDeclaration`	`withTimeoutInMinutes (Integer timeoutInMinutes)` The action timeout for the rule.

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

- Constructor Detail
  - RuleDeclaration
```
public RuleDeclaration()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name of the rule that is created for the condition, such as CheckAllResults.
    
    Parameters:
    
    name - The name of the rule that is created for the condition, such as CheckAllResults.
  - getName
```
public String getName()
```
    The name of the rule that is created for the condition, such as CheckAllResults.
    
    Returns:
    
    The name of the rule that is created for the condition, such as CheckAllResults.
  - withName
```
public RuleDeclaration withName(String name)
```
    The name of the rule that is created for the condition, such as CheckAllResults.
    
    Parameters:
    
    name - The name of the rule that is created for the condition, such as CheckAllResults.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 RuleDeclaration 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()
```
    The action configuration fields for the rule.
    
    Returns:
    
    The action configuration fields for the rule.
  - setConfiguration
```
public void setConfiguration(Map<String,String> configuration)
```
    The action configuration fields for the rule.
    
    Parameters:
    
    configuration - The action configuration fields for the rule.
  - withConfiguration
```
public RuleDeclaration withConfiguration(Map<String,String> configuration)
```
    The action configuration fields for the rule.
    
    Parameters:
    
    configuration - The action configuration fields for the rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addConfigurationEntry
```
public RuleDeclaration addConfigurationEntry(String key,
 String value)
```
    Add a single Configuration entry
    
    See Also:
    
    withConfiguration(java.util.Map<java.lang.String, java.lang.String>)
  - clearConfigurationEntries
```
public RuleDeclaration clearConfigurationEntries()
```
    Removes all the entries added into Configuration.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getInputArtifacts
```
public List<InputArtifact> getInputArtifacts()
```
    The input artifacts fields for the rule, such as specifying an input file for the rule.
    
    Returns:
    
    The input artifacts fields for the rule, such as specifying an input file for the rule.
  - setInputArtifacts
```
public void setInputArtifacts(Collection<InputArtifact> inputArtifacts)
```
    The input artifacts fields for the rule, such as specifying an input file for the rule.
    
    Parameters:
    
    inputArtifacts - The input artifacts fields for the rule, such as specifying an input file for the rule.
  - withInputArtifacts
```
public RuleDeclaration withInputArtifacts(InputArtifact... inputArtifacts)
```
    The input artifacts fields for the rule, such as specifying an input file for the rule.
    
    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 input artifacts fields for the rule, such as specifying an input file for the rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withInputArtifacts
```
public RuleDeclaration withInputArtifacts(Collection<InputArtifact> inputArtifacts)
```
    The input artifacts fields for the rule, such as specifying an input file for the rule.
    
    Parameters:
    
    inputArtifacts - The input artifacts fields for the rule, such as specifying an input file for the rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRoleArn
```
public void setRoleArn(String roleArn)
```
    The pipeline role ARN associated with the rule.
    
    Parameters:
    
    roleArn - The pipeline role ARN associated with the rule.
  - getRoleArn
```
public String getRoleArn()
```
    The pipeline role ARN associated with the rule.
    
    Returns:
    
    The pipeline role ARN associated with the rule.
  - withRoleArn
```
public RuleDeclaration withRoleArn(String roleArn)
```
    The pipeline role ARN associated with the rule.
    
    Parameters:
    
    roleArn - The pipeline role ARN associated with the rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRegion
```
public void setRegion(String region)
```
    The Region for the condition associated with the rule.
    
    Parameters:
    
    region - The Region for the condition associated with the rule.
  - getRegion
```
public String getRegion()
```
    The Region for the condition associated with the rule.
    
    Returns:
    
    The Region for the condition associated with the rule.
  - withRegion
```
public RuleDeclaration withRegion(String region)
```
    The Region for the condition associated with the rule.
    
    Parameters:
    
    region - The Region for the condition associated with the rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTimeoutInMinutes
```
public void setTimeoutInMinutes(Integer timeoutInMinutes)
```
    The action timeout for the rule.
    
    Parameters:
    
    timeoutInMinutes - The action timeout for the rule.
  - getTimeoutInMinutes
```
public Integer getTimeoutInMinutes()
```
    The action timeout for the rule.
    
    Returns:
    
    The action timeout for the rule.
  - withTimeoutInMinutes
```
public RuleDeclaration withTimeoutInMinutes(Integer timeoutInMinutes)
```
    The action timeout for the rule.
    
    Parameters:
    
    timeoutInMinutes - The action timeout for the rule.
    
    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 RuleDeclaration 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.

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Class RuleDeclaration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RuleDeclaration

Method Detail

setName

getName

withName

setRuleTypeId

getRuleTypeId

withRuleTypeId

getConfiguration

setConfiguration

withConfiguration

addConfigurationEntry

clearConfigurationEntries

getInputArtifacts

setInputArtifacts

withInputArtifacts

withInputArtifacts

setRoleArn

getRoleArn

withRoleArn

setRegion

getRegion

withRegion

setTimeoutInMinutes

getTimeoutInMinutes

withTimeoutInMinutes

toString

equals

hashCode

clone

marshall