Struct aws_sdk_iot::input::CreateCustomMetricInput
source · [−]#[non_exhaustive]pub struct CreateCustomMetricInput {
pub metric_name: Option<String>,
pub display_name: Option<String>,
pub metric_type: Option<CustomMetricType>,
pub tags: Option<Vec<Tag>>,
pub client_request_token: Option<String>,
}
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.metric_name: Option<String>
The name of the custom metric. This will be used in the metric report submitted from the device/thing. The name can't begin with aws:
. You can't change the name after you define it.
display_name: Option<String>
The friendly name in the console for the custom metric. This name doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. You can update the friendly name after you define it.
metric_type: Option<CustomMetricType>
The type of the custom metric.
The type number
only takes a single metric value as an input, but when you submit the metrics value in the DeviceMetrics report, you must pass it as an array with a single value.
Metadata that can be used to manage the custom metric.
client_request_token: Option<String>
Each custom metric must have a unique client request token. If you try to create a new custom metric that already exists with a different token, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.
Implementations
sourceimpl CreateCustomMetricInput
impl CreateCustomMetricInput
sourcepub async fn make_operation(
self,
_config: &Config
) -> Result<Operation<CreateCustomMetric, AwsErrorRetryPolicy>, BuildError>
pub async fn make_operation(
self,
_config: &Config
) -> Result<Operation<CreateCustomMetric, AwsErrorRetryPolicy>, BuildError>
Consumes the builder and constructs an Operation<CreateCustomMetric
>
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture CreateCustomMetricInput
sourceimpl CreateCustomMetricInput
impl CreateCustomMetricInput
sourcepub fn metric_name(&self) -> Option<&str>
pub fn metric_name(&self) -> Option<&str>
The name of the custom metric. This will be used in the metric report submitted from the device/thing. The name can't begin with aws:
. You can't change the name after you define it.
sourcepub fn display_name(&self) -> Option<&str>
pub fn display_name(&self) -> Option<&str>
The friendly name in the console for the custom metric. This name doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. You can update the friendly name after you define it.
sourcepub fn metric_type(&self) -> Option<&CustomMetricType>
pub fn metric_type(&self) -> Option<&CustomMetricType>
The type of the custom metric.
The type number
only takes a single metric value as an input, but when you submit the metrics value in the DeviceMetrics report, you must pass it as an array with a single value.
Metadata that can be used to manage the custom metric.
sourcepub fn client_request_token(&self) -> Option<&str>
pub fn client_request_token(&self) -> Option<&str>
Each custom metric must have a unique client request token. If you try to create a new custom metric that already exists with a different token, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.
Trait Implementations
sourceimpl Clone for CreateCustomMetricInput
impl Clone for CreateCustomMetricInput
sourcefn clone(&self) -> CreateCustomMetricInput
fn clone(&self) -> CreateCustomMetricInput
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for CreateCustomMetricInput
impl Debug for CreateCustomMetricInput
sourceimpl PartialEq<CreateCustomMetricInput> for CreateCustomMetricInput
impl PartialEq<CreateCustomMetricInput> for CreateCustomMetricInput
sourcefn eq(&self, other: &CreateCustomMetricInput) -> bool
fn eq(&self, other: &CreateCustomMetricInput) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &CreateCustomMetricInput) -> bool
fn ne(&self, other: &CreateCustomMetricInput) -> bool
This method tests for !=
.
impl StructuralPartialEq for CreateCustomMetricInput
Auto Trait Implementations
impl RefUnwindSafe for CreateCustomMetricInput
impl Send for CreateCustomMetricInput
impl Sync for CreateCustomMetricInput
impl Unpin for CreateCustomMetricInput
impl UnwindSafe for CreateCustomMetricInput
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more