Class ActionConfigurationProperty
- All Implemented Interfaces:
Serializable
,Cloneable
Represents information about an action configuration property.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
The description of the action configuration property that will be displayed to users.getKey()
Whether the configuration property is a key.getName()
The name of the action configuration property.Indicates that the proprety will be used in conjunction with PollForJobs.Whether the configuration property is a required value.Whether the configuration property is secret.getType()
The type of the configuration property.int
hashCode()
isKey()
Whether the configuration property is a key.Indicates that the proprety will be used in conjunction with PollForJobs.Whether the configuration property is a required value.isSecret()
Whether the configuration property is secret.void
setDescription
(String description) The description of the action configuration property that will be displayed to users.void
Whether the configuration property is a key.void
The name of the action configuration property.void
setQueryable
(Boolean queryable) Indicates that the proprety will be used in conjunction with PollForJobs.void
setRequired
(Boolean required) Whether the configuration property is a required value.void
Whether the configuration property is secret.void
The type of the configuration property.void
The type of the configuration property.toString()
Returns a string representation of this object; useful for testing and debugging.withDescription
(String description) The description of the action configuration property that will be displayed to users.Whether the configuration property is a key.The name of the action configuration property.withQueryable
(Boolean queryable) Indicates that the proprety will be used in conjunction with PollForJobs.withRequired
(Boolean required) Whether the configuration property is a required value.withSecret
(Boolean secret) Whether the configuration property is secret.The type of the configuration property.The type of the configuration property.
-
Constructor Details
-
ActionConfigurationProperty
public ActionConfigurationProperty()
-
-
Method Details
-
setName
The name of the action configuration property.
- Parameters:
name
- The name of the action configuration property.
-
getName
The name of the action configuration property.
- Returns:
- The name of the action configuration property.
-
withName
The name of the action configuration property.
- Parameters:
name
- The name of the action configuration property.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setRequired
Whether the configuration property is a required value.
- Parameters:
required
- Whether the configuration property is a required value.
-
getRequired
Whether the configuration property is a required value.
- Returns:
- Whether the configuration property is a required value.
-
withRequired
Whether the configuration property is a required value.
- Parameters:
required
- Whether the configuration property is a required value.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isRequired
Whether the configuration property is a required value.
- Returns:
- Whether the configuration property is a required value.
-
setKey
Whether the configuration property is a key.
- Parameters:
key
- Whether the configuration property is a key.
-
getKey
Whether the configuration property is a key.
- Returns:
- Whether the configuration property is a key.
-
withKey
Whether the configuration property is a key.
- Parameters:
key
- Whether the configuration property is a key.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isKey
Whether the configuration property is a key.
- Returns:
- Whether the configuration property is a key.
-
setSecret
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.
- Parameters:
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.
-
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.
- 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 will preserve the prior value of the secret.
-
withSecret
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- 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 will preserve the prior value of the secret.
-
setQueryable
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.
- Parameters:
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.
-
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.
- Returns:
- 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.
-
withQueryable
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Returns:
- 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.
-
setDescription
The description of the action configuration property that will be displayed to users.
- Parameters:
description
- The description of the action configuration property that will be displayed to users.
-
getDescription
The description of the action configuration property that will be displayed to users.
- Returns:
- The description of the action configuration property that will be displayed to users.
-
withDescription
The description of the action configuration property that will be displayed to users.
- Parameters:
description
- The description of the action configuration property that will be displayed to users.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setType
The type of the configuration property.
- Parameters:
type
- The type of the configuration property.- See Also:
-
getType
The type of the configuration property.
- Returns:
- The type of the configuration property.
- See Also:
-
withType
The type of the configuration property.
- Parameters:
type
- The type of the configuration property.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setType
The type of the configuration property.
- Parameters:
type
- The type of the configuration property.- See Also:
-
withType
The type of the configuration property.
- Parameters:
type
- The type of the configuration property.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-