Class ActionConfigurationProperty

    • Constructor Detail

      • ActionConfigurationProperty

        public ActionConfigurationProperty()
    • Method Detail

      • setName

        public void setName​(String name)

        The name of the action configuration property.

        Parameters:
        name - The name of the action configuration property.
      • getName

        public String getName()

        The name of the action configuration property.

        Returns:
        The name of the action configuration property.
      • withName

        public ActionConfigurationProperty withName​(String name)

        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

        public void setRequired​(Boolean required)

        Whether the configuration property is a required value.

        Parameters:
        required - Whether the configuration property is a required value.
      • getRequired

        public Boolean getRequired()

        Whether the configuration property is a required value.

        Returns:
        Whether the configuration property is a required value.
      • withRequired

        public ActionConfigurationProperty withRequired​(Boolean required)

        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

        public Boolean isRequired()

        Whether the configuration property is a required value.

        Returns:
        Whether the configuration property is a required value.
      • setKey

        public void setKey​(Boolean key)

        Whether the configuration property is a key.

        Parameters:
        key - Whether the configuration property is a key.
      • getKey

        public Boolean getKey()

        Whether the configuration property is a key.

        Returns:
        Whether the configuration property is a key.
      • withKey

        public ActionConfigurationProperty withKey​(Boolean key)

        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

        public Boolean isKey()

        Whether the configuration property is a key.

        Returns:
        Whether the configuration property is a key.
      • setSecret

        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 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

        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 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

        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 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

        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 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

        public void setQueryable​(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.

        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

        public 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.

        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

        public ActionConfigurationProperty withQueryable​(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.

        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

        public 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.

        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

        public void setDescription​(String description)

        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

        public String 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

        public ActionConfigurationProperty withDescription​(String description)

        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

        public void setType​(String type)

        The type of the configuration property.

        Parameters:
        type - The type of the configuration property.
        See Also:
        ActionConfigurationPropertyType
      • toString

        public String toString()
        Returns a string representation of this object; useful for testing and debugging.
        Overrides:
        toString in class Object
        Returns:
        A string representation of this object.
        See Also:
        Object.toString()
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object