Package software.amazon.awssdk.services.quicksight.model

Interface TemplateVersionDefinition.Builder

All Superinterfaces:

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

Enclosing class:

TemplateVersionDefinition

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

Method Summary

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

dataSetConfigurations

TemplateVersionDefinition.Builder dataSetConfigurations(Collection<DataSetConfiguration> dataSetConfigurations)

An array of dataset configurations. These configurations define the required columns for each dataset used within a template.

Parameters:

dataSetConfigurations - An array of dataset configurations. These configurations define the required columns for each dataset used within a template.

Returns:

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

dataSetConfigurations

TemplateVersionDefinition.Builder dataSetConfigurations(DataSetConfiguration... dataSetConfigurations)

An array of dataset configurations. These configurations define the required columns for each dataset used within a template.

Parameters:

dataSetConfigurations - An array of dataset configurations. These configurations define the required columns for each dataset used within a template.

Returns:

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

dataSetConfigurations

TemplateVersionDefinition.Builder dataSetConfigurations(Consumer<DataSetConfiguration.Builder>... dataSetConfigurations)

An array of dataset configurations. These configurations define the required columns for each dataset used within a template.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #dataSetConfigurations(List).

Parameters:

dataSetConfigurations - a consumer that will call methods on DataSetConfiguration.Builder

Returns:

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

See Also:

#dataSetConfigurations(java.util.Collection)

sheets

TemplateVersionDefinition.Builder sheets(Collection<SheetDefinition> sheets)

An array of sheet definitions for a template.

Parameters:

sheets - An array of sheet definitions for a template.

Returns:

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

sheets

TemplateVersionDefinition.Builder sheets(SheetDefinition... sheets)

An array of sheet definitions for a template.

Parameters:

sheets - An array of sheet definitions for a template.

Returns:

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

sheets

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

An array of sheet definitions for a template.

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

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)

calculatedFields

TemplateVersionDefinition.Builder calculatedFields(Collection<CalculatedField> calculatedFields)

An array of calculated field definitions for the template.

Parameters:

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

Returns:

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

calculatedFields

TemplateVersionDefinition.Builder calculatedFields(CalculatedField... calculatedFields)

An array of calculated field definitions for the template.

Parameters:

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

Returns:

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

calculatedFields

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

An array of calculated field definitions for the template.

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

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)

parameterDeclarations

TemplateVersionDefinition.Builder parameterDeclarations(Collection<ParameterDeclaration> parameterDeclarations)

An array of parameter declarations for a template.

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 a template.

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

TemplateVersionDefinition.Builder parameterDeclarations(ParameterDeclaration... parameterDeclarations)

An array of parameter declarations for a template.

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 a template.

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

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

An array of parameter declarations for a template.

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

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)

filterGroups

TemplateVersionDefinition.Builder filterGroups(Collection<FilterGroup> filterGroups)

Filter definitions for a template.

For more information, see Filtering Data in the Amazon QuickSight User Guide.

Parameters:

filterGroups - Filter definitions for a template.

For more information, see Filtering Data in the Amazon QuickSight User Guide.

Returns:

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

filterGroups

TemplateVersionDefinition.Builder filterGroups(FilterGroup... filterGroups)

Filter definitions for a template.

For more information, see Filtering Data in the Amazon QuickSight User Guide.

Parameters:

filterGroups - Filter definitions for a template.

For more information, see Filtering Data in the Amazon QuickSight User Guide.

Returns:

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

filterGroups

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

Filter definitions for a template.

For more information, see Filtering Data 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).

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)

columnConfigurations

TemplateVersionDefinition.Builder columnConfigurations(Collection<ColumnConfiguration> columnConfigurations)

An array of template-level column configurations. Column configurations are used to set default formatting for a column that's used throughout a template.

Parameters:

columnConfigurations - An array of template-level column configurations. Column configurations are used to set default formatting for a column that's used throughout a template.

Returns:

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

columnConfigurations

TemplateVersionDefinition.Builder columnConfigurations(ColumnConfiguration... columnConfigurations)

An array of template-level column configurations. Column configurations are used to set default formatting for a column that's used throughout a template.

Parameters:

columnConfigurations - An array of template-level column configurations. Column configurations are used to set default formatting for a column that's used throughout a template.

Returns:

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

columnConfigurations

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

An array of template-level column configurations. Column configurations are used to set default formatting for a column that's used throughout a template.

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

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)

analysisDefaults

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

TemplateVersionDefinition.Builder options(AssetOptions options)

An array of option definitions for a template.

Parameters:

options - An array of option definitions for a template.

Returns:

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

options

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

An array of option definitions for a template.

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

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

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

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

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

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)