Class CreateDimensionRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateDimensionRequest.Builder,
CreateDimensionRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
Each dimension must have a unique client request token.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the StringValues property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
name()
A unique identifier for the dimension.static Class
<? extends CreateDimensionRequest.Builder> Specifies the value or list of values for the dimension.tags()
Metadata that can be used to manage the dimension.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final DimensionType
type()
Specifies the type of dimension.final String
Specifies the type of dimension.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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 returnDimensionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- Specifies the type of dimension. Supported types:
TOPIC_FILTER.
- See Also:
-
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 returnDimensionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- Specifies the type of dimension. Supported types:
TOPIC_FILTER.
- See Also:
-
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 theisEmpty()
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
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 theisEmpty()
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
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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateDimensionRequest.Builder,
CreateDimensionRequest> - Specified by:
toBuilder
in classIotRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-