com.amazonaws.services.quicksight.model.AnalysisDefinition 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 definition of an analysis.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class AnalysisDefinition implements Serializable, Cloneable, StructuredPojo {
/**
*
* An array of dataset identifier declarations. This mapping allows the usage of dataset identifiers instead of
* dataset ARNs throughout analysis sub-structures.
*
*/
private java.util.List dataSetIdentifierDeclarations;
/**
*
* An array of sheet definitions for an analysis. Each SheetDefinition provides detailed information
* about a sheet within this analysis.
*
*/
private java.util.List sheets;
/**
*
* An array of calculated field definitions for the analysis.
*
*/
private java.util.List calculatedFields;
/**
*
* An array of parameter declarations for an analysis.
*
*
* Parameters are named variables that can transfer a value for use by an action or an object.
*
*
* For more information, see Parameters in Amazon
* QuickSight in the Amazon QuickSight User Guide.
*
*/
private java.util.List parameterDeclarations;
/**
*
* Filter definitions for an analysis.
*
*
* For more information, see Filtering Data in Amazon
* QuickSight in the Amazon QuickSight User Guide.
*
*/
private java.util.List filterGroups;
/**
*
* An array of analysis-level column configurations. Column configurations can be used to set default formatting for
* a column to be used throughout an analysis.
*
*/
private java.util.List columnConfigurations;
private AnalysisDefaults analysisDefaults;
/**
*
* An array of option definitions for an analysis.
*
*/
private AssetOptions options;
/**
*
* An array of dataset identifier declarations. This mapping allows the usage of dataset identifiers instead of
* dataset ARNs throughout analysis sub-structures.
*
*
* @return An array of dataset identifier declarations. This mapping allows the usage of dataset identifiers instead
* of dataset ARNs throughout analysis sub-structures.
*/
public java.util.List getDataSetIdentifierDeclarations() {
return dataSetIdentifierDeclarations;
}
/**
*
* An array of dataset identifier declarations. This mapping allows the usage of dataset identifiers instead of
* dataset ARNs throughout analysis sub-structures.
*
*
* @param dataSetIdentifierDeclarations
* An array of dataset identifier declarations. This mapping allows the usage of dataset identifiers instead
* of dataset ARNs throughout analysis sub-structures.
*/
public void setDataSetIdentifierDeclarations(java.util.Collection dataSetIdentifierDeclarations) {
if (dataSetIdentifierDeclarations == null) {
this.dataSetIdentifierDeclarations = null;
return;
}
this.dataSetIdentifierDeclarations = new java.util.ArrayList(dataSetIdentifierDeclarations);
}
/**
*
* An array of dataset identifier declarations. This mapping allows the usage of dataset identifiers instead of
* dataset ARNs throughout analysis sub-structures.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setDataSetIdentifierDeclarations(java.util.Collection)} or
* {@link #withDataSetIdentifierDeclarations(java.util.Collection)} if you want to override the existing values.
*
*
* @param dataSetIdentifierDeclarations
* An array of dataset identifier declarations. This mapping allows the usage of dataset identifiers instead
* of dataset ARNs throughout analysis sub-structures.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AnalysisDefinition withDataSetIdentifierDeclarations(DataSetIdentifierDeclaration... dataSetIdentifierDeclarations) {
if (this.dataSetIdentifierDeclarations == null) {
setDataSetIdentifierDeclarations(new java.util.ArrayList(dataSetIdentifierDeclarations.length));
}
for (DataSetIdentifierDeclaration ele : dataSetIdentifierDeclarations) {
this.dataSetIdentifierDeclarations.add(ele);
}
return this;
}
/**
*
* An array of dataset identifier declarations. This mapping allows the usage of dataset identifiers instead of
* dataset ARNs throughout analysis sub-structures.
*
*
* @param dataSetIdentifierDeclarations
* An array of dataset identifier declarations. This mapping allows the usage of dataset identifiers instead
* of dataset ARNs throughout analysis sub-structures.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AnalysisDefinition withDataSetIdentifierDeclarations(java.util.Collection dataSetIdentifierDeclarations) {
setDataSetIdentifierDeclarations(dataSetIdentifierDeclarations);
return this;
}
/**
*
* An array of sheet definitions for an analysis. Each SheetDefinition provides detailed information
* about a sheet within this analysis.
*
*
* @return An array of sheet definitions for an analysis. Each SheetDefinition provides detailed
* information about a sheet within this analysis.
*/
public java.util.List getSheets() {
return sheets;
}
/**
*
* An array of sheet definitions for an analysis. Each SheetDefinition provides detailed information
* about a sheet within this analysis.
*
*
* @param sheets
* An array of sheet definitions for an analysis. Each SheetDefinition provides detailed
* information about a sheet within this analysis.
*/
public void setSheets(java.util.Collection sheets) {
if (sheets == null) {
this.sheets = null;
return;
}
this.sheets = new java.util.ArrayList(sheets);
}
/**
*
* An array of sheet definitions for an analysis. Each SheetDefinition provides detailed information
* about a sheet within this analysis.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setSheets(java.util.Collection)} or {@link #withSheets(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param sheets
* An array of sheet definitions for an analysis. Each SheetDefinition provides detailed
* information about a sheet within this analysis.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AnalysisDefinition withSheets(SheetDefinition... sheets) {
if (this.sheets == null) {
setSheets(new java.util.ArrayList(sheets.length));
}
for (SheetDefinition ele : sheets) {
this.sheets.add(ele);
}
return this;
}
/**
*
* An array of sheet definitions for an analysis. Each SheetDefinition provides detailed information
* about a sheet within this analysis.
*
*
* @param sheets
* An array of sheet definitions for an analysis. Each SheetDefinition provides detailed
* information about a sheet within this analysis.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AnalysisDefinition withSheets(java.util.Collection sheets) {
setSheets(sheets);
return this;
}
/**
*
* An array of calculated field definitions for the analysis.
*
*
* @return An array of calculated field definitions for the analysis.
*/
public java.util.List getCalculatedFields() {
return calculatedFields;
}
/**
*
* An array of calculated field definitions for the analysis.
*
*
* @param calculatedFields
* An array of calculated field definitions for the analysis.
*/
public void setCalculatedFields(java.util.Collection calculatedFields) {
if (calculatedFields == null) {
this.calculatedFields = null;
return;
}
this.calculatedFields = new java.util.ArrayList(calculatedFields);
}
/**
*
* An array of calculated field definitions for the analysis.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setCalculatedFields(java.util.Collection)} or {@link #withCalculatedFields(java.util.Collection)} if you
* want to override the existing values.
*
*
* @param calculatedFields
* An array of calculated field definitions for the analysis.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AnalysisDefinition withCalculatedFields(CalculatedField... calculatedFields) {
if (this.calculatedFields == null) {
setCalculatedFields(new java.util.ArrayList(calculatedFields.length));
}
for (CalculatedField ele : calculatedFields) {
this.calculatedFields.add(ele);
}
return this;
}
/**
*
* An array of calculated field definitions for the analysis.
*
*
* @param calculatedFields
* An array of calculated field definitions for the analysis.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AnalysisDefinition withCalculatedFields(java.util.Collection calculatedFields) {
setCalculatedFields(calculatedFields);
return this;
}
/**
*
* An array of parameter declarations for an analysis.
*
*
* Parameters are named variables that can transfer a value for use by an action or an object.
*
*
* For more information, see Parameters in Amazon
* QuickSight in the Amazon QuickSight User Guide.
*
*
* @return An array of parameter declarations for an analysis.
*
* Parameters are named variables that can transfer a value for use by an action or an object.
*
*
* For more information, see Parameters in
* Amazon QuickSight in the Amazon QuickSight User Guide.
*/
public java.util.List getParameterDeclarations() {
return parameterDeclarations;
}
/**
*
* An array of parameter declarations for an analysis.
*
*
* Parameters are named variables that can transfer a value for use by an action or an object.
*
*
* For more information, see Parameters in Amazon
* QuickSight in the Amazon QuickSight User Guide.
*
*
* @param parameterDeclarations
* An array of parameter declarations for an analysis.
*
* Parameters are named variables that can transfer a value for use by an action or an object.
*
*
* For more information, see Parameters in
* Amazon QuickSight in the Amazon QuickSight User Guide.
*/
public void setParameterDeclarations(java.util.Collection parameterDeclarations) {
if (parameterDeclarations == null) {
this.parameterDeclarations = null;
return;
}
this.parameterDeclarations = new java.util.ArrayList(parameterDeclarations);
}
/**
*
* An array of parameter declarations for an analysis.
*
*
* Parameters are named variables that can transfer a value for use by an action or an object.
*
*
* For more information, see Parameters in Amazon
* QuickSight in the Amazon QuickSight User Guide.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setParameterDeclarations(java.util.Collection)} or
* {@link #withParameterDeclarations(java.util.Collection)} if you want to override the existing values.
*
*
* @param parameterDeclarations
* An array of parameter declarations for an analysis.
*
* Parameters are named variables that can transfer a value for use by an action or an object.
*
*
* For more information, see Parameters in
* Amazon QuickSight in the Amazon QuickSight User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AnalysisDefinition withParameterDeclarations(ParameterDeclaration... parameterDeclarations) {
if (this.parameterDeclarations == null) {
setParameterDeclarations(new java.util.ArrayList(parameterDeclarations.length));
}
for (ParameterDeclaration ele : parameterDeclarations) {
this.parameterDeclarations.add(ele);
}
return this;
}
/**
*
* An array of parameter declarations for an analysis.
*
*
* Parameters are named variables that can transfer a value for use by an action or an object.
*
*
* For more information, see Parameters in Amazon
* QuickSight in the Amazon QuickSight User Guide.
*
*
* @param parameterDeclarations
* An array of parameter declarations for an analysis.
*
* Parameters are named variables that can transfer a value for use by an action or an object.
*
*
* For more information, see Parameters in
* Amazon QuickSight in the Amazon QuickSight User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AnalysisDefinition withParameterDeclarations(java.util.Collection parameterDeclarations) {
setParameterDeclarations(parameterDeclarations);
return this;
}
/**
*
* Filter definitions for an analysis.
*
*
* For more information, see Filtering Data in Amazon
* QuickSight in the Amazon QuickSight User Guide.
*
*
* @return Filter definitions for an analysis.
*
* For more information, see Filtering Data in Amazon
* QuickSight in the Amazon QuickSight User Guide.
*/
public java.util.List getFilterGroups() {
return filterGroups;
}
/**
*
* Filter definitions for an analysis.
*
*
* For more information, see Filtering Data in Amazon
* QuickSight in the Amazon QuickSight User Guide.
*
*
* @param filterGroups
* Filter definitions for an analysis.
*
* For more information, see Filtering Data in Amazon
* QuickSight in the Amazon QuickSight User Guide.
*/
public void setFilterGroups(java.util.Collection filterGroups) {
if (filterGroups == null) {
this.filterGroups = null;
return;
}
this.filterGroups = new java.util.ArrayList(filterGroups);
}
/**
*
* Filter definitions for an analysis.
*
*
* For more information, see Filtering Data in Amazon
* QuickSight in the Amazon QuickSight User Guide.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setFilterGroups(java.util.Collection)} or {@link #withFilterGroups(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param filterGroups
* Filter definitions for an analysis.
*
* For more information, see Filtering Data in Amazon
* QuickSight in the Amazon QuickSight User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AnalysisDefinition withFilterGroups(FilterGroup... filterGroups) {
if (this.filterGroups == null) {
setFilterGroups(new java.util.ArrayList(filterGroups.length));
}
for (FilterGroup ele : filterGroups) {
this.filterGroups.add(ele);
}
return this;
}
/**
*
* Filter definitions for an analysis.
*
*
* For more information, see Filtering Data in Amazon
* QuickSight in the Amazon QuickSight User Guide.
*
*
* @param filterGroups
* Filter definitions for an analysis.
*
* For more information, see Filtering Data in Amazon
* QuickSight in the Amazon QuickSight User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AnalysisDefinition withFilterGroups(java.util.Collection filterGroups) {
setFilterGroups(filterGroups);
return this;
}
/**
*
* An array of analysis-level column configurations. Column configurations can be used to set default formatting for
* a column to be used throughout an analysis.
*
*
* @return An array of analysis-level column configurations. Column configurations can be used to set default
* formatting for a column to be used throughout an analysis.
*/
public java.util.List getColumnConfigurations() {
return columnConfigurations;
}
/**
*
* An array of analysis-level column configurations. Column configurations can be used to set default formatting for
* a column to be used throughout an analysis.
*
*
* @param columnConfigurations
* An array of analysis-level column configurations. Column configurations can be used to set default
* formatting for a column to be used throughout an analysis.
*/
public void setColumnConfigurations(java.util.Collection columnConfigurations) {
if (columnConfigurations == null) {
this.columnConfigurations = null;
return;
}
this.columnConfigurations = new java.util.ArrayList(columnConfigurations);
}
/**
*
* An array of analysis-level column configurations. Column configurations can be used to set default formatting for
* a column to be used throughout an analysis.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setColumnConfigurations(java.util.Collection)} or {@link #withColumnConfigurations(java.util.Collection)}
* if you want to override the existing values.
*
*
* @param columnConfigurations
* An array of analysis-level column configurations. Column configurations can be used to set default
* formatting for a column to be used throughout an analysis.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AnalysisDefinition withColumnConfigurations(ColumnConfiguration... columnConfigurations) {
if (this.columnConfigurations == null) {
setColumnConfigurations(new java.util.ArrayList(columnConfigurations.length));
}
for (ColumnConfiguration ele : columnConfigurations) {
this.columnConfigurations.add(ele);
}
return this;
}
/**
*
* An array of analysis-level column configurations. Column configurations can be used to set default formatting for
* a column to be used throughout an analysis.
*
*
* @param columnConfigurations
* An array of analysis-level column configurations. Column configurations can be used to set default
* formatting for a column to be used throughout an analysis.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AnalysisDefinition withColumnConfigurations(java.util.Collection columnConfigurations) {
setColumnConfigurations(columnConfigurations);
return this;
}
/**
* @param analysisDefaults
*/
public void setAnalysisDefaults(AnalysisDefaults analysisDefaults) {
this.analysisDefaults = analysisDefaults;
}
/**
* @return
*/
public AnalysisDefaults getAnalysisDefaults() {
return this.analysisDefaults;
}
/**
* @param analysisDefaults
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AnalysisDefinition withAnalysisDefaults(AnalysisDefaults analysisDefaults) {
setAnalysisDefaults(analysisDefaults);
return this;
}
/**
*
* An array of option definitions for an analysis.
*
*
* @param options
* An array of option definitions for an analysis.
*/
public void setOptions(AssetOptions options) {
this.options = options;
}
/**
*
* An array of option definitions for an analysis.
*
*
* @return An array of option definitions for an analysis.
*/
public AssetOptions getOptions() {
return this.options;
}
/**
*
* An array of option definitions for an analysis.
*
*
* @param options
* An array of option definitions for an analysis.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AnalysisDefinition withOptions(AssetOptions options) {
setOptions(options);
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 (getDataSetIdentifierDeclarations() != null)
sb.append("DataSetIdentifierDeclarations: ").append(getDataSetIdentifierDeclarations()).append(",");
if (getSheets() != null)
sb.append("Sheets: ").append(getSheets()).append(",");
if (getCalculatedFields() != null)
sb.append("CalculatedFields: ").append(getCalculatedFields()).append(",");
if (getParameterDeclarations() != null)
sb.append("ParameterDeclarations: ").append(getParameterDeclarations()).append(",");
if (getFilterGroups() != null)
sb.append("FilterGroups: ").append(getFilterGroups()).append(",");
if (getColumnConfigurations() != null)
sb.append("ColumnConfigurations: ").append(getColumnConfigurations()).append(",");
if (getAnalysisDefaults() != null)
sb.append("AnalysisDefaults: ").append(getAnalysisDefaults()).append(",");
if (getOptions() != null)
sb.append("Options: ").append(getOptions());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof AnalysisDefinition == false)
return false;
AnalysisDefinition other = (AnalysisDefinition) obj;
if (other.getDataSetIdentifierDeclarations() == null ^ this.getDataSetIdentifierDeclarations() == null)
return false;
if (other.getDataSetIdentifierDeclarations() != null
&& other.getDataSetIdentifierDeclarations().equals(this.getDataSetIdentifierDeclarations()) == false)
return false;
if (other.getSheets() == null ^ this.getSheets() == null)
return false;
if (other.getSheets() != null && other.getSheets().equals(this.getSheets()) == false)
return false;
if (other.getCalculatedFields() == null ^ this.getCalculatedFields() == null)
return false;
if (other.getCalculatedFields() != null && other.getCalculatedFields().equals(this.getCalculatedFields()) == false)
return false;
if (other.getParameterDeclarations() == null ^ this.getParameterDeclarations() == null)
return false;
if (other.getParameterDeclarations() != null && other.getParameterDeclarations().equals(this.getParameterDeclarations()) == false)
return false;
if (other.getFilterGroups() == null ^ this.getFilterGroups() == null)
return false;
if (other.getFilterGroups() != null && other.getFilterGroups().equals(this.getFilterGroups()) == false)
return false;
if (other.getColumnConfigurations() == null ^ this.getColumnConfigurations() == null)
return false;
if (other.getColumnConfigurations() != null && other.getColumnConfigurations().equals(this.getColumnConfigurations()) == false)
return false;
if (other.getAnalysisDefaults() == null ^ this.getAnalysisDefaults() == null)
return false;
if (other.getAnalysisDefaults() != null && other.getAnalysisDefaults().equals(this.getAnalysisDefaults()) == false)
return false;
if (other.getOptions() == null ^ this.getOptions() == null)
return false;
if (other.getOptions() != null && other.getOptions().equals(this.getOptions()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getDataSetIdentifierDeclarations() == null) ? 0 : getDataSetIdentifierDeclarations().hashCode());
hashCode = prime * hashCode + ((getSheets() == null) ? 0 : getSheets().hashCode());
hashCode = prime * hashCode + ((getCalculatedFields() == null) ? 0 : getCalculatedFields().hashCode());
hashCode = prime * hashCode + ((getParameterDeclarations() == null) ? 0 : getParameterDeclarations().hashCode());
hashCode = prime * hashCode + ((getFilterGroups() == null) ? 0 : getFilterGroups().hashCode());
hashCode = prime * hashCode + ((getColumnConfigurations() == null) ? 0 : getColumnConfigurations().hashCode());
hashCode = prime * hashCode + ((getAnalysisDefaults() == null) ? 0 : getAnalysisDefaults().hashCode());
hashCode = prime * hashCode + ((getOptions() == null) ? 0 : getOptions().hashCode());
return hashCode;
}
@Override
public AnalysisDefinition clone() {
try {
return (AnalysisDefinition) 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.AnalysisDefinitionMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}