Interface AnalysisDefinition.Builder

All Superinterfaces:

Buildable, CopyableBuilder<AnalysisDefinition.Builder,AnalysisDefinition>, SdkBuilder<AnalysisDefinition.Builder,AnalysisDefinition>, SdkPojo

Enclosing class:

AnalysisDefinition

@Mutable
@NotThreadSafe
public static interface AnalysisDefinition.Builder
extends SdkPojo, CopyableBuilder<AnalysisDefinition.Builder,AnalysisDefinition>

Method Summary

Modifier and Type	Method	Description
default AnalysisDefinition.Builder	analysisDefaults(Consumer<AnalysisDefaults.Builder> analysisDefaults)	Sets the value of the AnalysisDefaults property for this object.
AnalysisDefinition.Builder	analysisDefaults(AnalysisDefaults analysisDefaults)	Sets the value of the AnalysisDefaults property for this object.
AnalysisDefinition.Builder	calculatedFields(Collection<CalculatedField> calculatedFields)	An array of calculated field definitions for the analysis.
AnalysisDefinition.Builder	calculatedFields(Consumer<CalculatedField.Builder>... calculatedFields)	An array of calculated field definitions for the analysis.
AnalysisDefinition.Builder	calculatedFields(CalculatedField... calculatedFields)	An array of calculated field definitions for the analysis.
AnalysisDefinition.Builder	columnConfigurations(Collection<ColumnConfiguration> columnConfigurations)	An array of analysis-level column configurations.
AnalysisDefinition.Builder	columnConfigurations(Consumer<ColumnConfiguration.Builder>... columnConfigurations)	An array of analysis-level column configurations.
AnalysisDefinition.Builder	columnConfigurations(ColumnConfiguration... columnConfigurations)	An array of analysis-level column configurations.
AnalysisDefinition.Builder	dataSetIdentifierDeclarations(Collection<DataSetIdentifierDeclaration> dataSetIdentifierDeclarations)	An array of dataset identifier declarations.
AnalysisDefinition.Builder	dataSetIdentifierDeclarations(Consumer<DataSetIdentifierDeclaration.Builder>... dataSetIdentifierDeclarations)	An array of dataset identifier declarations.
AnalysisDefinition.Builder	dataSetIdentifierDeclarations(DataSetIdentifierDeclaration... dataSetIdentifierDeclarations)	An array of dataset identifier declarations.
AnalysisDefinition.Builder	filterGroups(Collection<FilterGroup> filterGroups)	Filter definitions for an analysis.
AnalysisDefinition.Builder	filterGroups(Consumer<FilterGroup.Builder>... filterGroups)	Filter definitions for an analysis.
AnalysisDefinition.Builder	filterGroups(FilterGroup... filterGroups)	Filter definitions for an analysis.
default AnalysisDefinition.Builder	options(Consumer<AssetOptions.Builder> options)	An array of option definitions for an analysis.
AnalysisDefinition.Builder	options(AssetOptions options)	An array of option definitions for an analysis.
AnalysisDefinition.Builder	parameterDeclarations(Collection<ParameterDeclaration> parameterDeclarations)	An array of parameter declarations for an analysis.
AnalysisDefinition.Builder	parameterDeclarations(Consumer<ParameterDeclaration.Builder>... parameterDeclarations)	An array of parameter declarations for an analysis.
AnalysisDefinition.Builder	parameterDeclarations(ParameterDeclaration... parameterDeclarations)	An array of parameter declarations for an analysis.
default AnalysisDefinition.Builder	queryExecutionOptions(Consumer<QueryExecutionOptions.Builder> queryExecutionOptions)	Sets the value of the QueryExecutionOptions property for this object.
AnalysisDefinition.Builder	queryExecutionOptions(QueryExecutionOptions queryExecutionOptions)	Sets the value of the QueryExecutionOptions property for this object.
AnalysisDefinition.Builder	sheets(Collection<SheetDefinition> sheets)	An array of sheet definitions for an analysis.
AnalysisDefinition.Builder	sheets(Consumer<SheetDefinition.Builder>... sheets)	An array of sheet definitions for an analysis.
AnalysisDefinition.Builder	sheets(SheetDefinition... sheets)	An array of sheet definitions for an analysis.
AnalysisDefinition.Builder	staticFiles(Collection<StaticFile> staticFiles)	The static files for the definition.
AnalysisDefinition.Builder	staticFiles(Consumer<StaticFile.Builder>... staticFiles)	The static files for the definition.
AnalysisDefinition.Builder	staticFiles(StaticFile... staticFiles)	The static files for the definition.

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, sdkFieldNameToField, 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 the DataSetIdentifierDeclaration.Builder avoiding the need to create one manually via DataSetIdentifierDeclaration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dataSetIdentifierDeclarations(List<DataSetIdentifierDeclaration>).

Parameters:

dataSetIdentifierDeclarations - a consumer that will call methods on DataSetIdentifierDeclaration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• dataSetIdentifierDeclarations(java.util.Collection<DataSetIdentifierDeclaration>)

sheets

AnalysisDefinition.Builder sheets(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.

sheets

AnalysisDefinition.Builder sheets(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.

sheets

AnalysisDefinition.Builder sheets(Consumer<SheetDefinition.Builder>... sheets)

An array of sheet definitions for an analysis. Each SheetDefinition provides detailed information about a sheet within this analysis.

This is a convenience method that creates an instance of the SheetDefinition.Builder avoiding the need to create one manually via SheetDefinition.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sheets(List<SheetDefinition>).

Parameters:

sheets - a consumer that will call methods on SheetDefinition.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• sheets(java.util.Collection<SheetDefinition>)

calculatedFields

AnalysisDefinition.Builder calculatedFields(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.

calculatedFields

AnalysisDefinition.Builder calculatedFields(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.

calculatedFields

AnalysisDefinition.Builder calculatedFields(Consumer<CalculatedField.Builder>... calculatedFields)

An array of calculated field definitions for the analysis.

This is a convenience method that creates an instance of the CalculatedField.Builder avoiding the need to create one manually via CalculatedField.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to calculatedFields(List<CalculatedField>).

Parameters:

calculatedFields - a consumer that will call methods on CalculatedField.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• calculatedFields(java.util.Collection<CalculatedField>)

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

AnalysisDefinition.Builder parameterDeclarations(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

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 the ParameterDeclaration.Builder avoiding the need to create one manually via ParameterDeclaration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to parameterDeclarations(List<ParameterDeclaration>).

Parameters:

parameterDeclarations - a consumer that will call methods on ParameterDeclaration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• parameterDeclarations(java.util.Collection<ParameterDeclaration>)

filterGroups

AnalysisDefinition.Builder filterGroups(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.

filterGroups

AnalysisDefinition.Builder filterGroups(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.

filterGroups

AnalysisDefinition.Builder filterGroups(Consumer<FilterGroup.Builder>... 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 the FilterGroup.Builder avoiding the need to create one manually via FilterGroup.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filterGroups(List<FilterGroup>).

Parameters:

filterGroups - a consumer that will call methods on FilterGroup.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• filterGroups(java.util.Collection<FilterGroup>)

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

AnalysisDefinition.Builder columnConfigurations(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

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 the ColumnConfiguration.Builder avoiding the need to create one manually via ColumnConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to columnConfigurations(List<ColumnConfiguration>).

Parameters:

columnConfigurations - a consumer that will call methods on ColumnConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• columnConfigurations(java.util.Collection<ColumnConfiguration>)

analysisDefaults

AnalysisDefinition.Builder analysisDefaults(AnalysisDefaults 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 the AnalysisDefaults.Builder avoiding the need to create one manually via AnalysisDefaults.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to analysisDefaults(AnalysisDefaults).

Parameters:

analysisDefaults - a consumer that will call methods on AnalysisDefaults.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• analysisDefaults(AnalysisDefaults)

options

AnalysisDefinition.Builder options(AssetOptions 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

default AnalysisDefinition.Builder options(Consumer<AssetOptions.Builder> options)

An array of option definitions for an analysis.

This is a convenience method that creates an instance of the AssetOptions.Builder avoiding the need to create one manually via AssetOptions.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to options(AssetOptions).

Parameters:

options - a consumer that will call methods on AssetOptions.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• options(AssetOptions)

queryExecutionOptions

AnalysisDefinition.Builder queryExecutionOptions(QueryExecutionOptions queryExecutionOptions)

Sets the value of the QueryExecutionOptions property for this object.

Parameters:

queryExecutionOptions - The new value for the QueryExecutionOptions property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

queryExecutionOptions

default AnalysisDefinition.Builder queryExecutionOptions(Consumer<QueryExecutionOptions.Builder> queryExecutionOptions)

Sets the value of the QueryExecutionOptions property for this object. This is a convenience method that creates an instance of the QueryExecutionOptions.Builder avoiding the need to create one manually via QueryExecutionOptions.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to queryExecutionOptions(QueryExecutionOptions).

Parameters:

queryExecutionOptions - a consumer that will call methods on QueryExecutionOptions.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• queryExecutionOptions(QueryExecutionOptions)

staticFiles

AnalysisDefinition.Builder staticFiles(Collection<StaticFile> staticFiles)

The static files for the definition.

Parameters:

staticFiles - The static files for the definition.

Returns:

Returns a reference to this object so that method calls can be chained together.

staticFiles

AnalysisDefinition.Builder staticFiles(StaticFile... staticFiles)

The static files for the definition.

Parameters:

staticFiles - The static files for the definition.

Returns:

Returns a reference to this object so that method calls can be chained together.

staticFiles

AnalysisDefinition.Builder staticFiles(Consumer<StaticFile.Builder>... staticFiles)

The static files for the definition.

This is a convenience method that creates an instance of the StaticFile.Builder avoiding the need to create one manually via StaticFile.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to staticFiles(List<StaticFile>).

Parameters:

staticFiles - a consumer that will call methods on StaticFile.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• staticFiles(java.util.Collection<StaticFile>)