#[non_exhaustive]pub struct TypeSummaryBuilder { /* private fields */ }
Expand description
A builder for TypeSummary
.
Implementations§
Source§impl TypeSummaryBuilder
impl TypeSummaryBuilder
Sourcepub fn type(self, input: RegistryType) -> Self
pub fn type(self, input: RegistryType) -> Self
The kind of extension.
Sourcepub fn set_type(self, input: Option<RegistryType>) -> Self
pub fn set_type(self, input: Option<RegistryType>) -> Self
The kind of extension.
Sourcepub fn get_type(&self) -> &Option<RegistryType>
pub fn get_type(&self) -> &Option<RegistryType>
The kind of extension.
Sourcepub fn type_name(self, input: impl Into<String>) -> Self
pub fn type_name(self, input: impl Into<String>) -> Self
The name of the extension.
If you specified a TypeNameAlias
when you call the ActivateType API operation in your account and Region, CloudFormation considers that alias as the type name.
Sourcepub fn set_type_name(self, input: Option<String>) -> Self
pub fn set_type_name(self, input: Option<String>) -> Self
The name of the extension.
If you specified a TypeNameAlias
when you call the ActivateType API operation in your account and Region, CloudFormation considers that alias as the type name.
Sourcepub fn get_type_name(&self) -> &Option<String>
pub fn get_type_name(&self) -> &Option<String>
The name of the extension.
If you specified a TypeNameAlias
when you call the ActivateType API operation in your account and Region, CloudFormation considers that alias as the type name.
Sourcepub fn default_version_id(self, input: impl Into<String>) -> Self
pub fn default_version_id(self, input: impl Into<String>) -> Self
The ID of the default version of the extension. The default version is used when the extension version isn't specified.
This applies only to private extensions you have registered in your account. For public extensions, both those provided by Amazon and published by third parties, CloudFormation returns null
. For more information, see RegisterType.
To set the default version of an extension, use SetTypeDefaultVersion
.
Sourcepub fn set_default_version_id(self, input: Option<String>) -> Self
pub fn set_default_version_id(self, input: Option<String>) -> Self
The ID of the default version of the extension. The default version is used when the extension version isn't specified.
This applies only to private extensions you have registered in your account. For public extensions, both those provided by Amazon and published by third parties, CloudFormation returns null
. For more information, see RegisterType.
To set the default version of an extension, use SetTypeDefaultVersion
.
Sourcepub fn get_default_version_id(&self) -> &Option<String>
pub fn get_default_version_id(&self) -> &Option<String>
The ID of the default version of the extension. The default version is used when the extension version isn't specified.
This applies only to private extensions you have registered in your account. For public extensions, both those provided by Amazon and published by third parties, CloudFormation returns null
. For more information, see RegisterType.
To set the default version of an extension, use SetTypeDefaultVersion
.
Sourcepub fn type_arn(self, input: impl Into<String>) -> Self
pub fn type_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the extension.
Sourcepub fn set_type_arn(self, input: Option<String>) -> Self
pub fn set_type_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the extension.
Sourcepub fn get_type_arn(&self) -> &Option<String>
pub fn get_type_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the extension.
Sourcepub fn last_updated(self, input: DateTime) -> Self
pub fn last_updated(self, input: DateTime) -> Self
When the specified extension version was registered. This applies only to:
-
Private extensions you have registered in your account. For more information, see RegisterType.
-
Public extensions you have activated in your account with auto-update specified. For more information, see ActivateType.
For all other extension types, CloudFormation returns null
.
Sourcepub fn set_last_updated(self, input: Option<DateTime>) -> Self
pub fn set_last_updated(self, input: Option<DateTime>) -> Self
When the specified extension version was registered. This applies only to:
-
Private extensions you have registered in your account. For more information, see RegisterType.
-
Public extensions you have activated in your account with auto-update specified. For more information, see ActivateType.
For all other extension types, CloudFormation returns null
.
Sourcepub fn get_last_updated(&self) -> &Option<DateTime>
pub fn get_last_updated(&self) -> &Option<DateTime>
When the specified extension version was registered. This applies only to:
-
Private extensions you have registered in your account. For more information, see RegisterType.
-
Public extensions you have activated in your account with auto-update specified. For more information, see ActivateType.
For all other extension types, CloudFormation returns null
.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
The description of the extension.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
The description of the extension.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
The description of the extension.
Sourcepub fn publisher_id(self, input: impl Into<String>) -> Self
pub fn publisher_id(self, input: impl Into<String>) -> Self
The ID of the extension publisher, if the extension is published by a third party. Extensions published by Amazon don't return a publisher ID.
Sourcepub fn set_publisher_id(self, input: Option<String>) -> Self
pub fn set_publisher_id(self, input: Option<String>) -> Self
The ID of the extension publisher, if the extension is published by a third party. Extensions published by Amazon don't return a publisher ID.
Sourcepub fn get_publisher_id(&self) -> &Option<String>
pub fn get_publisher_id(&self) -> &Option<String>
The ID of the extension publisher, if the extension is published by a third party. Extensions published by Amazon don't return a publisher ID.
Sourcepub fn original_type_name(self, input: impl Into<String>) -> Self
pub fn original_type_name(self, input: impl Into<String>) -> Self
For public extensions that have been activated for this account and Region, the type name of the public extension.
If you specified a TypeNameAlias
when enabling the extension in this account and Region, CloudFormation treats that alias as the extension's type name within the account and Region, not the type name of the public extension. For more information, see Use aliases to refer to extensions in the CloudFormation User Guide.
Sourcepub fn set_original_type_name(self, input: Option<String>) -> Self
pub fn set_original_type_name(self, input: Option<String>) -> Self
For public extensions that have been activated for this account and Region, the type name of the public extension.
If you specified a TypeNameAlias
when enabling the extension in this account and Region, CloudFormation treats that alias as the extension's type name within the account and Region, not the type name of the public extension. For more information, see Use aliases to refer to extensions in the CloudFormation User Guide.
Sourcepub fn get_original_type_name(&self) -> &Option<String>
pub fn get_original_type_name(&self) -> &Option<String>
For public extensions that have been activated for this account and Region, the type name of the public extension.
If you specified a TypeNameAlias
when enabling the extension in this account and Region, CloudFormation treats that alias as the extension's type name within the account and Region, not the type name of the public extension. For more information, see Use aliases to refer to extensions in the CloudFormation User Guide.
Sourcepub fn public_version_number(self, input: impl Into<String>) -> Self
pub fn public_version_number(self, input: impl Into<String>) -> Self
For public extensions that have been activated for this account and Region, the version of the public extension to be used for CloudFormation operations in this account and Region.
How you specified AutoUpdate
when enabling the extension affects whether CloudFormation automatically updates the extension in this account and Region when a new version is released. For more information, see Automatically use new versions of extensions in the CloudFormation User Guide.
Sourcepub fn set_public_version_number(self, input: Option<String>) -> Self
pub fn set_public_version_number(self, input: Option<String>) -> Self
For public extensions that have been activated for this account and Region, the version of the public extension to be used for CloudFormation operations in this account and Region.
How you specified AutoUpdate
when enabling the extension affects whether CloudFormation automatically updates the extension in this account and Region when a new version is released. For more information, see Automatically use new versions of extensions in the CloudFormation User Guide.
Sourcepub fn get_public_version_number(&self) -> &Option<String>
pub fn get_public_version_number(&self) -> &Option<String>
For public extensions that have been activated for this account and Region, the version of the public extension to be used for CloudFormation operations in this account and Region.
How you specified AutoUpdate
when enabling the extension affects whether CloudFormation automatically updates the extension in this account and Region when a new version is released. For more information, see Automatically use new versions of extensions in the CloudFormation User Guide.
Sourcepub fn latest_public_version(self, input: impl Into<String>) -> Self
pub fn latest_public_version(self, input: impl Into<String>) -> Self
For public extensions that have been activated for this account and Region, the latest version of the public extension that is available. For any extensions other than activated third-party extensions, CloudFormation returns null
.
How you specified AutoUpdate
when enabling the extension affects whether CloudFormation automatically updates the extension in this account and Region when a new version is released. For more information, see Automatically use new versions of extensions in the CloudFormation User Guide.
Sourcepub fn set_latest_public_version(self, input: Option<String>) -> Self
pub fn set_latest_public_version(self, input: Option<String>) -> Self
For public extensions that have been activated for this account and Region, the latest version of the public extension that is available. For any extensions other than activated third-party extensions, CloudFormation returns null
.
How you specified AutoUpdate
when enabling the extension affects whether CloudFormation automatically updates the extension in this account and Region when a new version is released. For more information, see Automatically use new versions of extensions in the CloudFormation User Guide.
Sourcepub fn get_latest_public_version(&self) -> &Option<String>
pub fn get_latest_public_version(&self) -> &Option<String>
For public extensions that have been activated for this account and Region, the latest version of the public extension that is available. For any extensions other than activated third-party extensions, CloudFormation returns null
.
How you specified AutoUpdate
when enabling the extension affects whether CloudFormation automatically updates the extension in this account and Region when a new version is released. For more information, see Automatically use new versions of extensions in the CloudFormation User Guide.
Sourcepub fn publisher_identity(self, input: IdentityProvider) -> Self
pub fn publisher_identity(self, input: IdentityProvider) -> Self
The service used to verify the publisher identity.
For more information, see Publishing extensions to make them available for public use in the CloudFormation Command Line Interface (CLI) User Guide.
Sourcepub fn set_publisher_identity(self, input: Option<IdentityProvider>) -> Self
pub fn set_publisher_identity(self, input: Option<IdentityProvider>) -> Self
The service used to verify the publisher identity.
For more information, see Publishing extensions to make them available for public use in the CloudFormation Command Line Interface (CLI) User Guide.
Sourcepub fn get_publisher_identity(&self) -> &Option<IdentityProvider>
pub fn get_publisher_identity(&self) -> &Option<IdentityProvider>
The service used to verify the publisher identity.
For more information, see Publishing extensions to make them available for public use in the CloudFormation Command Line Interface (CLI) User Guide.
Sourcepub fn publisher_name(self, input: impl Into<String>) -> Self
pub fn publisher_name(self, input: impl Into<String>) -> Self
The publisher name, as defined in the public profile for that publisher in the service used to verify the publisher identity.
Sourcepub fn set_publisher_name(self, input: Option<String>) -> Self
pub fn set_publisher_name(self, input: Option<String>) -> Self
The publisher name, as defined in the public profile for that publisher in the service used to verify the publisher identity.
Sourcepub fn get_publisher_name(&self) -> &Option<String>
pub fn get_publisher_name(&self) -> &Option<String>
The publisher name, as defined in the public profile for that publisher in the service used to verify the publisher identity.
Sourcepub fn is_activated(self, input: bool) -> Self
pub fn is_activated(self, input: bool) -> Self
Whether the extension is activated for this account and Region.
This applies only to third-party public extensions. Extensions published by Amazon are activated by default.
Sourcepub fn set_is_activated(self, input: Option<bool>) -> Self
pub fn set_is_activated(self, input: Option<bool>) -> Self
Whether the extension is activated for this account and Region.
This applies only to third-party public extensions. Extensions published by Amazon are activated by default.
Sourcepub fn get_is_activated(&self) -> &Option<bool>
pub fn get_is_activated(&self) -> &Option<bool>
Whether the extension is activated for this account and Region.
This applies only to third-party public extensions. Extensions published by Amazon are activated by default.
Sourcepub fn build(self) -> TypeSummary
pub fn build(self) -> TypeSummary
Consumes the builder and constructs a TypeSummary
.
Trait Implementations§
Source§impl Clone for TypeSummaryBuilder
impl Clone for TypeSummaryBuilder
Source§fn clone(&self) -> TypeSummaryBuilder
fn clone(&self) -> TypeSummaryBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for TypeSummaryBuilder
impl Debug for TypeSummaryBuilder
Source§impl Default for TypeSummaryBuilder
impl Default for TypeSummaryBuilder
Source§fn default() -> TypeSummaryBuilder
fn default() -> TypeSummaryBuilder
Source§impl PartialEq for TypeSummaryBuilder
impl PartialEq for TypeSummaryBuilder
impl StructuralPartialEq for TypeSummaryBuilder
Auto Trait Implementations§
impl Freeze for TypeSummaryBuilder
impl RefUnwindSafe for TypeSummaryBuilder
impl Send for TypeSummaryBuilder
impl Sync for TypeSummaryBuilder
impl Unpin for TypeSummaryBuilder
impl UnwindSafe for TypeSummaryBuilder
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> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
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 moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);