Interface CreateCustomMetricRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateCustomMetricRequest.Builder,
,CreateCustomMetricRequest> IotRequest.Builder
,SdkBuilder<CreateCustomMetricRequest.Builder,
,CreateCustomMetricRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateCustomMetricRequest
-
Method Summary
Modifier and TypeMethodDescriptionclientRequestToken
(String clientRequestToken) Each custom metric must have a unique client request token.displayName
(String displayName) The friendly name in the console for the custom metric.metricName
(String metricName) The name of the custom metric.metricType
(String metricType) The type of the custom metric.metricType
(CustomMetricType metricType) The type of the custom metric.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.tags
(Collection<Tag> tags) Metadata that can be used to manage the custom metric.tags
(Consumer<Tag.Builder>... tags) Metadata that can be used to manage the custom metric.Metadata that can be used to manage the custom metric.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.iot.model.IotRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
metricName
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.- Parameters:
metricName
- The name of the custom metric. This will be used in the metric report submitted from the device/thing. The name can't begin withaws:
. You can't change the name after you define it.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
displayName
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.
- Parameters:
displayName
- 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
metricType
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.- Parameters:
metricType
- 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
metricType
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.- Parameters:
metricType
- 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
tags
Metadata that can be used to manage the custom metric.
- Parameters:
tags
- Metadata that can be used to manage the custom metric.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
Metadata that can be used to manage the custom metric.
- Parameters:
tags
- Metadata that can be used to manage the custom metric.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
Metadata that can be used to manage the custom metric.
This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
clientRequestToken
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.
- Parameters:
clientRequestToken
- 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
CreateCustomMetricRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateCustomMetricRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-