RuleConfigurationProperty (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 RuleConfigurationProperty

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

Represents information about a rule configuration property.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

RuleConfigurationProperty ()

Constructors
Constructor and Description
`RuleConfigurationProperty ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`RuleConfigurationProperty`	`clone ()`
`boolean`	`equals (Object obj)`
`String`	`getDescription ()` The description of the action configuration property that is displayed to users.
`Boolean`	`getKey ()` Whether the configuration property is a key.
`String`	`getName ()` The name of the rule configuration property.
`Boolean`	`getQueryable ()` Indicates whether the property can be queried.
`Boolean`	`getRequired ()` Whether the configuration property is a required value.
`Boolean`	`getSecret ()` Whether the configuration property is secret.
`String`	`getType ()` The type of the configuration property.
`int`	`hashCode ()`
`Boolean`	`isKey ()` Whether the configuration property is a key.
`Boolean`	`isQueryable ()` Indicates whether the property can be queried.
`Boolean`	`isRequired ()` Whether the configuration property is a required value.
`Boolean`	`isSecret ()` Whether the configuration property is secret.
`void`	`marshall (ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDescription (String description)` The description of the action configuration property that is displayed to users.
`void`	`setKey (Boolean key)` Whether the configuration property is a key.
`void`	`setName (String name)` The name of the rule configuration property.
`void`	`setQueryable (Boolean queryable)` Indicates whether the property can be queried.
`void`	`setRequired (Boolean required)` Whether the configuration property is a required value.
`void`	`setSecret (Boolean secret)` Whether the configuration property is secret.
`void`	`setType (String type)` The type of the configuration property.
`String`	`toString ()` Returns a string representation of this object.
`RuleConfigurationProperty`	`withDescription (String description)` The description of the action configuration property that is displayed to users.
`RuleConfigurationProperty`	`withKey (Boolean key)` Whether the configuration property is a key.
`RuleConfigurationProperty`	`withName (String name)` The name of the rule configuration property.
`RuleConfigurationProperty`	`withQueryable (Boolean queryable)` Indicates whether the property can be queried.
`RuleConfigurationProperty`	`withRequired (Boolean required)` Whether the configuration property is a required value.
`RuleConfigurationProperty`	`withSecret (Boolean secret)` Whether the configuration property is secret.
`RuleConfigurationProperty`	`withType (RuleConfigurationPropertyType type)` The type of the configuration property.
`RuleConfigurationProperty`	`withType (String type)` The type of the configuration property.

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

- Constructor Detail
  - RuleConfigurationProperty
```
public RuleConfigurationProperty()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name of the rule configuration property.
    
    Parameters:
    
    name - The name of the rule configuration property.
  - getName
```
public String getName()
```
    The name of the rule configuration property.
    
    Returns:
    
    The name of the rule configuration property.
  - withName
```
public RuleConfigurationProperty withName(String name)
```
    The name of the rule configuration property.
    
    Parameters:
    
    name - The name of the rule configuration property.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRequired
```
public void setRequired(Boolean required)
```
    Whether the configuration property is a required value.
    
    Parameters:
    
    required - Whether the configuration property is a required value.
  - getRequired
```
public Boolean getRequired()
```
    Whether the configuration property is a required value.
    
    Returns:
    
    Whether the configuration property is a required value.
  - withRequired
```
public RuleConfigurationProperty withRequired(Boolean required)
```
    Whether the configuration property is a required value.
    
    Parameters:
    
    required - Whether the configuration property is a required value.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isRequired
```
public Boolean isRequired()
```
    Whether the configuration property is a required value.
    
    Returns:
    
    Whether the configuration property is a required value.
  - setKey
```
public void setKey(Boolean key)
```
    Whether the configuration property is a key.
    
    Parameters:
    
    key - Whether the configuration property is a key.
  - getKey
```
public Boolean getKey()
```
    Whether the configuration property is a key.
    
    Returns:
    
    Whether the configuration property is a key.
  - withKey
```
public RuleConfigurationProperty withKey(Boolean key)
```
    Whether the configuration property is a key.
    
    Parameters:
    
    key - Whether the configuration property is a key.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isKey
```
public Boolean isKey()
```
    Whether the configuration property is a key.
    
    Returns:
    
    Whether the configuration property is a key.
  - setSecret
```
public void setSecret(Boolean secret)
```
    Whether the configuration property is secret.
    
    When updating a pipeline, passing * * * * * without changing any other values of the action preserves the previous value of the secret.
    
    Parameters:
    
    secret - Whether the configuration property is secret.
    
    When updating a pipeline, passing * * * * * without changing any other values of the action preserves the previous value of the secret.
  - getSecret
```
public Boolean getSecret()
```
    Whether the configuration property is secret.
    
    When updating a pipeline, passing * * * * * without changing any other values of the action preserves the previous value of the secret.
    
    Returns:
    
    Whether the configuration property is secret.
    
    When updating a pipeline, passing * * * * * without changing any other values of the action preserves the previous value of the secret.
  - withSecret
```
public RuleConfigurationProperty withSecret(Boolean secret)
```
    Whether the configuration property is secret.
    
    When updating a pipeline, passing * * * * * without changing any other values of the action preserves the previous value of the secret.
    
    Parameters:
    
    secret - Whether the configuration property is secret.
    
    When updating a pipeline, passing * * * * * without changing any other values of the action preserves the previous value of the secret.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isSecret
```
public Boolean isSecret()
```
    Whether the configuration property is secret.
    
    When updating a pipeline, passing * * * * * without changing any other values of the action preserves the previous value of the secret.
    
    Returns:
    
    Whether the configuration property is secret.
    
    When updating a pipeline, passing * * * * * without changing any other values of the action preserves the previous value of the secret.
  - setQueryable
```
public void setQueryable(Boolean queryable)
```
    Indicates whether the property can be queried.
    
    If you create a pipeline with a condition and rule, and that rule contains a queryable property, the value for that configuration property is subject to other restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.
    
    Parameters:
    
    queryable - Indicates whether the property can be queried.
    
    If you create a pipeline with a condition and rule, and that rule contains a queryable property, the value for that configuration property is subject to other restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.
  - getQueryable
```
public Boolean getQueryable()
```
    Indicates whether the property can be queried.
    
    If you create a pipeline with a condition and rule, and that rule contains a queryable property, the value for that configuration property is subject to other restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.
    
    Returns:
    
    Indicates whether the property can be queried.
    
    If you create a pipeline with a condition and rule, and that rule contains a queryable property, the value for that configuration property is subject to other restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.
  - withQueryable
```
public RuleConfigurationProperty withQueryable(Boolean queryable)
```
    Indicates whether the property can be queried.
    
    If you create a pipeline with a condition and rule, and that rule contains a queryable property, the value for that configuration property is subject to other restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.
    
    Parameters:
    
    queryable - Indicates whether the property can be queried.
    
    If you create a pipeline with a condition and rule, and that rule contains a queryable property, the value for that configuration property is subject to other restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isQueryable
```
public Boolean isQueryable()
```
    Indicates whether the property can be queried.
    
    If you create a pipeline with a condition and rule, and that rule contains a queryable property, the value for that configuration property is subject to other restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.
    
    Returns:
    
    Indicates whether the property can be queried.
    
    If you create a pipeline with a condition and rule, and that rule contains a queryable property, the value for that configuration property is subject to other restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.
  - setDescription
```
public void setDescription(String description)
```
    The description of the action configuration property that is displayed to users.
    
    Parameters:
    
    description - The description of the action configuration property that is displayed to users.
  - getDescription
```
public String getDescription()
```
    The description of the action configuration property that is displayed to users.
    
    Returns:
    
    The description of the action configuration property that is displayed to users.
  - withDescription
```
public RuleConfigurationProperty withDescription(String description)
```
    The description of the action configuration property that is displayed to users.
    
    Parameters:
    
    description - The description of the action configuration property that is displayed to users.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setType
```
public void setType(String type)
```
    The type of the configuration property.
    
    Parameters:
    
    type - The type of the configuration property.
    
    See Also:
    
    RuleConfigurationPropertyType
  - getType
```
public String getType()
```
    The type of the configuration property.
    
    Returns:
    
    The type of the configuration property.
    
    See Also:
    
    RuleConfigurationPropertyType
  - withType
```
public RuleConfigurationProperty withType(String type)
```
    The type of the configuration property.
    
    Parameters:
    
    type - The type of the configuration property.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RuleConfigurationPropertyType
  - withType
```
public RuleConfigurationProperty withType(RuleConfigurationPropertyType type)
```
    The type of the configuration property.
    
    Parameters:
    
    type - The type of the configuration property.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RuleConfigurationPropertyType
  - 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 RuleConfigurationProperty 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 RuleConfigurationProperty

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RuleConfigurationProperty

Method Detail

setName

getName

withName

setRequired

getRequired

withRequired

isRequired

setKey

getKey

withKey

isKey

setSecret

getSecret

withSecret

isSecret

setQueryable

getQueryable

withQueryable

isQueryable

setDescription

getDescription

withDescription

setType

getType

withType

withType

toString

equals

hashCode

clone

marshall