Struct aws_sdk_iot::input::create_custom_metric_input::Builder
source · pub struct Builder { /* private fields */ }
Expand description
A builder for CreateCustomMetricInput
.
Implementations§
source§impl Builder
impl Builder
sourcepub fn metric_name(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_metric_name(self, input: Option<String>) -> Self
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.
sourcepub fn display_name(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_display_name(self, input: Option<String>) -> Self
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.
sourcepub fn metric_type(self, input: CustomMetricType) -> Self
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.
sourcepub fn set_metric_type(self, input: Option<CustomMetricType>) -> Self
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.
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.
Metadata that can be used to manage the custom metric.
sourcepub fn client_request_token(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_client_request_token(self, input: Option<String>) -> Self
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.
sourcepub fn build(self) -> Result<CreateCustomMetricInput, BuildError>
pub fn build(self) -> Result<CreateCustomMetricInput, BuildError>
Consumes the builder and constructs a CreateCustomMetricInput
.