Interface AnalysisDefinition.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<AnalysisDefinition.Builder,
,AnalysisDefinition> SdkBuilder<AnalysisDefinition.Builder,
,AnalysisDefinition> SdkPojo
- Enclosing class:
AnalysisDefinition
-
Method Summary
Modifier and TypeMethodDescriptiondefault AnalysisDefinition.Builder
analysisDefaults
(Consumer<AnalysisDefaults.Builder> analysisDefaults) Sets the value of the AnalysisDefaults property for this object.analysisDefaults
(AnalysisDefaults analysisDefaults) Sets the value of the AnalysisDefaults property for this object.calculatedFields
(Collection<CalculatedField> calculatedFields) An array of calculated field definitions for the analysis.calculatedFields
(Consumer<CalculatedField.Builder>... calculatedFields) An array of calculated field definitions for the analysis.calculatedFields
(CalculatedField... calculatedFields) An array of calculated field definitions for the analysis.columnConfigurations
(Collection<ColumnConfiguration> columnConfigurations) An array of analysis-level column configurations.columnConfigurations
(Consumer<ColumnConfiguration.Builder>... columnConfigurations) An array of analysis-level column configurations.columnConfigurations
(ColumnConfiguration... columnConfigurations) An array of analysis-level column configurations.dataSetIdentifierDeclarations
(Collection<DataSetIdentifierDeclaration> dataSetIdentifierDeclarations) An array of dataset identifier declarations.dataSetIdentifierDeclarations
(Consumer<DataSetIdentifierDeclaration.Builder>... dataSetIdentifierDeclarations) An array of dataset identifier declarations.dataSetIdentifierDeclarations
(DataSetIdentifierDeclaration... dataSetIdentifierDeclarations) An array of dataset identifier declarations.filterGroups
(Collection<FilterGroup> filterGroups) Filter definitions for an analysis.filterGroups
(Consumer<FilterGroup.Builder>... filterGroups) Filter definitions for an analysis.filterGroups
(FilterGroup... filterGroups) Filter definitions for an analysis.default AnalysisDefinition.Builder
options
(Consumer<AssetOptions.Builder> options) An array of option definitions for an analysis.options
(AssetOptions options) An array of option definitions for an analysis.parameterDeclarations
(Collection<ParameterDeclaration> parameterDeclarations) An array of parameter declarations for an analysis.parameterDeclarations
(Consumer<ParameterDeclaration.Builder>... parameterDeclarations) An array of parameter declarations for an analysis.parameterDeclarations
(ParameterDeclaration... parameterDeclarations) An array of parameter declarations for an analysis.sheets
(Collection<SheetDefinition> sheets) An array of sheet definitions for an analysis.sheets
(Consumer<SheetDefinition.Builder>... sheets) An array of sheet definitions for an analysis.sheets
(SheetDefinition... sheets) An array of sheet definitions for an analysis.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
dataSetIdentifierDeclarations
AnalysisDefinition.Builder dataSetIdentifierDeclarations(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.
-
dataSetIdentifierDeclarations
AnalysisDefinition.Builder dataSetIdentifierDeclarations(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.
-
dataSetIdentifierDeclarations
AnalysisDefinition.Builder dataSetIdentifierDeclarations(Consumer<DataSetIdentifierDeclaration.Builder>... dataSetIdentifierDeclarations) An array of dataset identifier declarations. This mapping allows the usage of dataset identifiers instead of dataset ARNs throughout analysis sub-structures.
This is a convenience method that creates an instance of theDataSetIdentifierDeclaration.Builder
avoiding the need to create one manually viaDataSetIdentifierDeclaration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todataSetIdentifierDeclarations(List<DataSetIdentifierDeclaration>)
.- Parameters:
dataSetIdentifierDeclarations
- a consumer that will call methods onDataSetIdentifierDeclaration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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. EachSheetDefinition
provides detailed information about a sheet within this analysis.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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. EachSheetDefinition
provides detailed information about a sheet within this analysis.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sheets
An array of sheet definitions for an analysis. Each
This is a convenience method that creates an instance of theSheetDefinition
provides detailed information about a sheet within this analysis.SheetDefinition.Builder
avoiding the need to create one manually viaSheetDefinition.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosheets(List<SheetDefinition>)
.- Parameters:
sheets
- a consumer that will call methods onSheetDefinition.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-
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.
-
calculatedFields
An array of calculated field definitions for the analysis.
This is a convenience method that creates an instance of theCalculatedField.Builder
avoiding the need to create one manually viaCalculatedField.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocalculatedFields(List<CalculatedField>)
.- Parameters:
calculatedFields
- a consumer that will call methods onCalculatedField.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
parameterDeclarations
AnalysisDefinition.Builder parameterDeclarations(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.
-
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.
-
parameterDeclarations
AnalysisDefinition.Builder parameterDeclarations(Consumer<ParameterDeclaration.Builder>... 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.
This is a convenience method that creates an instance of theParameterDeclaration.Builder
avoiding the need to create one manually viaParameterDeclaration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toparameterDeclarations(List<ParameterDeclaration>)
.- Parameters:
parameterDeclarations
- a consumer that will call methods onParameterDeclaration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-
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.
-
filterGroups
Filter definitions for an analysis.
For more information, see Filtering Data in Amazon QuickSight in the Amazon QuickSight User Guide.
This is a convenience method that creates an instance of theFilterGroup.Builder
avoiding the need to create one manually viaFilterGroup.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofilterGroups(List<FilterGroup>)
.- Parameters:
filterGroups
- a consumer that will call methods onFilterGroup.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
columnConfigurations
AnalysisDefinition.Builder columnConfigurations(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.
-
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.
-
columnConfigurations
AnalysisDefinition.Builder columnConfigurations(Consumer<ColumnConfiguration.Builder>... 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.
This is a convenience method that creates an instance of theColumnConfiguration.Builder
avoiding the need to create one manually viaColumnConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocolumnConfigurations(List<ColumnConfiguration>)
.- Parameters:
columnConfigurations
- a consumer that will call methods onColumnConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
analysisDefaults
Sets the value of the AnalysisDefaults property for this object.- Parameters:
analysisDefaults
- The new value for the AnalysisDefaults property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
analysisDefaults
default AnalysisDefinition.Builder analysisDefaults(Consumer<AnalysisDefaults.Builder> analysisDefaults) Sets the value of the AnalysisDefaults property for this object. This is a convenience method that creates an instance of theAnalysisDefaults.Builder
avoiding the need to create one manually viaAnalysisDefaults.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toanalysisDefaults(AnalysisDefaults)
.- Parameters:
analysisDefaults
- a consumer that will call methods onAnalysisDefaults.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
options
An array of option definitions for an analysis.
- Parameters:
options
- An array of option definitions for an analysis.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
options
An array of option definitions for an analysis.
This is a convenience method that creates an instance of theAssetOptions.Builder
avoiding the need to create one manually viaAssetOptions.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tooptions(AssetOptions)
.- Parameters:
options
- a consumer that will call methods onAssetOptions.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-