software.amazon.awssdk.services.iot.model

Class CreateCustomMetricRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.iot.model.IotRequest

software.amazon.awssdk.services.iot.model.CreateCustomMetricRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateCustomMetricRequest.Builder,CreateCustomMetricRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateCustomMetricRequest
extends IotRequest
implements ToCopyableBuilder<CreateCustomMetricRequest.Builder,CreateCustomMetricRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateCustomMetricRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateCustomMetricRequest.Builder	builder()
String	clientRequestToken() Each custom metric must have a unique client request token.
String	displayName() Field represents a friendly name in the console for the custom metric; it doesn't have to be unique.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
String	metricName() The name of the custom metric.
CustomMetricType	metricType() The type of the custom metric.
String	metricTypeAsString() The type of the custom metric.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateCustomMetricRequest.Builder>	serializableBuilderClass()
List<Tag>	tags() Metadata that can be used to manage the custom metric.
CreateCustomMetricRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

metricName

public final 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.

Returns:

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.

displayName

public final 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.

Returns:

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.

metricType

public final CustomMetricType metricType()

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

If the service returns an enum value that is not available in the current SDK version, metricType will return CustomMetricType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from metricTypeAsString().

Returns:

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

See Also:

CustomMetricType

metricTypeAsString

public final String metricTypeAsString()

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

If the service returns an enum value that is not available in the current SDK version, metricType will return CustomMetricType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from metricTypeAsString().

Returns:

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

See Also:

CustomMetricType

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final List<Tag> tags()

Metadata that can be used to manage the custom metric.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

Metadata that can be used to manage the custom metric.

clientRequestToken

public final 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, Amazon Web Services SDKs will automatically generate a unique client request.

Returns:

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.

toBuilder

public CreateCustomMetricRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateCustomMetricRequest.Builder,CreateCustomMetricRequest>

Specified by:

toBuilder in class IotRequest

builder

public static CreateCustomMetricRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateCustomMetricRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo