#[non_exhaustive]pub struct ActionConfigurationProperty {
pub name: Option<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: Option<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
sourceimpl 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.
sourceimpl ActionConfigurationProperty
impl ActionConfigurationProperty
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture ActionConfigurationProperty
Trait Implementations
sourceimpl Clone for ActionConfigurationProperty
impl Clone for ActionConfigurationProperty
sourcefn clone(&self) -> ActionConfigurationProperty
fn clone(&self) -> ActionConfigurationProperty
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for ActionConfigurationProperty
impl Debug for ActionConfigurationProperty
sourceimpl PartialEq<ActionConfigurationProperty> for ActionConfigurationProperty
impl PartialEq<ActionConfigurationProperty> for ActionConfigurationProperty
sourcefn eq(&self, other: &ActionConfigurationProperty) -> bool
fn eq(&self, other: &ActionConfigurationProperty) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &ActionConfigurationProperty) -> bool
fn ne(&self, other: &ActionConfigurationProperty) -> bool
This method tests for !=
.
impl StructuralPartialEq for ActionConfigurationProperty
Auto Trait Implementations
impl RefUnwindSafe for ActionConfigurationProperty
impl Send for ActionConfigurationProperty
impl Sync for ActionConfigurationProperty
impl Unpin for ActionConfigurationProperty
impl UnwindSafe for ActionConfigurationProperty
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more