@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.
Modifier and Type | Class and Description |
---|---|
static interface |
ActionConfigurationProperty.Builder |
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.
|
copy
public final String name()
The name of the action configuration property.
public final Boolean required()
Whether the configuration property is a required value.
public final Boolean key()
Whether the configuration property is a key.
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.
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.
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.
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.
public final String description()
The description of the action configuration property that is displayed to users.
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()
.
ActionConfigurationPropertyType
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()
.
ActionConfigurationPropertyType
public ActionConfigurationProperty.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<ActionConfigurationProperty.Builder,ActionConfigurationProperty>
public static ActionConfigurationProperty.Builder builder()
public static Class<? extends ActionConfigurationProperty.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
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.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.