Struct aws_sdk_iot::operation::create_custom_metric::builders::CreateCustomMetricInputBuilder

#[non_exhaustive]
pub struct CreateCustomMetricInputBuilder { /* private fields */ }

A builder for CreateCustomMetricInput.

Implementations

impl CreateCustomMetricInputBuilder

pub fn metric_name(self, input: impl Into<String>) -> Self

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.

This field is required.

pub fn set_metric_name(self, input: Option<String>) -> Self

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.

pub fn get_metric_name(&self) -> &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.

pub fn display_name(self, input: impl Into<String>) -> Self

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.

pub fn set_display_name(self, input: Option<String>) -> Self

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.

pub fn get_display_name(&self) -> &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.

pub fn metric_type(self, input: CustomMetricType) -> Self

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.

This field is required.

pub fn set_metric_type(self, input: Option<CustomMetricType>) -> Self

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.

pub fn get_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.

pub fn tags(self, input: Tag) -> Self

Appends an item to tags.

To override the contents of this collection use set_tags.

Metadata that can be used to manage the custom metric.

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

Metadata that can be used to manage the custom metric.

pub fn get_tags(&self) -> &Option<Vec<Tag>>

Metadata that can be used to manage the custom metric.

pub fn client_request_token(self, input: impl Into<String>) -> Self

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.

This field is required.

pub fn set_client_request_token(self, input: Option<String>) -> Self

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.

pub fn get_client_request_token(&self) -> &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.

pub fn build(self) -> Result<CreateCustomMetricInput, BuildError>

Consumes the builder and constructs a CreateCustomMetricInput.

impl CreateCustomMetricInputBuilder

pub async fn send_with( self, client: &Client ) -> Result<CreateCustomMetricOutput, SdkError<CreateCustomMetricError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for CreateCustomMetricInputBuilder

fn clone(&self) -> CreateCustomMetricInputBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateCustomMetricInputBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CreateCustomMetricInputBuilder

fn default() -> CreateCustomMetricInputBuilder

Returns the “default value” for a type.

impl PartialEq for CreateCustomMetricInputBuilder

fn eq(&self, other: &CreateCustomMetricInputBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateCustomMetricInputBuilder