Package software.amazon.awssdk.services.ec2.model

Class DimensionCondition

java.lang.Object

software.amazon.awssdk.services.ec2.model.DimensionCondition

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DimensionCondition.Builder,DimensionCondition>

@Generated("software.amazon.awssdk:codegen")
public final class DimensionCondition
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DimensionCondition.Builder,DimensionCondition>

Specifies a condition for filtering capacity data based on dimension values. Used to create precise filters for metric queries and dimension lookups.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DimensionCondition.Builder

Method Summary

Modifier and Type	Method	Description
static DimensionCondition.Builder	builder()
Comparison	comparison()	The comparison operator to use for the filter.
String	comparisonAsString()	The comparison operator to use for the filter.
FilterByDimension	dimension()	The name of the dimension to filter by.
String	dimensionAsString()	The name of the dimension to filter by.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasValues()	For responses, this returns true if the service returned a value for the Values property.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DimensionCondition.Builder>	serializableBuilderClass()
DimensionCondition.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<String>	values()	The list of values to match against the specified dimension.

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

dimension

public final FilterByDimension dimension()

The name of the dimension to filter by.

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

Returns:

The name of the dimension to filter by.

See Also:

FilterByDimension

dimensionAsString

public final String dimensionAsString()

The name of the dimension to filter by.

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

Returns:

The name of the dimension to filter by.

See Also:

FilterByDimension

comparison

public final Comparison comparison()

The comparison operator to use for the filter.

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

Returns:

The comparison operator to use for the filter.

See Also:

Comparison

comparisonAsString

public final String comparisonAsString()

The comparison operator to use for the filter.

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

Returns:

The comparison operator to use for the filter.

See Also:

Comparison

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

values

public final List<String> values()

The list of values to match against the specified dimension. For 'equals' comparison, only the first value is used. For 'in' comparison, any matching value will satisfy the condition.

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 list of values to match against the specified dimension. For 'equals' comparison, only the first value is used. For 'in' comparison, any matching value will satisfy the condition.

toBuilder

public DimensionCondition.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DimensionCondition.Builder,DimensionCondition>

builder

public static DimensionCondition.Builder builder()

serializableBuilderClass

public static Class<? extends DimensionCondition.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo