Package software.amazon.awssdk.services.iot.model

Class DescribeCustomMetricResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.iot.model.IotResponse

software.amazon.awssdk.services.iot.model.DescribeCustomMetricResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeCustomMetricResponse.Builder,DescribeCustomMetricResponse>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeCustomMetricResponse
extends IotResponse
implements ToCopyableBuilder<DescribeCustomMetricResponse.Builder,DescribeCustomMetricResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeCustomMetricResponse.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeCustomMetricResponse.Builder	builder()
Instant	creationDate()	The creation date of the custom metric in milliseconds since epoch.
String	displayName()	Field represents a friendly name in the console for the custom metric; 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()
Instant	lastModifiedDate()	The time the custom metric was last modified in milliseconds since epoch.
String	metricArn()	The Amazon Resource Number (ARN) of the custom metric.
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 DescribeCustomMetricResponse.Builder>	serializableBuilderClass()
DescribeCustomMetricResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.iot.model.IotResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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.

Returns:

The name of the custom metric.

metricArn

public final String metricArn()

The Amazon Resource Number (ARN) of the custom metric.

Returns:

The Amazon Resource Number (ARN) of the custom metric.

metricType

public final CustomMetricType metricType()

The type of the custom metric.

The type number only takes a single metric value as an input, but while submitting the metrics value in the DeviceMetrics report, it must be passed as an array with a single value.

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.

The type number only takes a single metric value as an input, but while submitting the metrics value in the DeviceMetrics report, it must be passed as an array with a single value.

See Also:

CustomMetricType

metricTypeAsString

public final String metricTypeAsString()

The type of the custom metric.

The type number only takes a single metric value as an input, but while submitting the metrics value in the DeviceMetrics report, it must be passed as an array with a single value.

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.

The type number only takes a single metric value as an input, but while submitting the metrics value in the DeviceMetrics report, it must be passed as an array with a single value.

See Also:

CustomMetricType

displayName

public final String displayName()

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

Returns:

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

creationDate

public final Instant creationDate()

The creation date of the custom metric in milliseconds since epoch.

Returns:

The creation date of the custom metric in milliseconds since epoch.

lastModifiedDate

public final Instant lastModifiedDate()

The time the custom metric was last modified in milliseconds since epoch.

Returns:

The time the custom metric was last modified in milliseconds since epoch.

toBuilder

public DescribeCustomMetricResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeCustomMetricResponse.Builder,DescribeCustomMetricResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static DescribeCustomMetricResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo