/* * 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 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
* An array of sheet definitions for an analysis. Each SheetDefinition
provides detailed information
* about a sheet within this analysis.
*
* An array of calculated field definitions for the analysis. *
*/ private java.util.List* 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* Filter definitions for an analysis. *
** For more information, see Filtering Data in Amazon * QuickSight in the Amazon QuickSight User Guide. *
*/ private java.util.List* 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* 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* 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* 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* 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
* An array of sheet definitions for an analysis. Each SheetDefinition
provides detailed information
* about a sheet within this analysis.
*
SheetDefinition
provides detailed
* information about a sheet within this analysis.
*/
public java.util.List
* An array of sheet definitions for an analysis. Each SheetDefinition
provides detailed information
* about a sheet within this analysis.
*
SheetDefinition
provides detailed
* information about a sheet within this analysis.
*/
public void setSheets(java.util.Collection
* 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. EachSheetDefinition
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
* An array of sheet definitions for an analysis. Each SheetDefinition
provides detailed information
* about a sheet within this analysis.
*
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* An array of calculated field definitions for the analysis. *
* * @return An array of calculated field definitions for the analysis. */ public java.util.List* 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* 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* 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* 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
* 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.
*
* 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
* 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.
*
* 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
* 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.
*
* 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
* Filter definitions for an analysis.
*
* For more information, see Filtering Data in Amazon
* QuickSight in the Amazon QuickSight User Guide.
*
* For more information, see Filtering Data in Amazon
* QuickSight in the Amazon QuickSight User Guide.
*/
public java.util.List
* Filter definitions for an analysis.
*
* For more information, see Filtering Data in Amazon
* QuickSight in the Amazon QuickSight User Guide.
*
* For more information, see Filtering Data in Amazon
* QuickSight in the Amazon QuickSight User Guide.
*/
public void setFilterGroups(java.util.Collection
* 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.
*
* 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
* Filter definitions for an analysis.
*
* For more information, see Filtering Data in Amazon
* QuickSight in the Amazon QuickSight User Guide.
*
* 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
* 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.
*
* 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.
*
* 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.
*
* 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.
*