public class ActionConfigurationProperty
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
Represents information about an action configuration property.
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
description
The description of the action configuration property that will be
displayed to users.
|
private java.lang.Boolean |
key
Whether the configuration property is a key.
|
private java.lang.String |
name
The name of the action configuration property.
|
private java.lang.Boolean |
queryable
Indicates that the proprety will be used in conjunction with PollForJobs.
|
private java.lang.Boolean |
required
Whether the configuration property is a required value.
|
private java.lang.Boolean |
secret
Whether the configuration property is secret.
|
private java.lang.String |
type
The type of the configuration property.
|
Constructor and Description |
---|
ActionConfigurationProperty() |
Modifier and Type | Method and Description |
---|---|
ActionConfigurationProperty |
clone() |
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getDescription()
The description of the action configuration property that will be
displayed to users.
|
java.lang.Boolean |
getKey()
Whether the configuration property is a key.
|
java.lang.String |
getName()
The name of the action configuration property.
|
java.lang.Boolean |
getQueryable()
Indicates that the proprety will be used in conjunction with PollForJobs.
|
java.lang.Boolean |
getRequired()
Whether the configuration property is a required value.
|
java.lang.Boolean |
getSecret()
Whether the configuration property is secret.
|
java.lang.String |
getType()
The type of the configuration property.
|
int |
hashCode() |
java.lang.Boolean |
isKey()
Whether the configuration property is a key.
|
java.lang.Boolean |
isQueryable()
Indicates that the proprety will be used in conjunction with PollForJobs.
|
java.lang.Boolean |
isRequired()
Whether the configuration property is a required value.
|
java.lang.Boolean |
isSecret()
Whether the configuration property is secret.
|
void |
setDescription(java.lang.String description)
The description of the action configuration property that will be
displayed to users.
|
void |
setKey(java.lang.Boolean key)
Whether the configuration property is a key.
|
void |
setName(java.lang.String name)
The name of the action configuration property.
|
void |
setQueryable(java.lang.Boolean queryable)
Indicates that the proprety will be used in conjunction with PollForJobs.
|
void |
setRequired(java.lang.Boolean required)
Whether the configuration property is a required value.
|
void |
setSecret(java.lang.Boolean secret)
Whether the configuration property is secret.
|
void |
setType(ActionConfigurationPropertyType type)
The type of the configuration property.
|
void |
setType(java.lang.String type)
The type of the configuration property.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
ActionConfigurationProperty |
withDescription(java.lang.String description)
The description of the action configuration property that will be
displayed to users.
|
ActionConfigurationProperty |
withKey(java.lang.Boolean key)
Whether the configuration property is a key.
|
ActionConfigurationProperty |
withName(java.lang.String name)
The name of the action configuration property.
|
ActionConfigurationProperty |
withQueryable(java.lang.Boolean queryable)
Indicates that the proprety will be used in conjunction with PollForJobs.
|
ActionConfigurationProperty |
withRequired(java.lang.Boolean required)
Whether the configuration property is a required value.
|
ActionConfigurationProperty |
withSecret(java.lang.Boolean secret)
Whether the configuration property is secret.
|
ActionConfigurationProperty |
withType(ActionConfigurationPropertyType type)
The type of the configuration property.
|
ActionConfigurationProperty |
withType(java.lang.String type)
The type of the configuration property.
|
private java.lang.String name
The name of the action configuration property.
private java.lang.Boolean required
Whether the configuration property is a required value.
private java.lang.Boolean key
Whether the configuration property is a key.
private java.lang.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 will preserve the prior value of the secret.
private java.lang.Boolean queryable
Indicates that the proprety will be used in conjunction 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 additional restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.
private java.lang.String description
The description of the action configuration property that will be displayed to users.
private java.lang.String type
The type of the configuration property.
public void setName(java.lang.String name)
The name of the action configuration property.
name
- The name of the action configuration property.public java.lang.String getName()
The name of the action configuration property.
public ActionConfigurationProperty withName(java.lang.String name)
The name of the action configuration property.
name
- The name of the action configuration property.public void setRequired(java.lang.Boolean required)
Whether the configuration property is a required value.
required
- Whether the configuration property is a required value.public java.lang.Boolean getRequired()
Whether the configuration property is a required value.
public ActionConfigurationProperty withRequired(java.lang.Boolean required)
Whether the configuration property is a required value.
required
- Whether the configuration property is a required value.public java.lang.Boolean isRequired()
Whether the configuration property is a required value.
public void setKey(java.lang.Boolean key)
Whether the configuration property is a key.
key
- Whether the configuration property is a key.public java.lang.Boolean getKey()
Whether the configuration property is a key.
public ActionConfigurationProperty withKey(java.lang.Boolean key)
Whether the configuration property is a key.
key
- Whether the configuration property is a key.public java.lang.Boolean isKey()
Whether the configuration property is a key.
public void setSecret(java.lang.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 will preserve the prior 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 will preserve the prior value of the secret.
public java.lang.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 will preserve the prior value of the secret.
When updating a pipeline, passing * * * * * without changing any other values of the action will preserve the prior value of the secret.
public ActionConfigurationProperty withSecret(java.lang.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 will preserve the prior 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 will preserve the prior value of the secret.
public java.lang.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 will preserve the prior value of the secret.
When updating a pipeline, passing * * * * * without changing any other values of the action will preserve the prior value of the secret.
public void setQueryable(java.lang.Boolean queryable)
Indicates that the proprety will be used in conjunction 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 additional 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 proprety will be used in conjunction 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 additional restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.
public java.lang.Boolean getQueryable()
Indicates that the proprety will be used in conjunction 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 additional restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.
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 additional 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(java.lang.Boolean queryable)
Indicates that the proprety will be used in conjunction 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 additional 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 proprety will be used in conjunction 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 additional restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.
public java.lang.Boolean isQueryable()
Indicates that the proprety will be used in conjunction 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 additional restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.
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 additional 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(java.lang.String description)
The description of the action configuration property that will be displayed to users.
description
- The description of the action configuration property that will be
displayed to users.public java.lang.String getDescription()
The description of the action configuration property that will be displayed to users.
public ActionConfigurationProperty withDescription(java.lang.String description)
The description of the action configuration property that will be displayed to users.
description
- The description of the action configuration property that will be
displayed to users.public void setType(java.lang.String type)
The type of the configuration property.
type
- The type of the configuration property.ActionConfigurationPropertyType
public java.lang.String getType()
The type of the configuration property.
ActionConfigurationPropertyType
public ActionConfigurationProperty withType(java.lang.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 java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public ActionConfigurationProperty clone()
clone
in class java.lang.Object