software.amazon.awssdk.services.lookoutmetrics.model

Class MetricSetDimensionFilter

java.lang.Object

software.amazon.awssdk.services.lookoutmetrics.model.MetricSetDimensionFilter

All Implemented Interfaces:

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

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

Describes a list of filters for choosing a subset of dimension values. Each filter consists of the dimension and one of its values that you want to include. When multiple dimensions or values are specified, the dimensions are joined with an AND operation and the values are joined with an OR operation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MetricSetDimensionFilter.Builder

Method Summary

Modifier and Type	Method and Description
static MetricSetDimensionFilter.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<Filter>	filterList() The list of filters that you are applying.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFilterList() For responses, this returns true if the service returned a value for the FilterList property.
int	hashCode()
String	name() The dimension that you want to filter on.
List<SdkField<?>>	sdkFields()
static Class<? extends MetricSetDimensionFilter.Builder>	serializableBuilderClass()
MetricSetDimensionFilter.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

The dimension that you want to filter on.

Returns:

The dimension that you want to filter on.

hasFilterList

public final boolean hasFilterList()

For responses, this returns true if the service returned a value for the FilterList 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.

filterList

public final List<Filter> filterList()

The list of filters that you are applying.

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 hasFilterList() method.

Returns:

The list of filters that you are applying.

toBuilder

public MetricSetDimensionFilter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MetricSetDimensionFilter.Builder,MetricSetDimensionFilter>

builder

public static MetricSetDimensionFilter.Builder builder()

serializableBuilderClass

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