#[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>,
}
Expand description
Represents information about an action configuration property.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
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§
source§impl ActionConfigurationProperty
impl ActionConfigurationProperty
sourcepub fn secret(&self) -> bool
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.
sourcepub fn queryable(&self) -> bool
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.
sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
The description of the action configuration property that is displayed to users.
sourcepub fn type(&self) -> Option<&ActionConfigurationPropertyType>
pub fn type(&self) -> Option<&ActionConfigurationPropertyType>
The type of the configuration property.
source§impl ActionConfigurationProperty
impl ActionConfigurationProperty
sourcepub fn builder() -> ActionConfigurationPropertyBuilder
pub fn builder() -> ActionConfigurationPropertyBuilder
Creates a new builder-style object to manufacture ActionConfigurationProperty
.
Trait Implementations§
source§impl Clone for ActionConfigurationProperty
impl Clone for ActionConfigurationProperty
source§fn clone(&self) -> ActionConfigurationProperty
fn clone(&self) -> ActionConfigurationProperty
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ActionConfigurationProperty
impl Debug for ActionConfigurationProperty
source§impl PartialEq for ActionConfigurationProperty
impl PartialEq for ActionConfigurationProperty
source§fn eq(&self, other: &ActionConfigurationProperty) -> bool
fn eq(&self, other: &ActionConfigurationProperty) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for ActionConfigurationProperty
Auto Trait Implementations§
impl Freeze for ActionConfigurationProperty
impl RefUnwindSafe for ActionConfigurationProperty
impl Send for ActionConfigurationProperty
impl Sync for ActionConfigurationProperty
impl Unpin for ActionConfigurationProperty
impl UnwindSafe for ActionConfigurationProperty
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more