#[non_exhaustive]pub struct DocumentVersionInfoBuilder { /* private fields */ }
Expand description
A builder for DocumentVersionInfo
.
Implementations§
Source§impl DocumentVersionInfoBuilder
impl DocumentVersionInfoBuilder
Sourcepub fn display_name(self, input: impl Into<String>) -> Self
pub fn display_name(self, input: impl Into<String>) -> Self
The friendly name of the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument
.
Sourcepub fn set_display_name(self, input: Option<String>) -> Self
pub fn set_display_name(self, input: Option<String>) -> Self
The friendly name of the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument
.
Sourcepub fn get_display_name(&self) -> &Option<String>
pub fn get_display_name(&self) -> &Option<String>
The friendly name of the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument
.
Sourcepub fn document_version(self, input: impl Into<String>) -> Self
pub fn document_version(self, input: impl Into<String>) -> Self
The document version.
Sourcepub fn set_document_version(self, input: Option<String>) -> Self
pub fn set_document_version(self, input: Option<String>) -> Self
The document version.
Sourcepub fn get_document_version(&self) -> &Option<String>
pub fn get_document_version(&self) -> &Option<String>
The document version.
Sourcepub fn version_name(self, input: impl Into<String>) -> Self
pub fn version_name(self, input: impl Into<String>) -> Self
The version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.
Sourcepub fn set_version_name(self, input: Option<String>) -> Self
pub fn set_version_name(self, input: Option<String>) -> Self
The version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.
Sourcepub fn get_version_name(&self) -> &Option<String>
pub fn get_version_name(&self) -> &Option<String>
The version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.
Sourcepub fn created_date(self, input: DateTime) -> Self
pub fn created_date(self, input: DateTime) -> Self
The date the document was created.
Sourcepub fn set_created_date(self, input: Option<DateTime>) -> Self
pub fn set_created_date(self, input: Option<DateTime>) -> Self
The date the document was created.
Sourcepub fn get_created_date(&self) -> &Option<DateTime>
pub fn get_created_date(&self) -> &Option<DateTime>
The date the document was created.
Sourcepub fn is_default_version(self, input: bool) -> Self
pub fn is_default_version(self, input: bool) -> Self
An identifier for the default version of the document.
Sourcepub fn set_is_default_version(self, input: Option<bool>) -> Self
pub fn set_is_default_version(self, input: Option<bool>) -> Self
An identifier for the default version of the document.
Sourcepub fn get_is_default_version(&self) -> &Option<bool>
pub fn get_is_default_version(&self) -> &Option<bool>
An identifier for the default version of the document.
Sourcepub fn document_format(self, input: DocumentFormat) -> Self
pub fn document_format(self, input: DocumentFormat) -> Self
The document format, either JSON or YAML.
Sourcepub fn set_document_format(self, input: Option<DocumentFormat>) -> Self
pub fn set_document_format(self, input: Option<DocumentFormat>) -> Self
The document format, either JSON or YAML.
Sourcepub fn get_document_format(&self) -> &Option<DocumentFormat>
pub fn get_document_format(&self) -> &Option<DocumentFormat>
The document format, either JSON or YAML.
Sourcepub fn status(self, input: DocumentStatus) -> Self
pub fn status(self, input: DocumentStatus) -> Self
The status of the SSM document, such as Creating
, Active
, Failed
, and Deleting
.
Sourcepub fn set_status(self, input: Option<DocumentStatus>) -> Self
pub fn set_status(self, input: Option<DocumentStatus>) -> Self
The status of the SSM document, such as Creating
, Active
, Failed
, and Deleting
.
Sourcepub fn get_status(&self) -> &Option<DocumentStatus>
pub fn get_status(&self) -> &Option<DocumentStatus>
The status of the SSM document, such as Creating
, Active
, Failed
, and Deleting
.
Sourcepub fn status_information(self, input: impl Into<String>) -> Self
pub fn status_information(self, input: impl Into<String>) -> Self
A message returned by Amazon Web Services Systems Manager that explains the Status
value. For example, a Failed
status might be explained by the StatusInformation
message, "The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct."
Sourcepub fn set_status_information(self, input: Option<String>) -> Self
pub fn set_status_information(self, input: Option<String>) -> Self
A message returned by Amazon Web Services Systems Manager that explains the Status
value. For example, a Failed
status might be explained by the StatusInformation
message, "The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct."
Sourcepub fn get_status_information(&self) -> &Option<String>
pub fn get_status_information(&self) -> &Option<String>
A message returned by Amazon Web Services Systems Manager that explains the Status
value. For example, a Failed
status might be explained by the StatusInformation
message, "The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct."
Sourcepub fn review_status(self, input: ReviewStatus) -> Self
pub fn review_status(self, input: ReviewStatus) -> Self
The current status of the approval review for the latest version of the document.
Sourcepub fn set_review_status(self, input: Option<ReviewStatus>) -> Self
pub fn set_review_status(self, input: Option<ReviewStatus>) -> Self
The current status of the approval review for the latest version of the document.
Sourcepub fn get_review_status(&self) -> &Option<ReviewStatus>
pub fn get_review_status(&self) -> &Option<ReviewStatus>
The current status of the approval review for the latest version of the document.
Sourcepub fn build(self) -> DocumentVersionInfo
pub fn build(self) -> DocumentVersionInfo
Consumes the builder and constructs a DocumentVersionInfo
.
Trait Implementations§
Source§impl Clone for DocumentVersionInfoBuilder
impl Clone for DocumentVersionInfoBuilder
Source§fn clone(&self) -> DocumentVersionInfoBuilder
fn clone(&self) -> DocumentVersionInfoBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for DocumentVersionInfoBuilder
impl Debug for DocumentVersionInfoBuilder
Source§impl Default for DocumentVersionInfoBuilder
impl Default for DocumentVersionInfoBuilder
Source§fn default() -> DocumentVersionInfoBuilder
fn default() -> DocumentVersionInfoBuilder
impl StructuralPartialEq for DocumentVersionInfoBuilder
Auto Trait Implementations§
impl Freeze for DocumentVersionInfoBuilder
impl RefUnwindSafe for DocumentVersionInfoBuilder
impl Send for DocumentVersionInfoBuilder
impl Sync for DocumentVersionInfoBuilder
impl Unpin for DocumentVersionInfoBuilder
impl UnwindSafe for DocumentVersionInfoBuilder
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);