CreateDimensionRequest (AWS Java SDK :: Services

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(value="software.amazon.awssdk:codegen")
public final class CreateDimensionRequest
extends IotRequest
implements ToCopyableBuilder<CreateDimensionRequest.Builder,CreateDimensionRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateDimensionRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateDimensionRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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()` Returns true if the StringValues property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`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 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 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 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 boolean hasStringValues()
```
    Returns true if the StringValues property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - stringValues
```
public 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.
    
    You can use hasStringValues() to see if a value was sent in this field.
    
    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 boolean hasTags()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - tags
```
public 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.
    
    You can use hasTags() to see if a value was sent in this field.
    
    Returns:
    
    Metadata that can be used to manage the dimension.
  - clientRequestToken
```
public 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, AWS 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, AWS 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 int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateDimensionRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

name

type

typeAsString

hasStringValues

stringValues

hasTags

tags

clientRequestToken

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields