#[non_exhaustive]pub struct StartCacheReportInput {
pub file_share_arn: Option<String>,
pub role: Option<String>,
pub location_arn: Option<String>,
pub bucket_region: Option<String>,
pub vpc_endpoint_dns_name: Option<String>,
pub inclusion_filters: Option<Vec<CacheReportFilter>>,
pub exclusion_filters: Option<Vec<CacheReportFilter>>,
pub client_token: Option<String>,
pub tags: Option<Vec<Tag>>,
}
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.The Amazon Resource Name (ARN) of the file share.
role: Option<String>
The ARN of the IAM role used when saving the cache report to Amazon S3.
location_arn: Option<String>
The ARN of the Amazon S3 bucket where you want to save the cache report.
We do not recommend saving the cache report to the same Amazon S3 bucket for which you are generating the report.
This field does not accept access point ARNs.
bucket_region: Option<String>
The Amazon Web Services Region of the Amazon S3 bucket where you want to save the cache report.
vpc_endpoint_dns_name: Option<String>
The DNS name of the VPC endpoint associated with the Amazon S3 where you want to save the cache report. Optional.
inclusion_filters: Option<Vec<CacheReportFilter>>
The list of filters and parameters that determine which files are included in the report. You must specify at least one value for InclusionFilters
or ExclusionFilters
in a StartCacheReport
request.
exclusion_filters: Option<Vec<CacheReportFilter>>
The list of filters and parameters that determine which files are excluded from the report. You must specify at least one value for InclusionFilters
or ExclusionFilters
in a StartCacheReport
request.
client_token: Option<String>
A unique identifier that you use to ensure idempotent report generation if you need to retry an unsuccessful StartCacheReport
request. If you retry a request, use the same ClientToken
you specified in the initial request.
A list of up to 50 key/value tags that you can assign to the cache report. Using tags can help you categorize your reports and more easily locate them in search results.
Implementations§
Source§impl StartCacheReportInput
impl StartCacheReportInput
The Amazon Resource Name (ARN) of the file share.
Sourcepub fn role(&self) -> Option<&str>
pub fn role(&self) -> Option<&str>
The ARN of the IAM role used when saving the cache report to Amazon S3.
Sourcepub fn location_arn(&self) -> Option<&str>
pub fn location_arn(&self) -> Option<&str>
The ARN of the Amazon S3 bucket where you want to save the cache report.
We do not recommend saving the cache report to the same Amazon S3 bucket for which you are generating the report.
This field does not accept access point ARNs.
Sourcepub fn bucket_region(&self) -> Option<&str>
pub fn bucket_region(&self) -> Option<&str>
The Amazon Web Services Region of the Amazon S3 bucket where you want to save the cache report.
Sourcepub fn vpc_endpoint_dns_name(&self) -> Option<&str>
pub fn vpc_endpoint_dns_name(&self) -> Option<&str>
The DNS name of the VPC endpoint associated with the Amazon S3 where you want to save the cache report. Optional.
Sourcepub fn inclusion_filters(&self) -> &[CacheReportFilter]
pub fn inclusion_filters(&self) -> &[CacheReportFilter]
The list of filters and parameters that determine which files are included in the report. You must specify at least one value for InclusionFilters
or ExclusionFilters
in a StartCacheReport
request.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .inclusion_filters.is_none()
.
Sourcepub fn exclusion_filters(&self) -> &[CacheReportFilter]
pub fn exclusion_filters(&self) -> &[CacheReportFilter]
The list of filters and parameters that determine which files are excluded from the report. You must specify at least one value for InclusionFilters
or ExclusionFilters
in a StartCacheReport
request.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .exclusion_filters.is_none()
.
Sourcepub fn client_token(&self) -> Option<&str>
pub fn client_token(&self) -> Option<&str>
A unique identifier that you use to ensure idempotent report generation if you need to retry an unsuccessful StartCacheReport
request. If you retry a request, use the same ClientToken
you specified in the initial request.
A list of up to 50 key/value tags that you can assign to the cache report. Using tags can help you categorize your reports and more easily locate them in search results.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none()
.
Source§impl StartCacheReportInput
impl StartCacheReportInput
Sourcepub fn builder() -> StartCacheReportInputBuilder
pub fn builder() -> StartCacheReportInputBuilder
Creates a new builder-style object to manufacture StartCacheReportInput
.
Trait Implementations§
Source§impl Clone for StartCacheReportInput
impl Clone for StartCacheReportInput
Source§fn clone(&self) -> StartCacheReportInput
fn clone(&self) -> StartCacheReportInput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for StartCacheReportInput
impl Debug for StartCacheReportInput
Source§impl PartialEq for StartCacheReportInput
impl PartialEq for StartCacheReportInput
impl StructuralPartialEq for StartCacheReportInput
Auto Trait Implementations§
impl Freeze for StartCacheReportInput
impl RefUnwindSafe for StartCacheReportInput
impl Send for StartCacheReportInput
impl Sync for StartCacheReportInput
impl Unpin for StartCacheReportInput
impl UnwindSafe for StartCacheReportInput
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);