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

Class DescribeDimensionResponse

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.DescribeDimensionResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeDimensionResponse.Builder,DescribeDimensionResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeDimensionResponse.Builder

Method Summary

Modifier and Type	Method	Description
String	arn()	The Amazon Resource Name (ARN) for the dimension.
static DescribeDimensionResponse.Builder	builder()
Instant	creationDate()	The date the dimension was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasStringValues()	For responses, this returns true if the service returned a value for the StringValues property.
Instant	lastModifiedDate()	The date the dimension was last modified.
String	name()	The unique identifier for the dimension.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeDimensionResponse.Builder>	serializableBuilderClass()
List<String>	stringValues()	The value or list of values used to scope the dimension.
DescribeDimensionResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
DimensionType	type()	The type of the dimension.
String	typeAsString()	The type of the dimension.

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

name

public final String name()

The unique identifier for the dimension.

Returns:

The unique identifier for the dimension.

arn

public final String arn()

The Amazon Resource Name (ARN) for the dimension.

Returns:

The Amazon Resource Name (ARN) for the dimension.

type

public final DimensionType type()

The type of the dimension.

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

Returns:

The type of the dimension.

See Also:

DimensionType

typeAsString

public final String typeAsString()

The type of the dimension.

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

Returns:

The type of the dimension.

See Also:

DimensionType

hasStringValues

public final boolean hasStringValues()

For responses, this returns true if the service returned a value for the StringValues 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.

stringValues

public final List<String> stringValues()

The value or list of values used to scope the dimension. For example, for topic filters, this is the pattern used to match the MQTT topic name.

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 hasStringValues() method.

Returns:

The value or list of values used to scope the dimension. For example, for topic filters, this is the pattern used to match the MQTT topic name.

creationDate

public final Instant creationDate()

The date the dimension was created.

Returns:

The date the dimension was created.

lastModifiedDate

public final Instant lastModifiedDate()

The date the dimension was last modified.

Returns:

The date the dimension was last modified.

toBuilder

public DescribeDimensionResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeDimensionResponse.Builder,DescribeDimensionResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static DescribeDimensionResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeDimensionResponse.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