DateDimensionField (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

The dimension type field with date type columns.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DateDimensionField()

Constructors
Constructor and Description
`DateDimensionField()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DateDimensionField`	`clone()`
`boolean`	`equals(Object obj)`
`ColumnIdentifier`	`getColumn()` The column that is used in the `DateDimensionField`.
`String`	`getDateGranularity()` The date granularity of the `DateDimensionField`.
`String`	`getFieldId()` The custom field ID.
`DateTimeFormatConfiguration`	`getFormatConfiguration()` The format configuration of the field.
`String`	`getHierarchyId()` The custom hierarchy ID.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setColumn(ColumnIdentifier column)` The column that is used in the `DateDimensionField`.
`void`	`setDateGranularity(String dateGranularity)` The date granularity of the `DateDimensionField`.
`void`	`setFieldId(String fieldId)` The custom field ID.
`void`	`setFormatConfiguration(DateTimeFormatConfiguration formatConfiguration)` The format configuration of the field.
`void`	`setHierarchyId(String hierarchyId)` The custom hierarchy ID.
`String`	`toString()` Returns a string representation of this object.
`DateDimensionField`	`withColumn(ColumnIdentifier column)` The column that is used in the `DateDimensionField`.
`DateDimensionField`	`withDateGranularity(String dateGranularity)` The date granularity of the `DateDimensionField`.
`DateDimensionField`	`withDateGranularity(TimeGranularity dateGranularity)` The date granularity of the `DateDimensionField`.
`DateDimensionField`	`withFieldId(String fieldId)` The custom field ID.
`DateDimensionField`	`withFormatConfiguration(DateTimeFormatConfiguration formatConfiguration)` The format configuration of the field.
`DateDimensionField`	`withHierarchyId(String hierarchyId)` The custom hierarchy ID.

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

- Constructor Detail
  - DateDimensionField
```
public DateDimensionField()
```
- Method Detail
  - setFieldId
```
public void setFieldId(String fieldId)
```
    The custom field ID.
    
    Parameters:
    
    fieldId - The custom field ID.
  - getFieldId
```
public String getFieldId()
```
    The custom field ID.
    
    Returns:
    
    The custom field ID.
  - withFieldId
```
public DateDimensionField withFieldId(String fieldId)
```
    The custom field ID.
    
    Parameters:
    
    fieldId - The custom field ID.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setColumn
```
public void setColumn(ColumnIdentifier column)
```
    The column that is used in the DateDimensionField.
    
    Parameters:
    
    column - The column that is used in the DateDimensionField.
  - getColumn
```
public ColumnIdentifier getColumn()
```
    The column that is used in the DateDimensionField.
    
    Returns:
    
    The column that is used in the DateDimensionField.
  - withColumn
```
public DateDimensionField withColumn(ColumnIdentifier column)
```
    The column that is used in the DateDimensionField.
    
    Parameters:
    
    column - The column that is used in the DateDimensionField.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDateGranularity
```
public void setDateGranularity(String dateGranularity)
```
    The date granularity of the DateDimensionField. Choose one of the following options:
    - YEAR
    - QUARTER
    - MONTH
    - WEEK
    - DAY
    - HOUR
    - MINUTE
    - SECOND
    - MILLISECOND
    Parameters:
    dateGranularity - The date granularity of the DateDimensionField. Choose one of the following options:
    
    YEAR
    
    QUARTER
    
    MONTH
    
    WEEK
    
    DAY
    
    HOUR
    
    MINUTE
    
    SECOND
    
    MILLISECOND
    See Also:
    
    TimeGranularity
  - getDateGranularity
```
public String getDateGranularity()
```
    The date granularity of the DateDimensionField. Choose one of the following options:
    - YEAR
    - QUARTER
    - MONTH
    - WEEK
    - DAY
    - HOUR
    - MINUTE
    - SECOND
    - MILLISECOND
    Returns:
    The date granularity of the DateDimensionField. Choose one of the following options:
    
    YEAR
    
    QUARTER
    
    MONTH
    
    WEEK
    
    DAY
    
    HOUR
    
    MINUTE
    
    SECOND
    
    MILLISECOND
    See Also:
    
    TimeGranularity
  - withDateGranularity
```
public DateDimensionField withDateGranularity(String dateGranularity)
```
    The date granularity of the DateDimensionField. Choose one of the following options:
    - YEAR
    - QUARTER
    - MONTH
    - WEEK
    - DAY
    - HOUR
    - MINUTE
    - SECOND
    - MILLISECOND
    Parameters:
    dateGranularity - The date granularity of the DateDimensionField. Choose one of the following options:
    
    YEAR
    
    QUARTER
    
    MONTH
    
    WEEK
    
    DAY
    
    HOUR
    
    MINUTE
    
    SECOND
    
    MILLISECOND
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TimeGranularity
  - withDateGranularity
```
public DateDimensionField withDateGranularity(TimeGranularity dateGranularity)
```
    The date granularity of the DateDimensionField. Choose one of the following options:
    - YEAR
    - QUARTER
    - MONTH
    - WEEK
    - DAY
    - HOUR
    - MINUTE
    - SECOND
    - MILLISECOND
    Parameters:
    dateGranularity - The date granularity of the DateDimensionField. Choose one of the following options:
    
    YEAR
    
    QUARTER
    
    MONTH
    
    WEEK
    
    DAY
    
    HOUR
    
    MINUTE
    
    SECOND
    
    MILLISECOND
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TimeGranularity
  - setHierarchyId
```
public void setHierarchyId(String hierarchyId)
```
    The custom hierarchy ID.
    
    Parameters:
    
    hierarchyId - The custom hierarchy ID.
  - getHierarchyId
```
public String getHierarchyId()
```
    The custom hierarchy ID.
    
    Returns:
    
    The custom hierarchy ID.
  - withHierarchyId
```
public DateDimensionField withHierarchyId(String hierarchyId)
```
    The custom hierarchy ID.
    
    Parameters:
    
    hierarchyId - The custom hierarchy ID.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFormatConfiguration
```
public void setFormatConfiguration(DateTimeFormatConfiguration formatConfiguration)
```
    The format configuration of the field.
    
    Parameters:
    
    formatConfiguration - The format configuration of the field.
  - getFormatConfiguration
```
public DateTimeFormatConfiguration getFormatConfiguration()
```
    The format configuration of the field.
    
    Returns:
    
    The format configuration of the field.
  - withFormatConfiguration
```
public DateDimensionField withFormatConfiguration(DateTimeFormatConfiguration formatConfiguration)
```
    The format configuration of the field.
    
    Parameters:
    
    formatConfiguration - The format configuration of the field.
    
    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 DateDimensionField 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.792

Class DateDimensionField

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DateDimensionField

Method Detail

setFieldId

getFieldId

withFieldId

setColumn

getColumn

withColumn

setDateGranularity

getDateGranularity

withDateGranularity

withDateGranularity

setHierarchyId

getHierarchyId

withHierarchyId

setFormatConfiguration

getFormatConfiguration

withFormatConfiguration

toString

equals

hashCode

clone

marshall