Struct ActionConfigurationProperty

#[non_exhaustive]
pub struct ActionConfigurationProperty {
    pub name: String,
    pub required: bool,
    pub key: bool,
    pub secret: bool,
    pub queryable: bool,
    pub description: Option<String>,
    pub type: Option<ActionConfigurationPropertyType>,
}

Represents information about an action configuration property.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

The name of the action configuration property.

required: bool

Whether the configuration property is a required value.

key: bool

Whether the configuration property is a key.

secret: bool

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.

queryable: bool

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.

description: Option<String>

The description of the action configuration property that is displayed to users.

type: Option<ActionConfigurationPropertyType>

The type of the configuration property.

Implementations

impl ActionConfigurationProperty

pub fn name(&self) -> &str

The name of the action configuration property.

pub fn required(&self) -> bool

Whether the configuration property is a required value.

pub fn key(&self) -> bool

Whether the configuration property is a key.

pub fn secret(&self) -> bool

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.

pub fn queryable(&self) -> bool

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.

pub fn description(&self) -> Option<&str>

The description of the action configuration property that is displayed to users.

pub fn type(&self) -> Option<&ActionConfigurationPropertyType>

The type of the configuration property.

impl ActionConfigurationProperty

pub fn builder() -> ActionConfigurationPropertyBuilder

Creates a new builder-style object to manufacture ActionConfigurationProperty.

Trait Implementations

impl Clone for ActionConfigurationProperty

fn clone(&self) -> ActionConfigurationProperty

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ActionConfigurationProperty

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ActionConfigurationProperty

fn eq(&self, other: &ActionConfigurationProperty) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ActionConfigurationProperty