Package software.amazon.awssdk.services.codepipeline.model

Class RuleConfigurationProperty

java.lang.Object

software.amazon.awssdk.services.codepipeline.model.RuleConfigurationProperty

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<RuleConfigurationProperty.Builder,RuleConfigurationProperty>

@Generated("software.amazon.awssdk:codegen")
public final class RuleConfigurationProperty
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<RuleConfigurationProperty.Builder,RuleConfigurationProperty>

Represents information about a rule configuration property.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RuleConfigurationProperty.Builder

Method Summary

Modifier and Type	Method	Description
static RuleConfigurationProperty.Builder	builder()
String	description()	The description of the action configuration property that is displayed to users.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	key()	Whether the configuration property is a key.
String	name()	The name of the rule configuration property.
Boolean	queryable()	Indicates whether the property can be queried.
Boolean	required()	Whether the configuration property is a required value.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
Boolean	secret()	Whether the configuration property is secret.
static Class<? extends RuleConfigurationProperty.Builder>	serializableBuilderClass()
RuleConfigurationProperty.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
RuleConfigurationPropertyType	type()	The type of the configuration property.
String	typeAsString()	The type of the configuration property.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

name

public final String name()

The name of the rule configuration property.

Returns:

The name of the rule configuration property.

required

public final Boolean required()

Whether the configuration property is a required value.

Returns:

Whether the configuration property is a required value.

key

public final Boolean key()

Whether the configuration property is a key.

Returns:

Whether the configuration property is a key.

secret

public final 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.

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.

queryable

public final 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.

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.

description

public final String description()

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.

type

public final RuleConfigurationPropertyType type()

The type of the configuration property.

If the service returns an enum value that is not available in the current SDK version, type will return RuleConfigurationPropertyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of the configuration property.

See Also:

RuleConfigurationPropertyType

typeAsString

public final String typeAsString()

The type of the configuration property.

If the service returns an enum value that is not available in the current SDK version, type will return RuleConfigurationPropertyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of the configuration property.

See Also:

RuleConfigurationPropertyType

toBuilder

public RuleConfigurationProperty.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RuleConfigurationProperty.Builder,RuleConfigurationProperty>

builder

public static RuleConfigurationProperty.Builder builder()

serializableBuilderClass

public static Class<? extends RuleConfigurationProperty.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo