@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ActionConfigurationProperty extends Object implements Serializable, Cloneable, StructuredPojo
Represents information about an action configuration property.
Constructor and Description |
---|
ActionConfigurationProperty() |
Modifier and Type | Method and Description |
---|---|
ActionConfigurationProperty |
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 action configuration property.
|
Boolean |
getQueryable()
Indicates that the property is used with
PollForJobs . |
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 that the property is used with
PollForJobs . |
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 action configuration property.
|
void |
setQueryable(Boolean queryable)
Indicates that the property is used with
PollForJobs . |
void |
setRequired(Boolean required)
Whether the configuration property is a required value.
|
void |
setSecret(Boolean secret)
Whether the configuration property is secret.
|
void |
setType(ActionConfigurationPropertyType type)
The type of the configuration property.
|
void |
setType(String type)
The type of the configuration property.
|
String |
toString()
Returns a string representation of this object.
|
ActionConfigurationProperty |
withDescription(String description)
The description of the action configuration property that is displayed to users.
|
ActionConfigurationProperty |
withKey(Boolean key)
Whether the configuration property is a key.
|
ActionConfigurationProperty |
withName(String name)
The name of the action configuration property.
|
ActionConfigurationProperty |
withQueryable(Boolean queryable)
Indicates that the property is used with
PollForJobs . |
ActionConfigurationProperty |
withRequired(Boolean required)
Whether the configuration property is a required value.
|
ActionConfigurationProperty |
withSecret(Boolean secret)
Whether the configuration property is secret.
|
ActionConfigurationProperty |
withType(ActionConfigurationPropertyType type)
The type of the configuration property.
|
ActionConfigurationProperty |
withType(String type)
The type of the configuration property.
|
public void setName(String name)
The name of the action configuration property.
name
- The name of the action configuration property.public String getName()
The name of the action configuration property.
public ActionConfigurationProperty withName(String name)
The name of the action configuration property.
name
- The name of the action configuration property.public void setRequired(Boolean required)
Whether the configuration property is a required value.
required
- Whether the configuration property is a required value.public Boolean getRequired()
Whether the configuration property is a required value.
public ActionConfigurationProperty withRequired(Boolean required)
Whether the configuration property is a required value.
required
- Whether the configuration property is a required value.public Boolean isRequired()
Whether the configuration property is a required value.
public void setKey(Boolean key)
Whether the configuration property is a key.
key
- Whether the configuration property is a key.public Boolean getKey()
Whether the configuration property is a key.
public ActionConfigurationProperty withKey(Boolean key)
Whether the configuration property is a key.
key
- Whether the configuration property is a key.public Boolean isKey()
Whether the configuration property is a key.
public void setSecret(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.
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.
public Boolean getSecret()
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 ActionConfigurationProperty withSecret(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.
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.
public Boolean isSecret()
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 void setQueryable(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.
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.
public Boolean getQueryable()
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 ActionConfigurationProperty withQueryable(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.
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.
public Boolean isQueryable()
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 void setDescription(String description)
The description of the action configuration property that is displayed to users.
description
- The description of the action configuration property that is displayed to users.public String getDescription()
The description of the action configuration property that is displayed to users.
public ActionConfigurationProperty withDescription(String description)
The description of the action configuration property that is displayed to users.
description
- The description of the action configuration property that is displayed to users.public void setType(String type)
The type of the configuration property.
type
- The type of the configuration property.ActionConfigurationPropertyType
public String getType()
The type of the configuration property.
ActionConfigurationPropertyType
public ActionConfigurationProperty withType(String type)
The type of the configuration property.
type
- The type of the configuration property.ActionConfigurationPropertyType
public void setType(ActionConfigurationPropertyType type)
The type of the configuration property.
type
- The type of the configuration property.ActionConfigurationPropertyType
public ActionConfigurationProperty withType(ActionConfigurationPropertyType type)
The type of the configuration property.
type
- The type of the configuration property.ActionConfigurationPropertyType
public String toString()
toString
in class Object
Object.toString()
public ActionConfigurationProperty clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.