com.amazonaws.services.quicksight.model.DateDimensionField Maven / Gradle / Ivy
Show all versions of aws-java-sdk-quicksight Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.quicksight.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* The dimension type field with date type columns.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DateDimensionField implements Serializable, Cloneable, StructuredPojo {
/**
*
* The custom field ID.
*
*/
private String fieldId;
/**
*
* The column that is used in the DateDimensionField.
*
*/
private ColumnIdentifier column;
/**
*
* The date granularity of the DateDimensionField. Choose one of the following options:
*
*
* -
*
* YEAR
*
*
* -
*
* QUARTER
*
*
* -
*
* MONTH
*
*
* -
*
* WEEK
*
*
* -
*
* DAY
*
*
* -
*
* HOUR
*
*
* -
*
* MINUTE
*
*
* -
*
* SECOND
*
*
* -
*
* MILLISECOND
*
*
*
*/
private String dateGranularity;
/**
*
* The custom hierarchy ID.
*
*/
private String hierarchyId;
/**
*
* The format configuration of the field.
*
*/
private DateTimeFormatConfiguration formatConfiguration;
/**
*
* The custom field ID.
*
*
* @param fieldId
* The custom field ID.
*/
public void setFieldId(String fieldId) {
this.fieldId = fieldId;
}
/**
*
* The custom field ID.
*
*
* @return The custom field ID.
*/
public String getFieldId() {
return this.fieldId;
}
/**
*
* The custom field ID.
*
*
* @param fieldId
* The custom field ID.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DateDimensionField withFieldId(String fieldId) {
setFieldId(fieldId);
return this;
}
/**
*
* The column that is used in the DateDimensionField.
*
*
* @param column
* The column that is used in the DateDimensionField.
*/
public void setColumn(ColumnIdentifier column) {
this.column = column;
}
/**
*
* The column that is used in the DateDimensionField.
*
*
* @return The column that is used in the DateDimensionField.
*/
public ColumnIdentifier getColumn() {
return this.column;
}
/**
*
* The column that is used in the DateDimensionField.
*
*
* @param column
* The column that is used in the DateDimensionField.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DateDimensionField withColumn(ColumnIdentifier column) {
setColumn(column);
return this;
}
/**
*
* The date granularity of the DateDimensionField. Choose one of the following options:
*
*
* -
*
* YEAR
*
*
* -
*
* QUARTER
*
*
* -
*
* MONTH
*
*
* -
*
* WEEK
*
*
* -
*
* DAY
*
*
* -
*
* HOUR
*
*
* -
*
* MINUTE
*
*
* -
*
* SECOND
*
*
* -
*
* MILLISECOND
*
*
*
*
* @param dateGranularity
* The date granularity of the DateDimensionField. Choose one of the following options:
*
* -
*
* YEAR
*
*
* -
*
* QUARTER
*
*
* -
*
* MONTH
*
*
* -
*
* WEEK
*
*
* -
*
* DAY
*
*
* -
*
* HOUR
*
*
* -
*
* MINUTE
*
*
* -
*
* SECOND
*
*
* -
*
* MILLISECOND
*
*
* @see TimeGranularity
*/
public void setDateGranularity(String dateGranularity) {
this.dateGranularity = dateGranularity;
}
/**
*
* The date granularity of the DateDimensionField. Choose one of the following options:
*
*
* -
*
* YEAR
*
*
* -
*
* QUARTER
*
*
* -
*
* MONTH
*
*
* -
*
* WEEK
*
*
* -
*
* DAY
*
*
* -
*
* HOUR
*
*
* -
*
* MINUTE
*
*
* -
*
* SECOND
*
*
* -
*
* MILLISECOND
*
*
*
*
* @return The date granularity of the DateDimensionField. Choose one of the following options:
*
* -
*
* YEAR
*
*
* -
*
* QUARTER
*
*
* -
*
* MONTH
*
*
* -
*
* WEEK
*
*
* -
*
* DAY
*
*
* -
*
* HOUR
*
*
* -
*
* MINUTE
*
*
* -
*
* SECOND
*
*
* -
*
* MILLISECOND
*
*
* @see TimeGranularity
*/
public String getDateGranularity() {
return this.dateGranularity;
}
/**
*
* The date granularity of the DateDimensionField. Choose one of the following options:
*
*
* -
*
* YEAR
*
*
* -
*
* QUARTER
*
*
* -
*
* MONTH
*
*
* -
*
* WEEK
*
*
* -
*
* DAY
*
*
* -
*
* HOUR
*
*
* -
*
* MINUTE
*
*
* -
*
* SECOND
*
*
* -
*
* MILLISECOND
*
*
*
*
* @param dateGranularity
* The date granularity of the DateDimensionField. Choose one of the following options:
*
* -
*
* YEAR
*
*
* -
*
* QUARTER
*
*
* -
*
* MONTH
*
*
* -
*
* WEEK
*
*
* -
*
* DAY
*
*
* -
*
* HOUR
*
*
* -
*
* MINUTE
*
*
* -
*
* SECOND
*
*
* -
*
* MILLISECOND
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see TimeGranularity
*/
public DateDimensionField withDateGranularity(String dateGranularity) {
setDateGranularity(dateGranularity);
return this;
}
/**
*
* The date granularity of the DateDimensionField. Choose one of the following options:
*
*
* -
*
* YEAR
*
*
* -
*
* QUARTER
*
*
* -
*
* MONTH
*
*
* -
*
* WEEK
*
*
* -
*
* DAY
*
*
* -
*
* HOUR
*
*
* -
*
* MINUTE
*
*
* -
*
* SECOND
*
*
* -
*
* MILLISECOND
*
*
*
*
* @param dateGranularity
* The date granularity of the DateDimensionField. Choose one of the following options:
*
* -
*
* YEAR
*
*
* -
*
* QUARTER
*
*
* -
*
* MONTH
*
*
* -
*
* WEEK
*
*
* -
*
* DAY
*
*
* -
*
* HOUR
*
*
* -
*
* MINUTE
*
*
* -
*
* SECOND
*
*
* -
*
* MILLISECOND
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see TimeGranularity
*/
public DateDimensionField withDateGranularity(TimeGranularity dateGranularity) {
this.dateGranularity = dateGranularity.toString();
return this;
}
/**
*
* The custom hierarchy ID.
*
*
* @param hierarchyId
* The custom hierarchy ID.
*/
public void setHierarchyId(String hierarchyId) {
this.hierarchyId = hierarchyId;
}
/**
*
* The custom hierarchy ID.
*
*
* @return The custom hierarchy ID.
*/
public String getHierarchyId() {
return this.hierarchyId;
}
/**
*
* The custom hierarchy ID.
*
*
* @param hierarchyId
* The custom hierarchy ID.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DateDimensionField withHierarchyId(String hierarchyId) {
setHierarchyId(hierarchyId);
return this;
}
/**
*
* The format configuration of the field.
*
*
* @param formatConfiguration
* The format configuration of the field.
*/
public void setFormatConfiguration(DateTimeFormatConfiguration formatConfiguration) {
this.formatConfiguration = formatConfiguration;
}
/**
*
* The format configuration of the field.
*
*
* @return The format configuration of the field.
*/
public DateTimeFormatConfiguration getFormatConfiguration() {
return this.formatConfiguration;
}
/**
*
* The format configuration of the field.
*
*
* @param formatConfiguration
* The format configuration of the field.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DateDimensionField withFormatConfiguration(DateTimeFormatConfiguration formatConfiguration) {
setFormatConfiguration(formatConfiguration);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getFieldId() != null)
sb.append("FieldId: ").append(getFieldId()).append(",");
if (getColumn() != null)
sb.append("Column: ").append(getColumn()).append(",");
if (getDateGranularity() != null)
sb.append("DateGranularity: ").append(getDateGranularity()).append(",");
if (getHierarchyId() != null)
sb.append("HierarchyId: ").append(getHierarchyId()).append(",");
if (getFormatConfiguration() != null)
sb.append("FormatConfiguration: ").append(getFormatConfiguration());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DateDimensionField == false)
return false;
DateDimensionField other = (DateDimensionField) obj;
if (other.getFieldId() == null ^ this.getFieldId() == null)
return false;
if (other.getFieldId() != null && other.getFieldId().equals(this.getFieldId()) == false)
return false;
if (other.getColumn() == null ^ this.getColumn() == null)
return false;
if (other.getColumn() != null && other.getColumn().equals(this.getColumn()) == false)
return false;
if (other.getDateGranularity() == null ^ this.getDateGranularity() == null)
return false;
if (other.getDateGranularity() != null && other.getDateGranularity().equals(this.getDateGranularity()) == false)
return false;
if (other.getHierarchyId() == null ^ this.getHierarchyId() == null)
return false;
if (other.getHierarchyId() != null && other.getHierarchyId().equals(this.getHierarchyId()) == false)
return false;
if (other.getFormatConfiguration() == null ^ this.getFormatConfiguration() == null)
return false;
if (other.getFormatConfiguration() != null && other.getFormatConfiguration().equals(this.getFormatConfiguration()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getFieldId() == null) ? 0 : getFieldId().hashCode());
hashCode = prime * hashCode + ((getColumn() == null) ? 0 : getColumn().hashCode());
hashCode = prime * hashCode + ((getDateGranularity() == null) ? 0 : getDateGranularity().hashCode());
hashCode = prime * hashCode + ((getHierarchyId() == null) ? 0 : getHierarchyId().hashCode());
hashCode = prime * hashCode + ((getFormatConfiguration() == null) ? 0 : getFormatConfiguration().hashCode());
return hashCode;
}
@Override
public DateDimensionField clone() {
try {
return (DateDimensionField) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.quicksight.model.transform.DateDimensionFieldMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}