com.amazonaws.services.quicksight.model.PeriodToDateComputation Maven / Gradle / Ivy
Show all versions of aws-java-sdk-quicksight Show documentation
/*
* Copyright 2018-2023 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 period to date computation configuration.
*
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class PeriodToDateComputation implements Serializable, Cloneable, StructuredPojo {
/**
*
* The ID for a computation.
*
*/
private String computationId;
/**
*
* The name of a computation.
*
*/
private String name;
/**
*
* The time field that is used in a computation.
*
*/
private DimensionField time;
/**
*
* The value field that is used in a computation.
*
*/
private MeasureField value;
/**
*
* The time granularity setup of period to date computation. Choose from the following options:
*
*
* -
*
* YEAR: Year to date.
*
*
* -
*
* MONTH: Month to date.
*
*
*
*/
private String periodTimeGranularity;
/**
*
* The ID for a computation.
*
*
* @param computationId
* The ID for a computation.
*/
public void setComputationId(String computationId) {
this.computationId = computationId;
}
/**
*
* The ID for a computation.
*
*
* @return The ID for a computation.
*/
public String getComputationId() {
return this.computationId;
}
/**
*
* The ID for a computation.
*
*
* @param computationId
* The ID for a computation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PeriodToDateComputation withComputationId(String computationId) {
setComputationId(computationId);
return this;
}
/**
*
* The name of a computation.
*
*
* @param name
* The name of a computation.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The name of a computation.
*
*
* @return The name of a computation.
*/
public String getName() {
return this.name;
}
/**
*
* The name of a computation.
*
*
* @param name
* The name of a computation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PeriodToDateComputation withName(String name) {
setName(name);
return this;
}
/**
*
* The time field that is used in a computation.
*
*
* @param time
* The time field that is used in a computation.
*/
public void setTime(DimensionField time) {
this.time = time;
}
/**
*
* The time field that is used in a computation.
*
*
* @return The time field that is used in a computation.
*/
public DimensionField getTime() {
return this.time;
}
/**
*
* The time field that is used in a computation.
*
*
* @param time
* The time field that is used in a computation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PeriodToDateComputation withTime(DimensionField time) {
setTime(time);
return this;
}
/**
*
* The value field that is used in a computation.
*
*
* @param value
* The value field that is used in a computation.
*/
public void setValue(MeasureField value) {
this.value = value;
}
/**
*
* The value field that is used in a computation.
*
*
* @return The value field that is used in a computation.
*/
public MeasureField getValue() {
return this.value;
}
/**
*
* The value field that is used in a computation.
*
*
* @param value
* The value field that is used in a computation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PeriodToDateComputation withValue(MeasureField value) {
setValue(value);
return this;
}
/**
*
* The time granularity setup of period to date computation. Choose from the following options:
*
*
* -
*
* YEAR: Year to date.
*
*
* -
*
* MONTH: Month to date.
*
*
*
*
* @param periodTimeGranularity
* The time granularity setup of period to date computation. Choose from the following options:
*
* -
*
* YEAR: Year to date.
*
*
* -
*
* MONTH: Month to date.
*
*
* @see TimeGranularity
*/
public void setPeriodTimeGranularity(String periodTimeGranularity) {
this.periodTimeGranularity = periodTimeGranularity;
}
/**
*
* The time granularity setup of period to date computation. Choose from the following options:
*
*
* -
*
* YEAR: Year to date.
*
*
* -
*
* MONTH: Month to date.
*
*
*
*
* @return The time granularity setup of period to date computation. Choose from the following options:
*
* -
*
* YEAR: Year to date.
*
*
* -
*
* MONTH: Month to date.
*
*
* @see TimeGranularity
*/
public String getPeriodTimeGranularity() {
return this.periodTimeGranularity;
}
/**
*
* The time granularity setup of period to date computation. Choose from the following options:
*
*
* -
*
* YEAR: Year to date.
*
*
* -
*
* MONTH: Month to date.
*
*
*
*
* @param periodTimeGranularity
* The time granularity setup of period to date computation. Choose from the following options:
*
* -
*
* YEAR: Year to date.
*
*
* -
*
* MONTH: Month to date.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see TimeGranularity
*/
public PeriodToDateComputation withPeriodTimeGranularity(String periodTimeGranularity) {
setPeriodTimeGranularity(periodTimeGranularity);
return this;
}
/**
*
* The time granularity setup of period to date computation. Choose from the following options:
*
*
* -
*
* YEAR: Year to date.
*
*
* -
*
* MONTH: Month to date.
*
*
*
*
* @param periodTimeGranularity
* The time granularity setup of period to date computation. Choose from the following options:
*
* -
*
* YEAR: Year to date.
*
*
* -
*
* MONTH: Month to date.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see TimeGranularity
*/
public PeriodToDateComputation withPeriodTimeGranularity(TimeGranularity periodTimeGranularity) {
this.periodTimeGranularity = periodTimeGranularity.toString();
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 (getComputationId() != null)
sb.append("ComputationId: ").append(getComputationId()).append(",");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getTime() != null)
sb.append("Time: ").append(getTime()).append(",");
if (getValue() != null)
sb.append("Value: ").append(getValue()).append(",");
if (getPeriodTimeGranularity() != null)
sb.append("PeriodTimeGranularity: ").append(getPeriodTimeGranularity());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof PeriodToDateComputation == false)
return false;
PeriodToDateComputation other = (PeriodToDateComputation) obj;
if (other.getComputationId() == null ^ this.getComputationId() == null)
return false;
if (other.getComputationId() != null && other.getComputationId().equals(this.getComputationId()) == false)
return false;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getTime() == null ^ this.getTime() == null)
return false;
if (other.getTime() != null && other.getTime().equals(this.getTime()) == false)
return false;
if (other.getValue() == null ^ this.getValue() == null)
return false;
if (other.getValue() != null && other.getValue().equals(this.getValue()) == false)
return false;
if (other.getPeriodTimeGranularity() == null ^ this.getPeriodTimeGranularity() == null)
return false;
if (other.getPeriodTimeGranularity() != null && other.getPeriodTimeGranularity().equals(this.getPeriodTimeGranularity()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getComputationId() == null) ? 0 : getComputationId().hashCode());
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getTime() == null) ? 0 : getTime().hashCode());
hashCode = prime * hashCode + ((getValue() == null) ? 0 : getValue().hashCode());
hashCode = prime * hashCode + ((getPeriodTimeGranularity() == null) ? 0 : getPeriodTimeGranularity().hashCode());
return hashCode;
}
@Override
public PeriodToDateComputation clone() {
try {
return (PeriodToDateComputation) 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.PeriodToDateComputationMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}