AnalysisDefinition (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.quicksight.model.AnalysisDefinition

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AnalysisDefinition
extends Object
implements Serializable, Cloneable, StructuredPojo

The definition of an analysis.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AnalysisDefinition()

Constructors
Constructor and Description
`AnalysisDefinition()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AnalysisDefinition`	`clone()`
`boolean`	`equals(Object obj)`
`AnalysisDefaults`	`getAnalysisDefaults()`
`List<CalculatedField>`	`getCalculatedFields()` An array of calculated field definitions for the analysis.
`List<ColumnConfiguration>`	`getColumnConfigurations()` An array of analysis-level column configurations.
`List<DataSetIdentifierDeclaration>`	`getDataSetIdentifierDeclarations()` An array of dataset identifier declarations.
`List<FilterGroup>`	`getFilterGroups()` Filter definitions for an analysis.
`List<ParameterDeclaration>`	`getParameterDeclarations()` An array of parameter declarations for an analysis.
`List<SheetDefinition>`	`getSheets()` An array of sheet definitions for an analysis.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAnalysisDefaults(AnalysisDefaults analysisDefaults)`
`void`	`setCalculatedFields(Collection<CalculatedField> calculatedFields)` An array of calculated field definitions for the analysis.
`void`	`setColumnConfigurations(Collection<ColumnConfiguration> columnConfigurations)` An array of analysis-level column configurations.
`void`	`setDataSetIdentifierDeclarations(Collection<DataSetIdentifierDeclaration> dataSetIdentifierDeclarations)` An array of dataset identifier declarations.
`void`	`setFilterGroups(Collection<FilterGroup> filterGroups)` Filter definitions for an analysis.
`void`	`setParameterDeclarations(Collection<ParameterDeclaration> parameterDeclarations)` An array of parameter declarations for an analysis.
`void`	`setSheets(Collection<SheetDefinition> sheets)` An array of sheet definitions for an analysis.
`String`	`toString()` Returns a string representation of this object.
`AnalysisDefinition`	`withAnalysisDefaults(AnalysisDefaults analysisDefaults)`
`AnalysisDefinition`	`withCalculatedFields(CalculatedField... calculatedFields)` An array of calculated field definitions for the analysis.
`AnalysisDefinition`	`withCalculatedFields(Collection<CalculatedField> calculatedFields)` An array of calculated field definitions for the analysis.
`AnalysisDefinition`	`withColumnConfigurations(Collection<ColumnConfiguration> columnConfigurations)` An array of analysis-level column configurations.
`AnalysisDefinition`	`withColumnConfigurations(ColumnConfiguration... columnConfigurations)` An array of analysis-level column configurations.
`AnalysisDefinition`	`withDataSetIdentifierDeclarations(Collection<DataSetIdentifierDeclaration> dataSetIdentifierDeclarations)` An array of dataset identifier declarations.
`AnalysisDefinition`	`withDataSetIdentifierDeclarations(DataSetIdentifierDeclaration... dataSetIdentifierDeclarations)` An array of dataset identifier declarations.
`AnalysisDefinition`	`withFilterGroups(Collection<FilterGroup> filterGroups)` Filter definitions for an analysis.
`AnalysisDefinition`	`withFilterGroups(FilterGroup... filterGroups)` Filter definitions for an analysis.
`AnalysisDefinition`	`withParameterDeclarations(Collection<ParameterDeclaration> parameterDeclarations)` An array of parameter declarations for an analysis.
`AnalysisDefinition`	`withParameterDeclarations(ParameterDeclaration... parameterDeclarations)` An array of parameter declarations for an analysis.
`AnalysisDefinition`	`withSheets(Collection<SheetDefinition> sheets)` An array of sheet definitions for an analysis.
`AnalysisDefinition`	`withSheets(SheetDefinition... sheets)` An array of sheet definitions for an analysis.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AnalysisDefinition
```
public AnalysisDefinition()
```
- Method Detail
  - getDataSetIdentifierDeclarations
```
public List<DataSetIdentifierDeclaration> getDataSetIdentifierDeclarations()
```
    An array of dataset identifier declarations. This mapping allows the usage of dataset identifiers instead of dataset ARNs throughout analysis sub-structures.
    
    Returns:
    
    An array of dataset identifier declarations. This mapping allows the usage of dataset identifiers instead of dataset ARNs throughout analysis sub-structures.
  - setDataSetIdentifierDeclarations
```
public void setDataSetIdentifierDeclarations(Collection<DataSetIdentifierDeclaration> dataSetIdentifierDeclarations)
```
    An array of dataset identifier declarations. This mapping allows the usage of dataset identifiers instead of dataset ARNs throughout analysis sub-structures.
    
    Parameters:
    
    dataSetIdentifierDeclarations - An array of dataset identifier declarations. This mapping allows the usage of dataset identifiers instead of dataset ARNs throughout analysis sub-structures.
  - withDataSetIdentifierDeclarations
```
public AnalysisDefinition withDataSetIdentifierDeclarations(DataSetIdentifierDeclaration... 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 setDataSetIdentifierDeclarations(java.util.Collection) or withDataSetIdentifierDeclarations(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    dataSetIdentifierDeclarations - An array of dataset identifier declarations. This mapping allows the usage of dataset identifiers instead of dataset ARNs throughout analysis sub-structures.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withDataSetIdentifierDeclarations
```
public AnalysisDefinition withDataSetIdentifierDeclarations(Collection<DataSetIdentifierDeclaration> dataSetIdentifierDeclarations)
```
    An array of dataset identifier declarations. This mapping allows the usage of dataset identifiers instead of dataset ARNs throughout analysis sub-structures.
    
    Parameters:
    
    dataSetIdentifierDeclarations - An array of dataset identifier declarations. This mapping allows the usage of dataset identifiers instead of dataset ARNs throughout analysis sub-structures.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSheets
```
public List<SheetDefinition> getSheets()
```
    An array of sheet definitions for an analysis. Each SheetDefinition provides detailed information about a sheet within this analysis.
    
    Returns:
    
    An array of sheet definitions for an analysis. Each SheetDefinition provides detailed information about a sheet within this analysis.
  - setSheets
```
public void setSheets(Collection<SheetDefinition> sheets)
```
    An array of sheet definitions for an analysis. Each SheetDefinition provides detailed information about a sheet within this analysis.
    
    Parameters:
    
    sheets - An array of sheet definitions for an analysis. Each SheetDefinition provides detailed information about a sheet within this analysis.
  - withSheets
```
public AnalysisDefinition withSheets(SheetDefinition... 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 setSheets(java.util.Collection) or withSheets(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    sheets - An array of sheet definitions for an analysis. Each SheetDefinition provides detailed information about a sheet within this analysis.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSheets
```
public AnalysisDefinition withSheets(Collection<SheetDefinition> sheets)
```
    An array of sheet definitions for an analysis. Each SheetDefinition provides detailed information about a sheet within this analysis.
    
    Parameters:
    
    sheets - An array of sheet definitions for an analysis. Each SheetDefinition provides detailed information about a sheet within this analysis.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getCalculatedFields
```
public List<CalculatedField> getCalculatedFields()
```
    An array of calculated field definitions for the analysis.
    
    Returns:
    
    An array of calculated field definitions for the analysis.
  - setCalculatedFields
```
public void setCalculatedFields(Collection<CalculatedField> calculatedFields)
```
    An array of calculated field definitions for the analysis.
    
    Parameters:
    
    calculatedFields - An array of calculated field definitions for the analysis.
  - withCalculatedFields
```
public AnalysisDefinition withCalculatedFields(CalculatedField... calculatedFields)
```
    An array of calculated field definitions for the analysis.
    
    NOTE: This method appends the values to the existing list (if any). Use setCalculatedFields(java.util.Collection) or withCalculatedFields(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    calculatedFields - An array of calculated field definitions for the analysis.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withCalculatedFields
```
public AnalysisDefinition withCalculatedFields(Collection<CalculatedField> calculatedFields)
```
    An array of calculated field definitions for the analysis.
    
    Parameters:
    
    calculatedFields - An array of calculated field definitions for the analysis.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getParameterDeclarations
```
public List<ParameterDeclaration> getParameterDeclarations()
```
    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.
    
    Returns:
    
    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.
  - setParameterDeclarations
```
public void setParameterDeclarations(Collection<ParameterDeclaration> 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.
    
    Parameters:
    
    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.
  - withParameterDeclarations
```
public AnalysisDefinition withParameterDeclarations(ParameterDeclaration... 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 setParameterDeclarations(java.util.Collection) or withParameterDeclarations(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withParameterDeclarations
```
public AnalysisDefinition withParameterDeclarations(Collection<ParameterDeclaration> 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getFilterGroups
```
public List<FilterGroup> getFilterGroups()
```
    Filter definitions for an analysis.
    
    For more information, see Filtering Data in Amazon QuickSight in the Amazon QuickSight User Guide.
    
    Returns:
    
    Filter definitions for an analysis.
    
    For more information, see Filtering Data in Amazon QuickSight in the Amazon QuickSight User Guide.
  - setFilterGroups
```
public void setFilterGroups(Collection<FilterGroup> filterGroups)
```
    Filter definitions for an analysis.
    
    For more information, see Filtering Data in Amazon QuickSight in the Amazon QuickSight User Guide.
    
    Parameters:
    
    filterGroups - Filter definitions for an analysis.
    
    For more information, see Filtering Data in Amazon QuickSight in the Amazon QuickSight User Guide.
  - withFilterGroups
```
public AnalysisDefinition withFilterGroups(FilterGroup... 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 setFilterGroups(java.util.Collection) or withFilterGroups(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    filterGroups - Filter definitions for an analysis.
    
    For more information, see Filtering Data in Amazon QuickSight in the Amazon QuickSight User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withFilterGroups
```
public AnalysisDefinition withFilterGroups(Collection<FilterGroup> filterGroups)
```
    Filter definitions for an analysis.
    
    For more information, see Filtering Data in Amazon QuickSight in the Amazon QuickSight User Guide.
    
    Parameters:
    
    filterGroups - Filter definitions for an analysis.
    
    For more information, see Filtering Data in Amazon QuickSight in the Amazon QuickSight User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getColumnConfigurations
```
public List<ColumnConfiguration> getColumnConfigurations()
```
    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.
    
    Returns:
    
    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.
  - setColumnConfigurations
```
public void setColumnConfigurations(Collection<ColumnConfiguration> 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.
    
    Parameters:
    
    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.
  - withColumnConfigurations
```
public AnalysisDefinition withColumnConfigurations(ColumnConfiguration... 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 setColumnConfigurations(java.util.Collection) or withColumnConfigurations(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withColumnConfigurations
```
public AnalysisDefinition withColumnConfigurations(Collection<ColumnConfiguration> 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAnalysisDefaults
```
public void setAnalysisDefaults(AnalysisDefaults analysisDefaults)
```
    Parameters:
    
    analysisDefaults -
  - getAnalysisDefaults
```
public AnalysisDefaults getAnalysisDefaults()
```
    Returns:
  - withAnalysisDefaults
```
public AnalysisDefinition withAnalysisDefaults(AnalysisDefaults analysisDefaults)
```
    Parameters:
    
    analysisDefaults -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    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.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public AnalysisDefinition clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class AnalysisDefinition

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AnalysisDefinition

Method Detail

getDataSetIdentifierDeclarations

setDataSetIdentifierDeclarations

withDataSetIdentifierDeclarations

withDataSetIdentifierDeclarations

getSheets

setSheets

withSheets

withSheets

getCalculatedFields

setCalculatedFields

withCalculatedFields

withCalculatedFields

getParameterDeclarations

setParameterDeclarations

withParameterDeclarations

withParameterDeclarations

getFilterGroups

setFilterGroups

withFilterGroups

withFilterGroups

getColumnConfigurations

setColumnConfigurations

withColumnConfigurations

withColumnConfigurations

setAnalysisDefaults

getAnalysisDefaults

withAnalysisDefaults

toString

equals

hashCode

clone

marshall