#[non_exhaustive]pub struct DocumentDescriptionBuilder { /* private fields */ }
Expand description
A builder for DocumentDescription
.
Implementations§
Source§impl DocumentDescriptionBuilder
impl DocumentDescriptionBuilder
Sourcepub fn sha1(self, input: impl Into<String>) -> Self
pub fn sha1(self, input: impl Into<String>) -> Self
The SHA1 hash of the document, which you can use for verification.
Sourcepub fn set_sha1(self, input: Option<String>) -> Self
pub fn set_sha1(self, input: Option<String>) -> Self
The SHA1 hash of the document, which you can use for verification.
Sourcepub fn get_sha1(&self) -> &Option<String>
pub fn get_sha1(&self) -> &Option<String>
The SHA1 hash of the document, which you can use for verification.
Sourcepub fn hash(self, input: impl Into<String>) -> Self
pub fn hash(self, input: impl Into<String>) -> Self
The Sha256 or Sha1 hash created by the system when the document was created.
Sha1 hashes have been deprecated.
Sourcepub fn set_hash(self, input: Option<String>) -> Self
pub fn set_hash(self, input: Option<String>) -> Self
The Sha256 or Sha1 hash created by the system when the document was created.
Sha1 hashes have been deprecated.
Sourcepub fn get_hash(&self) -> &Option<String>
pub fn get_hash(&self) -> &Option<String>
The Sha256 or Sha1 hash created by the system when the document was created.
Sha1 hashes have been deprecated.
Sourcepub fn hash_type(self, input: DocumentHashType) -> Self
pub fn hash_type(self, input: DocumentHashType) -> Self
The hash type of the document. Valid values include Sha256
or Sha1
.
Sha1 hashes have been deprecated.
Sourcepub fn set_hash_type(self, input: Option<DocumentHashType>) -> Self
pub fn set_hash_type(self, input: Option<DocumentHashType>) -> Self
The hash type of the document. Valid values include Sha256
or Sha1
.
Sha1 hashes have been deprecated.
Sourcepub fn get_hash_type(&self) -> &Option<DocumentHashType>
pub fn get_hash_type(&self) -> &Option<DocumentHashType>
The hash type of the document. Valid values include Sha256
or Sha1
.
Sha1 hashes have been deprecated.
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 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.
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.
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.
Sourcepub fn owner(self, input: impl Into<String>) -> Self
pub fn owner(self, input: impl Into<String>) -> Self
The Amazon Web Services user that created the document.
Sourcepub fn set_owner(self, input: Option<String>) -> Self
pub fn set_owner(self, input: Option<String>) -> Self
The Amazon Web Services user that created the document.
Sourcepub fn get_owner(&self) -> &Option<String>
pub fn get_owner(&self) -> &Option<String>
The Amazon Web Services user that created the document.
Sourcepub fn created_date(self, input: DateTime) -> Self
pub fn created_date(self, input: DateTime) -> Self
The date when 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 when the document was created.
Sourcepub fn get_created_date(&self) -> &Option<DateTime>
pub fn get_created_date(&self) -> &Option<DateTime>
The date when the document was created.
Sourcepub fn status(self, input: DocumentStatus) -> Self
pub fn status(self, input: DocumentStatus) -> Self
The status of the SSM document.
Sourcepub fn set_status(self, input: Option<DocumentStatus>) -> Self
pub fn set_status(self, input: Option<DocumentStatus>) -> Self
The status of the SSM document.
Sourcepub fn get_status(&self) -> &Option<DocumentStatus>
pub fn get_status(&self) -> &Option<DocumentStatus>
The status of the SSM document.
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 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 description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
A description of the document.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
A description of the document.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
A description of the document.
Sourcepub fn parameters(self, input: DocumentParameter) -> Self
pub fn parameters(self, input: DocumentParameter) -> Self
Appends an item to parameters
.
To override the contents of this collection use set_parameters
.
A description of the parameters for a document.
Sourcepub fn set_parameters(self, input: Option<Vec<DocumentParameter>>) -> Self
pub fn set_parameters(self, input: Option<Vec<DocumentParameter>>) -> Self
A description of the parameters for a document.
Sourcepub fn get_parameters(&self) -> &Option<Vec<DocumentParameter>>
pub fn get_parameters(&self) -> &Option<Vec<DocumentParameter>>
A description of the parameters for a document.
Sourcepub fn platform_types(self, input: PlatformType) -> Self
pub fn platform_types(self, input: PlatformType) -> Self
Appends an item to platform_types
.
To override the contents of this collection use set_platform_types
.
The list of operating system (OS) platforms compatible with this SSM document.
Sourcepub fn set_platform_types(self, input: Option<Vec<PlatformType>>) -> Self
pub fn set_platform_types(self, input: Option<Vec<PlatformType>>) -> Self
The list of operating system (OS) platforms compatible with this SSM document.
Sourcepub fn get_platform_types(&self) -> &Option<Vec<PlatformType>>
pub fn get_platform_types(&self) -> &Option<Vec<PlatformType>>
The list of operating system (OS) platforms compatible with this SSM document.
Sourcepub fn document_type(self, input: DocumentType) -> Self
pub fn document_type(self, input: DocumentType) -> Self
The type of document.
Sourcepub fn set_document_type(self, input: Option<DocumentType>) -> Self
pub fn set_document_type(self, input: Option<DocumentType>) -> Self
The type of document.
Sourcepub fn get_document_type(&self) -> &Option<DocumentType>
pub fn get_document_type(&self) -> &Option<DocumentType>
The type of document.
Sourcepub fn schema_version(self, input: impl Into<String>) -> Self
pub fn schema_version(self, input: impl Into<String>) -> Self
The schema version.
Sourcepub fn set_schema_version(self, input: Option<String>) -> Self
pub fn set_schema_version(self, input: Option<String>) -> Self
The schema version.
Sourcepub fn get_schema_version(&self) -> &Option<String>
pub fn get_schema_version(&self) -> &Option<String>
The schema version.
Sourcepub fn latest_version(self, input: impl Into<String>) -> Self
pub fn latest_version(self, input: impl Into<String>) -> Self
The latest version of the document.
Sourcepub fn set_latest_version(self, input: Option<String>) -> Self
pub fn set_latest_version(self, input: Option<String>) -> Self
The latest version of the document.
Sourcepub fn get_latest_version(&self) -> &Option<String>
pub fn get_latest_version(&self) -> &Option<String>
The latest version of the document.
Sourcepub fn default_version(self, input: impl Into<String>) -> Self
pub fn default_version(self, input: impl Into<String>) -> Self
The default version.
Sourcepub fn set_default_version(self, input: Option<String>) -> Self
pub fn set_default_version(self, input: Option<String>) -> Self
The default version.
Sourcepub fn get_default_version(&self) -> &Option<String>
pub fn get_default_version(&self) -> &Option<String>
The default version.
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 target_type(self, input: impl Into<String>) -> Self
pub fn target_type(self, input: impl Into<String>) -> Self
The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance
. For a list of valid resource types, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.
Sourcepub fn set_target_type(self, input: Option<String>) -> Self
pub fn set_target_type(self, input: Option<String>) -> Self
The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance
. For a list of valid resource types, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.
Sourcepub fn get_target_type(&self) -> &Option<String>
pub fn get_target_type(&self) -> &Option<String>
The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance
. For a list of valid resource types, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.
Appends an item to tags
.
To override the contents of this collection use set_tags
.
The tags, or metadata, that have been applied to the document.
The tags, or metadata, that have been applied to the document.
The tags, or metadata, that have been applied to the document.
Sourcepub fn attachments_information(self, input: AttachmentInformation) -> Self
pub fn attachments_information(self, input: AttachmentInformation) -> Self
Appends an item to attachments_information
.
To override the contents of this collection use set_attachments_information
.
Details about the document attachments, including names, locations, sizes, and so on.
Sourcepub fn set_attachments_information(
self,
input: Option<Vec<AttachmentInformation>>,
) -> Self
pub fn set_attachments_information( self, input: Option<Vec<AttachmentInformation>>, ) -> Self
Details about the document attachments, including names, locations, sizes, and so on.
Sourcepub fn get_attachments_information(&self) -> &Option<Vec<AttachmentInformation>>
pub fn get_attachments_information(&self) -> &Option<Vec<AttachmentInformation>>
Details about the document attachments, including names, locations, sizes, and so on.
Sourcepub fn requires(self, input: DocumentRequires) -> Self
pub fn requires(self, input: DocumentRequires) -> Self
Appends an item to requires
.
To override the contents of this collection use set_requires
.
A list of SSM documents required by a document. For example, an ApplicationConfiguration
document requires an ApplicationConfigurationSchema
document.
Sourcepub fn set_requires(self, input: Option<Vec<DocumentRequires>>) -> Self
pub fn set_requires(self, input: Option<Vec<DocumentRequires>>) -> Self
A list of SSM documents required by a document. For example, an ApplicationConfiguration
document requires an ApplicationConfigurationSchema
document.
Sourcepub fn get_requires(&self) -> &Option<Vec<DocumentRequires>>
pub fn get_requires(&self) -> &Option<Vec<DocumentRequires>>
A list of SSM documents required by a document. For example, an ApplicationConfiguration
document requires an ApplicationConfigurationSchema
document.
The user in your organization who created the document.
The user in your organization who created the document.
The user in your organization who created the document.
Sourcepub fn review_information(self, input: ReviewInformation) -> Self
pub fn review_information(self, input: ReviewInformation) -> Self
Appends an item to review_information
.
To override the contents of this collection use set_review_information
.
Details about the review of a document.
Sourcepub fn set_review_information(
self,
input: Option<Vec<ReviewInformation>>,
) -> Self
pub fn set_review_information( self, input: Option<Vec<ReviewInformation>>, ) -> Self
Details about the review of a document.
Sourcepub fn get_review_information(&self) -> &Option<Vec<ReviewInformation>>
pub fn get_review_information(&self) -> &Option<Vec<ReviewInformation>>
Details about the review of a document.
Sourcepub fn approved_version(self, input: impl Into<String>) -> Self
pub fn approved_version(self, input: impl Into<String>) -> Self
The version of the document currently approved for use in the organization.
Sourcepub fn set_approved_version(self, input: Option<String>) -> Self
pub fn set_approved_version(self, input: Option<String>) -> Self
The version of the document currently approved for use in the organization.
Sourcepub fn get_approved_version(&self) -> &Option<String>
pub fn get_approved_version(&self) -> &Option<String>
The version of the document currently approved for use in the organization.
Sourcepub fn pending_review_version(self, input: impl Into<String>) -> Self
pub fn pending_review_version(self, input: impl Into<String>) -> Self
The version of the document that is currently under review.
Sourcepub fn set_pending_review_version(self, input: Option<String>) -> Self
pub fn set_pending_review_version(self, input: Option<String>) -> Self
The version of the document that is currently under review.
Sourcepub fn get_pending_review_version(&self) -> &Option<String>
pub fn get_pending_review_version(&self) -> &Option<String>
The version of the document that is currently under review.
Sourcepub fn review_status(self, input: ReviewStatus) -> Self
pub fn review_status(self, input: ReviewStatus) -> Self
The current status of the review.
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 review.
Sourcepub fn get_review_status(&self) -> &Option<ReviewStatus>
pub fn get_review_status(&self) -> &Option<ReviewStatus>
The current status of the review.
Sourcepub fn category(self, input: impl Into<String>) -> Self
pub fn category(self, input: impl Into<String>) -> Self
Appends an item to category
.
To override the contents of this collection use set_category
.
The classification of a document to help you identify and categorize its use.
Sourcepub fn set_category(self, input: Option<Vec<String>>) -> Self
pub fn set_category(self, input: Option<Vec<String>>) -> Self
The classification of a document to help you identify and categorize its use.
Sourcepub fn get_category(&self) -> &Option<Vec<String>>
pub fn get_category(&self) -> &Option<Vec<String>>
The classification of a document to help you identify and categorize its use.
Sourcepub fn category_enum(self, input: impl Into<String>) -> Self
pub fn category_enum(self, input: impl Into<String>) -> Self
Appends an item to category_enum
.
To override the contents of this collection use set_category_enum
.
The value that identifies a document's category.
Sourcepub fn set_category_enum(self, input: Option<Vec<String>>) -> Self
pub fn set_category_enum(self, input: Option<Vec<String>>) -> Self
The value that identifies a document's category.
Sourcepub fn get_category_enum(&self) -> &Option<Vec<String>>
pub fn get_category_enum(&self) -> &Option<Vec<String>>
The value that identifies a document's category.
Sourcepub fn build(self) -> DocumentDescription
pub fn build(self) -> DocumentDescription
Consumes the builder and constructs a DocumentDescription
.
Trait Implementations§
Source§impl Clone for DocumentDescriptionBuilder
impl Clone for DocumentDescriptionBuilder
Source§fn clone(&self) -> DocumentDescriptionBuilder
fn clone(&self) -> DocumentDescriptionBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for DocumentDescriptionBuilder
impl Debug for DocumentDescriptionBuilder
Source§impl Default for DocumentDescriptionBuilder
impl Default for DocumentDescriptionBuilder
Source§fn default() -> DocumentDescriptionBuilder
fn default() -> DocumentDescriptionBuilder
impl StructuralPartialEq for DocumentDescriptionBuilder
Auto Trait Implementations§
impl Freeze for DocumentDescriptionBuilder
impl RefUnwindSafe for DocumentDescriptionBuilder
impl Send for DocumentDescriptionBuilder
impl Sync for DocumentDescriptionBuilder
impl Unpin for DocumentDescriptionBuilder
impl UnwindSafe for DocumentDescriptionBuilder
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);