com.amazonaws.services.quicksight.model.DateTimeParameterDeclaration 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;
/**
*
* A parameter declaration for the DateTime
data type.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DateTimeParameterDeclaration implements Serializable, Cloneable, StructuredPojo {
/**
*
* The name of the parameter that is being declared.
*
*/
private String name;
/**
*
* The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value
* can be provided.
*
*/
private DateTimeDefaultValues defaultValues;
/**
*
* The level of time precision that is used to aggregate DateTime
values.
*
*/
private String timeGranularity;
/**
*
* The configuration that defines the default value of a DateTime
parameter when a value has not been
* set.
*
*/
private DateTimeValueWhenUnsetConfiguration valueWhenUnset;
private java.util.List mappedDataSetParameters;
/**
*
* The name of the parameter that is being declared.
*
*
* @param name
* The name of the parameter that is being declared.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The name of the parameter that is being declared.
*
*
* @return The name of the parameter that is being declared.
*/
public String getName() {
return this.name;
}
/**
*
* The name of the parameter that is being declared.
*
*
* @param name
* The name of the parameter that is being declared.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DateTimeParameterDeclaration withName(String name) {
setName(name);
return this;
}
/**
*
* The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value
* can be provided.
*
*
* @param defaultValues
* The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default
* value can be provided.
*/
public void setDefaultValues(DateTimeDefaultValues defaultValues) {
this.defaultValues = defaultValues;
}
/**
*
* The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value
* can be provided.
*
*
* @return The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default
* value can be provided.
*/
public DateTimeDefaultValues getDefaultValues() {
return this.defaultValues;
}
/**
*
* The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value
* can be provided.
*
*
* @param defaultValues
* The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default
* value can be provided.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DateTimeParameterDeclaration withDefaultValues(DateTimeDefaultValues defaultValues) {
setDefaultValues(defaultValues);
return this;
}
/**
*
* The level of time precision that is used to aggregate DateTime
values.
*
*
* @param timeGranularity
* The level of time precision that is used to aggregate DateTime
values.
* @see TimeGranularity
*/
public void setTimeGranularity(String timeGranularity) {
this.timeGranularity = timeGranularity;
}
/**
*
* The level of time precision that is used to aggregate DateTime
values.
*
*
* @return The level of time precision that is used to aggregate DateTime
values.
* @see TimeGranularity
*/
public String getTimeGranularity() {
return this.timeGranularity;
}
/**
*
* The level of time precision that is used to aggregate DateTime
values.
*
*
* @param timeGranularity
* The level of time precision that is used to aggregate DateTime
values.
* @return Returns a reference to this object so that method calls can be chained together.
* @see TimeGranularity
*/
public DateTimeParameterDeclaration withTimeGranularity(String timeGranularity) {
setTimeGranularity(timeGranularity);
return this;
}
/**
*
* The level of time precision that is used to aggregate DateTime
values.
*
*
* @param timeGranularity
* The level of time precision that is used to aggregate DateTime
values.
* @return Returns a reference to this object so that method calls can be chained together.
* @see TimeGranularity
*/
public DateTimeParameterDeclaration withTimeGranularity(TimeGranularity timeGranularity) {
this.timeGranularity = timeGranularity.toString();
return this;
}
/**
*
* The configuration that defines the default value of a DateTime
parameter when a value has not been
* set.
*
*
* @param valueWhenUnset
* The configuration that defines the default value of a DateTime
parameter when a value has not
* been set.
*/
public void setValueWhenUnset(DateTimeValueWhenUnsetConfiguration valueWhenUnset) {
this.valueWhenUnset = valueWhenUnset;
}
/**
*
* The configuration that defines the default value of a DateTime
parameter when a value has not been
* set.
*
*
* @return The configuration that defines the default value of a DateTime
parameter when a value has
* not been set.
*/
public DateTimeValueWhenUnsetConfiguration getValueWhenUnset() {
return this.valueWhenUnset;
}
/**
*
* The configuration that defines the default value of a DateTime
parameter when a value has not been
* set.
*
*
* @param valueWhenUnset
* The configuration that defines the default value of a DateTime
parameter when a value has not
* been set.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DateTimeParameterDeclaration withValueWhenUnset(DateTimeValueWhenUnsetConfiguration valueWhenUnset) {
setValueWhenUnset(valueWhenUnset);
return this;
}
/**
* @return
*/
public java.util.List getMappedDataSetParameters() {
return mappedDataSetParameters;
}
/**
* @param mappedDataSetParameters
*/
public void setMappedDataSetParameters(java.util.Collection mappedDataSetParameters) {
if (mappedDataSetParameters == null) {
this.mappedDataSetParameters = null;
return;
}
this.mappedDataSetParameters = new java.util.ArrayList(mappedDataSetParameters);
}
/**
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setMappedDataSetParameters(java.util.Collection)} or
* {@link #withMappedDataSetParameters(java.util.Collection)} if you want to override the existing values.
*
*
* @param mappedDataSetParameters
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DateTimeParameterDeclaration withMappedDataSetParameters(MappedDataSetParameter... mappedDataSetParameters) {
if (this.mappedDataSetParameters == null) {
setMappedDataSetParameters(new java.util.ArrayList(mappedDataSetParameters.length));
}
for (MappedDataSetParameter ele : mappedDataSetParameters) {
this.mappedDataSetParameters.add(ele);
}
return this;
}
/**
* @param mappedDataSetParameters
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DateTimeParameterDeclaration withMappedDataSetParameters(java.util.Collection mappedDataSetParameters) {
setMappedDataSetParameters(mappedDataSetParameters);
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 (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getDefaultValues() != null)
sb.append("DefaultValues: ").append(getDefaultValues()).append(",");
if (getTimeGranularity() != null)
sb.append("TimeGranularity: ").append(getTimeGranularity()).append(",");
if (getValueWhenUnset() != null)
sb.append("ValueWhenUnset: ").append(getValueWhenUnset()).append(",");
if (getMappedDataSetParameters() != null)
sb.append("MappedDataSetParameters: ").append(getMappedDataSetParameters());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DateTimeParameterDeclaration == false)
return false;
DateTimeParameterDeclaration other = (DateTimeParameterDeclaration) obj;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getDefaultValues() == null ^ this.getDefaultValues() == null)
return false;
if (other.getDefaultValues() != null && other.getDefaultValues().equals(this.getDefaultValues()) == false)
return false;
if (other.getTimeGranularity() == null ^ this.getTimeGranularity() == null)
return false;
if (other.getTimeGranularity() != null && other.getTimeGranularity().equals(this.getTimeGranularity()) == false)
return false;
if (other.getValueWhenUnset() == null ^ this.getValueWhenUnset() == null)
return false;
if (other.getValueWhenUnset() != null && other.getValueWhenUnset().equals(this.getValueWhenUnset()) == false)
return false;
if (other.getMappedDataSetParameters() == null ^ this.getMappedDataSetParameters() == null)
return false;
if (other.getMappedDataSetParameters() != null && other.getMappedDataSetParameters().equals(this.getMappedDataSetParameters()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getDefaultValues() == null) ? 0 : getDefaultValues().hashCode());
hashCode = prime * hashCode + ((getTimeGranularity() == null) ? 0 : getTimeGranularity().hashCode());
hashCode = prime * hashCode + ((getValueWhenUnset() == null) ? 0 : getValueWhenUnset().hashCode());
hashCode = prime * hashCode + ((getMappedDataSetParameters() == null) ? 0 : getMappedDataSetParameters().hashCode());
return hashCode;
}
@Override
public DateTimeParameterDeclaration clone() {
try {
return (DateTimeParameterDeclaration) 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.DateTimeParameterDeclarationMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}