Interface DashboardVersionDefinition.Builder

All Superinterfaces:

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

Enclosing class:

DashboardVersionDefinition

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

Method Summary

Modifier and Type	Method	Description
default DashboardVersionDefinition.Builder	analysisDefaults(Consumer<AnalysisDefaults.Builder> analysisDefaults)	Sets the value of the AnalysisDefaults property for this object.
DashboardVersionDefinition.Builder	analysisDefaults(AnalysisDefaults analysisDefaults)	Sets the value of the AnalysisDefaults property for this object.
DashboardVersionDefinition.Builder	calculatedFields(Collection<CalculatedField> calculatedFields)	An array of calculated field definitions for the dashboard.
DashboardVersionDefinition.Builder	calculatedFields(Consumer<CalculatedField.Builder>... calculatedFields)	An array of calculated field definitions for the dashboard.
DashboardVersionDefinition.Builder	calculatedFields(CalculatedField... calculatedFields)	An array of calculated field definitions for the dashboard.
DashboardVersionDefinition.Builder	columnConfigurations(Collection<ColumnConfiguration> columnConfigurations)	An array of dashboard-level column configurations.
DashboardVersionDefinition.Builder	columnConfigurations(Consumer<ColumnConfiguration.Builder>... columnConfigurations)	An array of dashboard-level column configurations.
DashboardVersionDefinition.Builder	columnConfigurations(ColumnConfiguration... columnConfigurations)	An array of dashboard-level column configurations.
DashboardVersionDefinition.Builder	dataSetIdentifierDeclarations(Collection<DataSetIdentifierDeclaration> dataSetIdentifierDeclarations)	An array of dataset identifier declarations.
DashboardVersionDefinition.Builder	dataSetIdentifierDeclarations(Consumer<DataSetIdentifierDeclaration.Builder>... dataSetIdentifierDeclarations)	An array of dataset identifier declarations.
DashboardVersionDefinition.Builder	dataSetIdentifierDeclarations(DataSetIdentifierDeclaration... dataSetIdentifierDeclarations)	An array of dataset identifier declarations.
DashboardVersionDefinition.Builder	filterGroups(Collection<FilterGroup> filterGroups)	The filter definitions for a dashboard.
DashboardVersionDefinition.Builder	filterGroups(Consumer<FilterGroup.Builder>... filterGroups)	The filter definitions for a dashboard.
DashboardVersionDefinition.Builder	filterGroups(FilterGroup... filterGroups)	The filter definitions for a dashboard.
default DashboardVersionDefinition.Builder	options(Consumer<AssetOptions.Builder> options)	An array of option definitions for a dashboard.
DashboardVersionDefinition.Builder	options(AssetOptions options)	An array of option definitions for a dashboard.
DashboardVersionDefinition.Builder	parameterDeclarations(Collection<ParameterDeclaration> parameterDeclarations)	The parameter declarations for a dashboard.
DashboardVersionDefinition.Builder	parameterDeclarations(Consumer<ParameterDeclaration.Builder>... parameterDeclarations)	The parameter declarations for a dashboard.
DashboardVersionDefinition.Builder	parameterDeclarations(ParameterDeclaration... parameterDeclarations)	The parameter declarations for a dashboard.
DashboardVersionDefinition.Builder	sheets(Collection<SheetDefinition> sheets)	An array of sheet definitions for a dashboard.
DashboardVersionDefinition.Builder	sheets(Consumer<SheetDefinition.Builder>... sheets)	An array of sheet definitions for a dashboard.
DashboardVersionDefinition.Builder	sheets(SheetDefinition... sheets)	An array of sheet definitions for a dashboard.
DashboardVersionDefinition.Builder	staticFiles(Collection<StaticFile> staticFiles)	The static files for the definition.
DashboardVersionDefinition.Builder	staticFiles(Consumer<StaticFile.Builder>... staticFiles)	The static files for the definition.
DashboardVersionDefinition.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

DashboardVersionDefinition.Builder dataSetIdentifierDeclarations(Collection<DataSetIdentifierDeclaration> dataSetIdentifierDeclarations)

An array of dataset identifier declarations. With this mapping,you can use dataset identifiers instead of dataset Amazon Resource Names (ARNs) throughout the dashboard's sub-structures.

Parameters:

dataSetIdentifierDeclarations - An array of dataset identifier declarations. With this mapping,you can use dataset identifiers instead of dataset Amazon Resource Names (ARNs) throughout the dashboard's sub-structures.

Returns:

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

dataSetIdentifierDeclarations

DashboardVersionDefinition.Builder dataSetIdentifierDeclarations(DataSetIdentifierDeclaration... dataSetIdentifierDeclarations)

An array of dataset identifier declarations. With this mapping,you can use dataset identifiers instead of dataset Amazon Resource Names (ARNs) throughout the dashboard's sub-structures.

Parameters:

dataSetIdentifierDeclarations - An array of dataset identifier declarations. With this mapping,you can use dataset identifiers instead of dataset Amazon Resource Names (ARNs) throughout the dashboard's sub-structures.

Returns:

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

dataSetIdentifierDeclarations

DashboardVersionDefinition.Builder dataSetIdentifierDeclarations(Consumer<DataSetIdentifierDeclaration.Builder>... dataSetIdentifierDeclarations)

