software.amazon.awssdk.services.codepipeline.model

Class ActionConfigurationProperty

java.lang.Object

software.amazon.awssdk.services.codepipeline.model.ActionConfigurationProperty

All Implemented Interfaces:

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

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

Represents information about an action configuration property.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ActionConfigurationProperty.Builder

Method Summary

Modifier and Type	Method and Description
static ActionConfigurationProperty.Builder	builder()
String	description() The description of the action configuration property that is displayed to users.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<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 action configuration property.
Boolean	queryable() Indicates that the property is used with PollForJobs.
Boolean	required() Whether the configuration property is a required value.
List<SdkField<?>>	sdkFields()
Boolean	secret() Whether the configuration property is secret.
static Class<? extends ActionConfigurationProperty.Builder>	serializableBuilderClass()
ActionConfigurationProperty.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.
ActionConfigurationPropertyType	type() The type of the configuration property.
String	typeAsString() The type of the configuration property.

Methods inherited from class java.lang.Object

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 action configuration property.

Returns:

The name of the action 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. Secrets are hidden from all calls except for GetJobDetails, GetThirdPartyJobDetails, PollForJobs, and PollForThirdPartyJobs.

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. Secrets are hidden from all calls except for GetJobDetails, GetThirdPartyJobDetails, PollForJobs, and PollForThirdPartyJobs.

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 that the property is used with PollForJobs. When creating a custom action, an action can have up to one queryable property. If it has one, that property must be both required and not secret.

If you create a pipeline with a custom action type, and that custom action 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 that the property is used with PollForJobs. When creating a custom action, an action can have up to one queryable property. If it has one, that property must be both required and not secret.

If you create a pipeline with a custom action type, and that custom action 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 ActionConfigurationPropertyType 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 ActionConfigurationPropertyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of the configuration property.

See Also:

ActionConfigurationPropertyType

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 ActionConfigurationPropertyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of the configuration property.

See Also:

ActionConfigurationPropertyType

toBuilder

public ActionConfigurationProperty.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ActionConfigurationProperty.Builder,ActionConfigurationProperty>

Returns:

a builder for type T

builder

public static ActionConfigurationProperty.Builder builder()

serializableBuilderClass

public static Class<? extends ActionConfigurationProperty.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)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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

Returns:

List of SdkField in this POJO. May be empty list but should never be null.