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

Class CreateDimensionRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateDimensionRequest.Builder,CreateDimensionRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateDimensionRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateDimensionRequest.Builder	builder()
String	clientRequestToken()	Each dimension must have a unique client request token.
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.
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
String	name()	A unique identifier for the dimension.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateDimensionRequest.Builder>	serializableBuilderClass()
List<String>	stringValues()	Specifies the value or list of values for the dimension.
List<Tag>	tags()	Metadata that can be used to manage the dimension.
CreateDimensionRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
DimensionType	type()	Specifies the type of dimension.
String	typeAsString()	Specifies the type of dimension.

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

name

public final String name()

A unique identifier for the dimension. Choose something that describes the type and value to make it easy to remember what it does.

Returns:

A unique identifier for the dimension. Choose something that describes the type and value to make it easy to remember what it does.

type

public final DimensionType type()

Specifies the type of dimension. Supported types: TOPIC_FILTER.

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:

Specifies the type of dimension. Supported types: TOPIC_FILTER.

See Also:

DimensionType

typeAsString

public final String typeAsString()

Specifies the type of dimension. Supported types: TOPIC_FILTER.

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:

Specifies the type of dimension. Supported types: TOPIC_FILTER.

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()

Specifies the value or list of values for the dimension. For TOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example, "admin/#").

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:

Specifies the value or list of values for the dimension. For TOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example, "admin/#").

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

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

clientRequestToken

public final String clientRequestToken()

Each dimension must have a unique client request token. If you try to create a new dimension with the same token as a dimension that already exists, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.

Returns:

Each dimension must have a unique client request token. If you try to create a new dimension with the same token as a dimension that already exists, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.

toBuilder

public CreateDimensionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateDimensionRequest.Builder,CreateDimensionRequest>

Specified by:

toBuilder in class IotRequest

builder

public static CreateDimensionRequest.Builder builder()

serializableBuilderClass

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