An array of dataset identifier declarations. With this mapping,you can use dataset identifiers instead of dataset Amazon Resource Names (ARNs) throughout the dashboard's 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

DashboardVersionDefinition.Builder sheets(Collection<SheetDefinition> sheets)

An array of sheet definitions for a dashboard.

Parameters:

sheets - An array of sheet definitions for a dashboard.

Returns:

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

sheets

DashboardVersionDefinition.Builder sheets(SheetDefinition... sheets)

An array of sheet definitions for a dashboard.

Parameters:

sheets - An array of sheet definitions for a dashboard.

Returns:

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

sheets

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

An array of sheet definitions for a dashboard.

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

DashboardVersionDefinition.Builder calculatedFields(Collection<CalculatedField> calculatedFields)

An array of calculated field definitions for the dashboard.

Parameters:

calculatedFields - An array of calculated field definitions for the dashboard.

Returns:

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

calculatedFields

DashboardVersionDefinition.Builder calculatedFields(CalculatedField... calculatedFields)

An array of calculated field definitions for the dashboard.

Parameters:

calculatedFields - An array of calculated field definitions for the dashboard.

Returns:

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

calculatedFields

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

An array of calculated field definitions for the dashboard.

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

DashboardVersionDefinition.Builder parameterDeclarations(Collection<ParameterDeclaration> parameterDeclarations)

The parameter declarations for a dashboard. Parameters are named variables that can transfer a value for use by an action or an object.

For more information, see Parameters in Amazon Quick Sight in the Amazon Quick Suite User Guide.

Parameters:

parameterDeclarations - The parameter declarations for a dashboard. Parameters are named variables that can transfer a value for use by an action or an object.

For more information, see Parameters in Amazon Quick Sight in the Amazon Quick Suite User Guide.

Returns:

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

parameterDeclarations

DashboardVersionDefinition.Builder parameterDeclarations(ParameterDeclaration... parameterDeclarations)

The parameter declarations for a dashboard. Parameters are named variables that can transfer a value for use by an action or an object.

For more information, see Parameters in Amazon Quick Sight in the Amazon Quick Suite User Guide.

Parameters:

parameterDeclarations - The parameter declarations for a dashboard. Parameters are named variables that can transfer a value for use by an action or an object.

For more information, see Parameters in Amazon Quick Sight in the Amazon Quick Suite User Guide.

Returns:

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

parameterDeclarations

DashboardVersionDefinition.Builder parameterDeclarations(Consumer<ParameterDeclaration.Builder>... parameterDeclarations)

The parameter declarations for a dashboard. Parameters are named variables that can transfer a value for use by an action or an object.

For more information, see Parameters in Amazon Quick Sight in the Amazon Quick Suite 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

DashboardVersionDefinition.Builder filterGroups(Collection<FilterGroup> filterGroups)

The filter definitions for a dashboard.

For more information, see Filtering Data in Amazon Quick Sight in the Amazon Quick Suite User Guide.

Parameters:

filterGroups - The filter definitions for a dashboard.

For more information, see Filtering Data in Amazon Quick Sight in the Amazon Quick Suite User Guide.

Returns:

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

filterGroups

DashboardVersionDefinition.Builder filterGroups(FilterGroup... filterGroups)

The filter definitions for a dashboard.

For more information, see Filtering Data in Amazon Quick Sight in the Amazon Quick Suite User Guide.

Parameters:

filterGroups - The filter definitions for a dashboard.

For more information, see Filtering Data in Amazon Quick Sight in the Amazon Quick Suite User Guide.

Returns:

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

filterGroups

DashboardVersionDefinition.Builder filterGroups(Consumer<FilterGroup.Builder>... filterGroups)

The filter definitions for a dashboard.

For more information, see Filtering Data in Amazon Quick Sight in the Amazon Quick Suite 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

DashboardVersionDefinition.Builder columnConfigurations(Collection<ColumnConfiguration> columnConfigurations)

An array of dashboard-level column configurations. Column configurations are used to set the default formatting for a column that is used throughout a dashboard.

Parameters:

columnConfigurations - An array of dashboard-level column configurations. Column configurations are used to set the default formatting for a column that is used throughout a dashboard.

Returns:

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

columnConfigurations

DashboardVersionDefinition.Builder columnConfigurations(ColumnConfiguration... columnConfigurations)

An array of dashboard-level column configurations. Column configurations are used to set the default formatting for a column that is used throughout a dashboard.

Parameters:

columnConfigurations - An array of dashboard-level column configurations. Column configurations are used to set the default formatting for a column that is used throughout a dashboard.

Returns:

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

columnConfigurations

DashboardVersionDefinition.Builder columnConfigurations(Consumer<ColumnConfiguration.Builder>... columnConfigurations)

An array of dashboard-level column configurations. Column configurations are used to set the default formatting for a column that is used throughout a dashboard.

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

DashboardVersionDefinition.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 DashboardVersionDefinition.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

DashboardVersionDefinition.Builder options(AssetOptions options)

An array of option definitions for a dashboard.

Parameters:

options - An array of option definitions for a dashboard.

Returns:

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

options

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

An array of option definitions for a dashboard.

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)

staticFiles

DashboardVersionDefinition.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

DashboardVersionDefinition.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

DashboardVersionDefinition.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>)