java.lang.Object
- software.amazon.awssdk.services.quicksight.model.TimeRangeFilter

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<TimeRangeFilter.Builder,TimeRangeFilter>
```
@Generated("software.amazon.awssdk:codegen")
public final class TimeRangeFilter
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<TimeRangeFilter.Builder,TimeRangeFilter>
```
A TimeRangeFilter filters values that are between two specified values.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface TimeRangeFilter.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static TimeRangeFilter.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)`
`ExcludePeriodConfiguration`	`excludePeriodConfiguration()`	The exclude period of the time range filter.
`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()`
`Boolean`	`includeMaximum()`	Determines whether the maximum value in the filter value range should be included in the filtered results.
`Boolean`	`includeMinimum()`	Determines whether the minimum value in the filter value range should be included in the filtered results.
`FilterNullOption`	`nullOption()`	This option determines how null values should be treated when filtering data.
`String`	`nullOptionAsString()`	This option determines how null values should be treated when filtering data.
`TimeRangeFilterValue`	`rangeMaximumValue()`	The maximum value for the filter value range.
`TimeRangeFilterValue`	`rangeMinimumValue()`	The minimum value for the filter value range.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends TimeRangeFilter.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.
`TimeRangeFilter.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
  - 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.
  - includeMinimum
```
public final Boolean includeMinimum()
```
    Determines whether the minimum value in the filter value range should be included in the filtered results.
    
    Returns:
    
    Determines whether the minimum value in the filter value range should be included in the filtered results.
  - includeMaximum
```
public final Boolean includeMaximum()
```
    Determines whether the maximum value in the filter value range should be included in the filtered results.
    
    Returns:
    
    Determines whether the maximum value in the filter value range should be included in the filtered results.
  - rangeMinimumValue
```
public final TimeRangeFilterValue rangeMinimumValue()
```
    The minimum value for the filter value range.
    
    Returns:
    
    The minimum value for the filter value range.
  - rangeMaximumValue
```
public final TimeRangeFilterValue rangeMaximumValue()
```
    The maximum value for the filter value range.
    
    Returns:
    
    The maximum value for the filter value range.
  - nullOption
```
public final FilterNullOption nullOption()
```
    This option determines how null values should be treated when filtering data.
    
    ALL_VALUES: Include null values in filtered results.
    
    NULLS_ONLY: Only include null values in filtered results.
    
    NON_NULLS_ONLY: Exclude null values from filtered results.
    
    If the service returns an enum value that is not available in the current SDK version, nullOption will return FilterNullOption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from nullOptionAsString().
    Returns:
    
    This option determines how null values should be treated when filtering data.
    
    ALL_VALUES: Include null values in filtered results.
    
    NULLS_ONLY: Only include null values in filtered results.
    
    NON_NULLS_ONLY: Exclude null values from filtered results.
    
    See Also:
    
    FilterNullOption
  - nullOptionAsString
```
public final String nullOptionAsString()
```
    This option determines how null values should be treated when filtering data.
    
    ALL_VALUES: Include null values in filtered results.
    
    NULLS_ONLY: Only include null values in filtered results.
    
    NON_NULLS_ONLY: Exclude null values from filtered results.
    
    If the service returns an enum value that is not available in the current SDK version, nullOption will return FilterNullOption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from nullOptionAsString().
    Returns:
    
    This option determines how null values should be treated when filtering data.
    
    ALL_VALUES: Include null values in filtered results.
    
    NULLS_ONLY: Only include null values in filtered results.
    
    NON_NULLS_ONLY: Exclude null values from filtered results.
    
    See Also:
    
    FilterNullOption
  - excludePeriodConfiguration
```
public final ExcludePeriodConfiguration excludePeriodConfiguration()
```
    The exclude period of the time range filter.
    
    Returns:
    
    The exclude period of the time range filter.
  - 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
  - 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 TimeRangeFilter.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<TimeRangeFilter.Builder,TimeRangeFilter>
  - builder
```
public static TimeRangeFilter.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends TimeRangeFilter.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

Class TimeRangeFilter

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

filterId

column

includeMinimum

includeMaximum

rangeMinimumValue

rangeMaximumValue

nullOption

nullOptionAsString

excludePeriodConfiguration

timeGranularity

timeGranularityAsString

defaultFilterControlConfiguration

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields