aws_sdk_s3/types/
_metrics_configuration.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2
3/// <p>Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTMetricConfiguration.html">PutBucketMetricsConfiguration</a>.</p>
4#[non_exhaustive]
5#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
6pub struct MetricsConfiguration {
7    /// <p>The ID used to identify the metrics configuration. The ID has a 64 character limit and can only contain letters, numbers, periods, dashes, and underscores.</p>
8    pub id: ::std::string::String,
9    /// <p>Specifies a metrics configuration filter. The metrics configuration will only include objects that meet the filter's criteria. A filter must be a prefix, an object tag, an access point ARN, or a conjunction (MetricsAndOperator).</p>
10    pub filter: ::std::option::Option<crate::types::MetricsFilter>,
11}
12impl MetricsConfiguration {
13    /// <p>The ID used to identify the metrics configuration. The ID has a 64 character limit and can only contain letters, numbers, periods, dashes, and underscores.</p>
14    pub fn id(&self) -> &str {
15        use std::ops::Deref;
16        self.id.deref()
17    }
18    /// <p>Specifies a metrics configuration filter. The metrics configuration will only include objects that meet the filter's criteria. A filter must be a prefix, an object tag, an access point ARN, or a conjunction (MetricsAndOperator).</p>
19    pub fn filter(&self) -> ::std::option::Option<&crate::types::MetricsFilter> {
20        self.filter.as_ref()
21    }
22}
23impl MetricsConfiguration {
24    /// Creates a new builder-style object to manufacture [`MetricsConfiguration`](crate::types::MetricsConfiguration).
25    pub fn builder() -> crate::types::builders::MetricsConfigurationBuilder {
26        crate::types::builders::MetricsConfigurationBuilder::default()
27    }
28}
29
30/// A builder for [`MetricsConfiguration`](crate::types::MetricsConfiguration).
31#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
32#[non_exhaustive]
33pub struct MetricsConfigurationBuilder {
34    pub(crate) id: ::std::option::Option<::std::string::String>,
35    pub(crate) filter: ::std::option::Option<crate::types::MetricsFilter>,
36}
37impl MetricsConfigurationBuilder {
38    /// <p>The ID used to identify the metrics configuration. The ID has a 64 character limit and can only contain letters, numbers, periods, dashes, and underscores.</p>
39    /// This field is required.
40    pub fn id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
41        self.id = ::std::option::Option::Some(input.into());
42        self
43    }
44    /// <p>The ID used to identify the metrics configuration. The ID has a 64 character limit and can only contain letters, numbers, periods, dashes, and underscores.</p>
45    pub fn set_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
46        self.id = input;
47        self
48    }
49    /// <p>The ID used to identify the metrics configuration. The ID has a 64 character limit and can only contain letters, numbers, periods, dashes, and underscores.</p>
50    pub fn get_id(&self) -> &::std::option::Option<::std::string::String> {
51        &self.id
52    }
53    /// <p>Specifies a metrics configuration filter. The metrics configuration will only include objects that meet the filter's criteria. A filter must be a prefix, an object tag, an access point ARN, or a conjunction (MetricsAndOperator).</p>
54    pub fn filter(mut self, input: crate::types::MetricsFilter) -> Self {
55        self.filter = ::std::option::Option::Some(input);
56        self
57    }
58    /// <p>Specifies a metrics configuration filter. The metrics configuration will only include objects that meet the filter's criteria. A filter must be a prefix, an object tag, an access point ARN, or a conjunction (MetricsAndOperator).</p>
59    pub fn set_filter(mut self, input: ::std::option::Option<crate::types::MetricsFilter>) -> Self {
60        self.filter = input;
61        self
62    }
63    /// <p>Specifies a metrics configuration filter. The metrics configuration will only include objects that meet the filter's criteria. A filter must be a prefix, an object tag, an access point ARN, or a conjunction (MetricsAndOperator).</p>
64    pub fn get_filter(&self) -> &::std::option::Option<crate::types::MetricsFilter> {
65        &self.filter
66    }
67    /// Consumes the builder and constructs a [`MetricsConfiguration`](crate::types::MetricsConfiguration).
68    /// This method will fail if any of the following fields are not set:
69    /// - [`id`](crate::types::builders::MetricsConfigurationBuilder::id)
70    pub fn build(self) -> ::std::result::Result<crate::types::MetricsConfiguration, ::aws_smithy_types::error::operation::BuildError> {
71        ::std::result::Result::Ok(crate::types::MetricsConfiguration {
72            id: self.id.ok_or_else(|| {
73                ::aws_smithy_types::error::operation::BuildError::missing_field(
74                    "id",
75                    "id was not specified but it is required when building MetricsConfiguration",
76                )
77            })?,
78            filter: self.filter,
79        })
80    }
81}
aws_sdk_s3/types/_metrics_configuration.rs

aws_sdk_s3/types/
_metrics_configuration.rs
