software.amazon.awssdk.services.iot.model

Interface CreateCustomMetricRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateCustomMetricRequest.Builder,CreateCustomMetricRequest>, IotRequest.Builder, SdkBuilder<CreateCustomMetricRequest.Builder,CreateCustomMetricRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateCustomMetricRequest

public static interface CreateCustomMetricRequest.Builder
extends IotRequest.Builder, SdkPojo, CopyableBuilder<CreateCustomMetricRequest.Builder,CreateCustomMetricRequest>

Method Summary

Modifier and Type	Method and Description
CreateCustomMetricRequest.Builder	clientRequestToken(String clientRequestToken) Each custom metric must have a unique client request token.
CreateCustomMetricRequest.Builder	displayName(String displayName) Field represents a friendly name in the console for the custom metric; it doesn't have to be unique.
CreateCustomMetricRequest.Builder	metricName(String metricName) The name of the custom metric.
CreateCustomMetricRequest.Builder	metricType(CustomMetricType metricType) The type of the custom metric.
CreateCustomMetricRequest.Builder	metricType(String metricType) The type of the custom metric.
CreateCustomMetricRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateCustomMetricRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateCustomMetricRequest.Builder	tags(Collection<Tag> tags) Metadata that can be used to manage the custom metric.
CreateCustomMetricRequest.Builder	tags(Consumer<Tag.Builder>... tags) Metadata that can be used to manage the custom metric.
CreateCustomMetricRequest.Builder	tags(Tag... tags) Metadata that can be used to manage the custom metric.

Methods inherited from interface software.amazon.awssdk.services.iot.model.IotRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

metricName

CreateCustomMetricRequest.Builder metricName(String metricName)

The name of the custom metric. This will be used in the metric report submitted from the device/thing. Shouldn't begin with aws:. Cannot be updated once defined.

Parameters:

metricName - The name of the custom metric. This will be used in the metric report submitted from the device/thing. Shouldn't begin with aws:. Cannot be updated once defined.

Returns:

Returns a reference to this object so that method calls can be chained together.

displayName

CreateCustomMetricRequest.Builder displayName(String displayName)

Field represents a friendly name in the console for the custom metric; it doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated once defined.

Parameters:

displayName - Field represents a friendly name in the console for the custom metric; it doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated once defined.

Returns:

Returns a reference to this object so that method calls can be chained together.

metricType

CreateCustomMetricRequest.Builder metricType(String metricType)

The type of the custom metric. Types include string-list, ip-address-list, number-list, and number.

Parameters:

metricType - The type of the custom metric. Types include string-list, ip-address-list, number-list, and number.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CustomMetricType, CustomMetricType

metricType

CreateCustomMetricRequest.Builder metricType(CustomMetricType metricType)

The type of the custom metric. Types include string-list, ip-address-list, number-list, and number.

Parameters:

metricType - The type of the custom metric. Types include string-list, ip-address-list, number-list, and number.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CustomMetricType, CustomMetricType

tags

CreateCustomMetricRequest.Builder tags(Collection<Tag> 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

CreateCustomMetricRequest.Builder tags(Tag... 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

CreateCustomMetricRequest.Builder tags(Consumer<Tag.Builder>... tags)

Metadata that can be used to manage the custom metric.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#tags(List)

clientRequestToken

CreateCustomMetricRequest.Builder clientRequestToken(String 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, AWS 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, AWS 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)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateCustomMetricRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder