Class ActionConfigurationProperty
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ActionConfigurationProperty.Builder,
ActionConfigurationProperty>
Represents information about an action configuration property.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
The description of the action configuration property that is displayed to users.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final Boolean
key()
Whether the configuration property is a key.final String
name()
The name of the action configuration property.final Boolean
Indicates that the property is used withPollForJobs
.final Boolean
required()
Whether the configuration property is a required value.final Boolean
secret()
Whether the configuration property is secret.static Class
<? extends ActionConfigurationProperty.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.type()
The type of the configuration property.final String
The type of the configuration property.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of the action configuration property.
- Returns:
- The name of the action configuration property.
-
required
Whether the configuration property is a required value.
- Returns:
- Whether the configuration property is a required value.
-
key
Whether the configuration property is a key.
- Returns:
- Whether the configuration property is a key.
-
secret
Whether the configuration property is secret. Secrets are hidden from all calls except for
GetJobDetails
,GetThirdPartyJobDetails
,PollForJobs
, andPollForThirdPartyJobs
.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
, andPollForThirdPartyJobs
.When updating a pipeline, passing * * * * * without changing any other values of the action preserves the previous value of the secret.
-
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
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
The type of the configuration property.
If the service returns an enum value that is not available in the current SDK version,
type
will returnActionConfigurationPropertyType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of the configuration property.
- See Also:
-
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 returnActionConfigurationPropertyType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of the configuration property.
- See Also:
-
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 interfaceToCopyableBuilder<ActionConfigurationProperty.Builder,
ActionConfigurationProperty> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-