RelativeDatesFilter (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.quicksight.model.RelativeDatesFilter

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RelativeDatesFilter
extends Object
implements Serializable, Cloneable, StructuredPojo

A RelativeDatesFilter filters relative dates values.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

RelativeDatesFilter()

Constructors
Constructor and Description
`RelativeDatesFilter()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RelativeDatesFilter`	`clone()`
`boolean`	`equals(Object obj)`
`AnchorDateConfiguration`	`getAnchorDateConfiguration()` The date configuration of the filter.
`ColumnIdentifier`	`getColumn()` The column that the filter is applied to.
`DefaultFilterControlConfiguration`	`getDefaultFilterControlConfiguration()` The default configurations for the associated controls.
`ExcludePeriodConfiguration`	`getExcludePeriodConfiguration()` The configuration for the exclude period of the filter.
`String`	`getFilterId()` An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
`String`	`getMinimumGranularity()` The minimum granularity (period granularity) of the relative dates filter.
`String`	`getNullOption()` This option determines how null values should be treated when filtering data.
`String`	`getParameterName()` The parameter whose value should be used for the filter value.
`String`	`getRelativeDateType()` The range date type of the filter.
`Integer`	`getRelativeDateValue()` The date value of the filter.
`String`	`getTimeGranularity()` The level of time precision that is used to aggregate `DateTime` values.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAnchorDateConfiguration(AnchorDateConfiguration anchorDateConfiguration)` The date configuration of the filter.
`void`	`setColumn(ColumnIdentifier column)` The column that the filter is applied to.
`void`	`setDefaultFilterControlConfiguration(DefaultFilterControlConfiguration defaultFilterControlConfiguration)` The default configurations for the associated controls.
`void`	`setExcludePeriodConfiguration(ExcludePeriodConfiguration excludePeriodConfiguration)` The configuration for the exclude period of the filter.
`void`	`setFilterId(String filterId)` An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
`void`	`setMinimumGranularity(String minimumGranularity)` The minimum granularity (period granularity) of the relative dates filter.
`void`	`setNullOption(String nullOption)` This option determines how null values should be treated when filtering data.
`void`	`setParameterName(String parameterName)` The parameter whose value should be used for the filter value.
`void`	`setRelativeDateType(String relativeDateType)` The range date type of the filter.
`void`	`setRelativeDateValue(Integer relativeDateValue)` The date value of the filter.
`void`	`setTimeGranularity(String timeGranularity)` The level of time precision that is used to aggregate `DateTime` values.
`String`	`toString()` Returns a string representation of this object.
`RelativeDatesFilter`	`withAnchorDateConfiguration(AnchorDateConfiguration anchorDateConfiguration)` The date configuration of the filter.
`RelativeDatesFilter`	`withColumn(ColumnIdentifier column)` The column that the filter is applied to.
`RelativeDatesFilter`	`withDefaultFilterControlConfiguration(DefaultFilterControlConfiguration defaultFilterControlConfiguration)` The default configurations for the associated controls.
`RelativeDatesFilter`	`withExcludePeriodConfiguration(ExcludePeriodConfiguration excludePeriodConfiguration)` The configuration for the exclude period of the filter.
`RelativeDatesFilter`	`withFilterId(String filterId)` An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
`RelativeDatesFilter`	`withMinimumGranularity(String minimumGranularity)` The minimum granularity (period granularity) of the relative dates filter.
`RelativeDatesFilter`	`withMinimumGranularity(TimeGranularity minimumGranularity)` The minimum granularity (period granularity) of the relative dates filter.
`RelativeDatesFilter`	`withNullOption(FilterNullOption nullOption)` This option determines how null values should be treated when filtering data.
`RelativeDatesFilter`	`withNullOption(String nullOption)` This option determines how null values should be treated when filtering data.
`RelativeDatesFilter`	`withParameterName(String parameterName)` The parameter whose value should be used for the filter value.
`RelativeDatesFilter`	`withRelativeDateType(RelativeDateType relativeDateType)` The range date type of the filter.
`RelativeDatesFilter`	`withRelativeDateType(String relativeDateType)` The range date type of the filter.
`RelativeDatesFilter`	`withRelativeDateValue(Integer relativeDateValue)` The date value of the filter.
`RelativeDatesFilter`	`withTimeGranularity(String timeGranularity)` The level of time precision that is used to aggregate `DateTime` values.
`RelativeDatesFilter`	`withTimeGranularity(TimeGranularity timeGranularity)` The level of time precision that is used to aggregate `DateTime` values.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - RelativeDatesFilter
```
public RelativeDatesFilter()
```
- Method Detail
  - setFilterId
```
public void setFilterId(String filterId)
```
    An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
    
    Parameters:
    
    filterId - An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
  - getFilterId
```
public String getFilterId()
```
    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.
  - withFilterId
```
public RelativeDatesFilter withFilterId(String filterId)
```
    An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
    
    Parameters:
    
    filterId - An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setColumn
```
public void setColumn(ColumnIdentifier column)
```
    The column that the filter is applied to.
    
    Parameters:
    
    column - The column that the filter is applied to.
  - getColumn
```
public ColumnIdentifier getColumn()
```
    The column that the filter is applied to.
    
    Returns:
    
    The column that the filter is applied to.
  - withColumn
```
public RelativeDatesFilter withColumn(ColumnIdentifier column)
```
    The column that the filter is applied to.
    
    Parameters:
    
    column - The column that the filter is applied to.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAnchorDateConfiguration
```
public void setAnchorDateConfiguration(AnchorDateConfiguration anchorDateConfiguration)
```
    The date configuration of the filter.
    
    Parameters:
    
    anchorDateConfiguration - The date configuration of the filter.
  - getAnchorDateConfiguration
```
public AnchorDateConfiguration getAnchorDateConfiguration()
```
    The date configuration of the filter.
    
    Returns:
    
    The date configuration of the filter.
  - withAnchorDateConfiguration
```
public RelativeDatesFilter withAnchorDateConfiguration(AnchorDateConfiguration anchorDateConfiguration)
```
    The date configuration of the filter.
    
    Parameters:
    
    anchorDateConfiguration - The date configuration of the filter.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMinimumGranularity
```
public void setMinimumGranularity(String minimumGranularity)
```
    The minimum granularity (period granularity) of the relative dates filter.
    
    Parameters:
    
    minimumGranularity - The minimum granularity (period granularity) of the relative dates filter.
    
    See Also:
    
    TimeGranularity
  - getMinimumGranularity
```
public String getMinimumGranularity()
```
    The minimum granularity (period granularity) of the relative dates filter.
    
    Returns:
    
    The minimum granularity (period granularity) of the relative dates filter.
    
    See Also:
    
    TimeGranularity
  - withMinimumGranularity
```
public RelativeDatesFilter withMinimumGranularity(String minimumGranularity)
```
    The minimum granularity (period granularity) of the relative dates filter.
    
    Parameters:
    
    minimumGranularity - The minimum granularity (period granularity) of the relative dates filter.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TimeGranularity
  - withMinimumGranularity
```
public RelativeDatesFilter withMinimumGranularity(TimeGranularity minimumGranularity)
```
    The minimum granularity (period granularity) of the relative dates filter.
    
    Parameters:
    
    minimumGranularity - The minimum granularity (period granularity) of the relative dates filter.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TimeGranularity
  - setTimeGranularity
```
public void setTimeGranularity(String timeGranularity)
```
    The level of time precision that is used to aggregate DateTime values.
    
    Parameters:
    
    timeGranularity - The level of time precision that is used to aggregate DateTime values.
    
    See Also:
    
    TimeGranularity
  - getTimeGranularity
```
public String getTimeGranularity()
```
    The level of time precision that is used to aggregate DateTime values.
    
    Returns:
    
    The level of time precision that is used to aggregate DateTime values.
    
    See Also:
    
    TimeGranularity
  - withTimeGranularity
```
public RelativeDatesFilter withTimeGranularity(String timeGranularity)
```
    The level of time precision that is used to aggregate DateTime values.
    
    Parameters:
    
    timeGranularity - The level of time precision that is used to aggregate DateTime values.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TimeGranularity
  - withTimeGranularity
```
public RelativeDatesFilter withTimeGranularity(TimeGranularity timeGranularity)
```
    The level of time precision that is used to aggregate DateTime values.
    
    Parameters:
    
    timeGranularity - The level of time precision that is used to aggregate DateTime values.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TimeGranularity
  - setRelativeDateType
```
public void setRelativeDateType(String relativeDateType)
```
    The range date type of the filter. Choose one of the options below:
    - PREVIOUS
    - THIS
    - LAST
    - NOW
    - NEXT
    Parameters:
    relativeDateType - The range date type of the filter. Choose one of the options below:
    
    PREVIOUS
    
    THIS
    
    LAST
    
    NOW
    
    NEXT
    See Also:
    
    RelativeDateType
  - getRelativeDateType
```
public String getRelativeDateType()
```
    The range date type of the filter. Choose one of the options below:
    - PREVIOUS
    - THIS
    - LAST
    - NOW
    - NEXT
    Returns:
    The range date type of the filter. Choose one of the options below:
    
    PREVIOUS
    
    THIS
    
    LAST
    
    NOW
    
    NEXT
    See Also:
    
    RelativeDateType
  - withRelativeDateType
```
public RelativeDatesFilter withRelativeDateType(String relativeDateType)
```
    The range date type of the filter. Choose one of the options below:
    - PREVIOUS
    - THIS
    - LAST
    - NOW
    - NEXT
    Parameters:
    relativeDateType - The range date type of the filter. Choose one of the options below:
    
    PREVIOUS
    
    THIS
    
    LAST
    
    NOW
    
    NEXT
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RelativeDateType
  - withRelativeDateType
```
public RelativeDatesFilter withRelativeDateType(RelativeDateType relativeDateType)
```
    The range date type of the filter. Choose one of the options below:
    - PREVIOUS
    - THIS
    - LAST
    - NOW
    - NEXT
    Parameters:
    relativeDateType - The range date type of the filter. Choose one of the options below:
    
    PREVIOUS
    
    THIS
    
    LAST
    
    NOW
    
    NEXT
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RelativeDateType
  - setRelativeDateValue
```
public void setRelativeDateValue(Integer relativeDateValue)
```
    The date value of the filter.
    
    Parameters:
    
    relativeDateValue - The date value of the filter.
  - getRelativeDateValue
```
public Integer getRelativeDateValue()
```
    The date value of the filter.
    
    Returns:
    
    The date value of the filter.
  - withRelativeDateValue
```
public RelativeDatesFilter withRelativeDateValue(Integer relativeDateValue)
```
    The date value of the filter.
    
    Parameters:
    
    relativeDateValue - The date value of the filter.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setParameterName
```
public void setParameterName(String parameterName)
```
    The parameter whose value should be used for the filter value.
    
    Parameters:
    
    parameterName - The parameter whose value should be used for the filter value.
  - getParameterName
```
public String getParameterName()
```
    The parameter whose value should be used for the filter value.
    
    Returns:
    
    The parameter whose value should be used for the filter value.
  - withParameterName
```
public RelativeDatesFilter withParameterName(String parameterName)
```
    The parameter whose value should be used for the filter value.
    
    Parameters:
    
    parameterName - The parameter whose value should be used for the filter value.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNullOption
```
public void setNullOption(String 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.
    Parameters:
    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.
    See Also:
    
    FilterNullOption
  - getNullOption
```
public String getNullOption()
```
    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.
    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
  - withNullOption
```
public RelativeDatesFilter withNullOption(String 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    FilterNullOption
  - withNullOption
```
public RelativeDatesFilter withNullOption(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    FilterNullOption
  - setExcludePeriodConfiguration
```
public void setExcludePeriodConfiguration(ExcludePeriodConfiguration excludePeriodConfiguration)
```
    The configuration for the exclude period of the filter.
    
    Parameters:
    
    excludePeriodConfiguration - The configuration for the exclude period of the filter.
  - getExcludePeriodConfiguration
```
public ExcludePeriodConfiguration getExcludePeriodConfiguration()
```
    The configuration for the exclude period of the filter.
    
    Returns:
    
    The configuration for the exclude period of the filter.
  - withExcludePeriodConfiguration
```
public RelativeDatesFilter withExcludePeriodConfiguration(ExcludePeriodConfiguration excludePeriodConfiguration)
```
    The configuration for the exclude period of the filter.
    
    Parameters:
    
    excludePeriodConfiguration - The configuration for the exclude period of the filter.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDefaultFilterControlConfiguration
```
public void setDefaultFilterControlConfiguration(DefaultFilterControlConfiguration defaultFilterControlConfiguration)
```
    The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.
    
    Parameters:
    
    defaultFilterControlConfiguration - The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.
  - getDefaultFilterControlConfiguration
```
public DefaultFilterControlConfiguration getDefaultFilterControlConfiguration()
```
    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.
  - withDefaultFilterControlConfiguration
```
public RelativeDatesFilter withDefaultFilterControlConfiguration(DefaultFilterControlConfiguration defaultFilterControlConfiguration)
```
    The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.
    
    Parameters:
    
    defaultFilterControlConfiguration - The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public RelativeDatesFilter clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.780

Class RelativeDatesFilter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RelativeDatesFilter

Method Detail

setFilterId

getFilterId

withFilterId

setColumn

getColumn

withColumn

setAnchorDateConfiguration

getAnchorDateConfiguration

withAnchorDateConfiguration

setMinimumGranularity

getMinimumGranularity

withMinimumGranularity

withMinimumGranularity

setTimeGranularity

getTimeGranularity

withTimeGranularity

withTimeGranularity

setRelativeDateType

getRelativeDateType

withRelativeDateType

withRelativeDateType

setRelativeDateValue

getRelativeDateValue

withRelativeDateValue

setParameterName

getParameterName

withParameterName

setNullOption

getNullOption

withNullOption

withNullOption

setExcludePeriodConfiguration

getExcludePeriodConfiguration

withExcludePeriodConfiguration

setDefaultFilterControlConfiguration

getDefaultFilterControlConfiguration

withDefaultFilterControlConfiguration

toString

equals

hashCode

clone

marshall