Package software.amazon.awssdk.services.quicksight.model

Class TimeEqualityFilter

java.lang.Object

software.amazon.awssdk.services.quicksight.model.TimeEqualityFilter

All Implemented Interfaces:

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

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

A TimeEqualityFilter filters values that are equal to a given value.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TimeEqualityFilter.Builder

Method Summary

Modifier and Type	Method	Description
static TimeEqualityFilter.Builder	builder()
ColumnIdentifier	column()	The column that the filter is applied to.
DefaultFilterControlConfiguration	defaultFilterControlConfiguration()	The default configurations for the associated controls.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	filterId()	An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	parameterName()	The parameter whose value should be used for the filter value.
RollingDateConfiguration	rollingDate()	The rolling date input for the TimeEquality filter.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends TimeEqualityFilter.Builder>	serializableBuilderClass()
TimeGranularity	timeGranularity()	The level of time precision that is used to aggregate DateTime values.
String	timeGranularityAsString()	The level of time precision that is used to aggregate DateTime values.
TimeEqualityFilter.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Instant	value()	The value of a TimeEquality filter.

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

filterId

public final String filterId()

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

Returns:

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

column

public final ColumnIdentifier column()

The column that the filter is applied to.

Returns:

The column that the filter is applied to.

value

public final Instant value()

The value of a TimeEquality filter.

This field is mutually exclusive to RollingDate and ParameterName.

Returns:

The value of a TimeEquality filter.

This field is mutually exclusive to RollingDate and ParameterName.

parameterName

public final String parameterName()

The parameter whose value should be used for the filter value.

This field is mutually exclusive to Value and RollingDate.

Returns:

The parameter whose value should be used for the filter value.

This field is mutually exclusive to Value and RollingDate.

timeGranularity

public final TimeGranularity timeGranularity()

The level of time precision that is used to aggregate DateTime values.

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

Returns:

The level of time precision that is used to aggregate DateTime values.

See Also:

TimeGranularity

timeGranularityAsString

public final String timeGranularityAsString()

The level of time precision that is used to aggregate DateTime values.

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

Returns:

The level of time precision that is used to aggregate DateTime values.

See Also:

TimeGranularity

rollingDate

public final RollingDateConfiguration rollingDate()

The rolling date input for the TimeEquality filter.

This field is mutually exclusive to Value and ParameterName.

Returns:

The rolling date input for the TimeEquality filter.

This field is mutually exclusive to Value and ParameterName.

defaultFilterControlConfiguration

public final DefaultFilterControlConfiguration defaultFilterControlConfiguration()

The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

Returns:

The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

toBuilder

public TimeEqualityFilter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TimeEqualityFilter.Builder,TimeEqualityFilter>

builder

public static TimeEqualityFilter.Builder builder()

serializableBuilderClass

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