Class DimensionValues
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<DimensionValues.Builder,
DimensionValues>
Contains the specifications for the filters to use for your request.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic DimensionValues.Builder
builder()
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) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the MatchOptions property.final boolean
For responses, this returns true if the service returned a value for the Values property.final Dimension
key()
The name of the dimension that you want to filter on.final String
The name of the dimension that you want to filter on.final List
<MatchOption> The match options that you can use to filter your results.The match options that you can use to filter your results.static Class
<? extends DimensionValues.Builder> 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.values()
The metadata values you can specify to filter upon, so that the results all match at least one of the specified values.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
key
The name of the dimension that you want to filter on.
If the service returns an enum value that is not available in the current SDK version,
key
will returnDimension.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromkeyAsString()
.- Returns:
- The name of the dimension that you want to filter on.
- See Also:
-
keyAsString
The name of the dimension that you want to filter on.
If the service returns an enum value that is not available in the current SDK version,
key
will returnDimension.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromkeyAsString()
.- Returns:
- The name of the dimension that you want to filter on.
- See Also:
-
matchOptions
The match options that you can use to filter your results. You can specify only one of these values in the array.
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
hasMatchOptions()
method.- Returns:
- The match options that you can use to filter your results. You can specify only one of these values in the array.
-
hasMatchOptions
public final boolean hasMatchOptions()For responses, this returns true if the service returned a value for the MatchOptions 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. -
matchOptionsAsStrings
The match options that you can use to filter your results. You can specify only one of these values in the array.
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
hasMatchOptions()
method.- Returns:
- The match options that you can use to filter your results. You can specify only one of these values in the array.
-
hasValues
public final boolean hasValues()For responses, this returns true if the service returned a value for the Values 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. -
values
The metadata values you can specify to filter upon, so that the results all match at least one of the specified values.
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
hasValues()
method.- Returns:
- The metadata values you can specify to filter upon, so that the results all match at least one of the specified values.
-
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<DimensionValues.Builder,
DimensionValues> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
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
-
sdkFields
-