software.amazon.awssdk.services.quicksight.model

Interface TemplateVersion.Builder

All Superinterfaces:

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

Enclosing class:

TemplateVersion

public static interface TemplateVersion.Builder
extends SdkPojo, CopyableBuilder<TemplateVersion.Builder,TemplateVersion>

Method Summary

Modifier and Type	Method and Description
TemplateVersion.Builder	createdTime(Instant createdTime) The time that this template version was created.
TemplateVersion.Builder	dataSetConfigurations(Collection<DataSetConfiguration> dataSetConfigurations) Schema of the dataset identified by the placeholder.
TemplateVersion.Builder	dataSetConfigurations(Consumer<DataSetConfiguration.Builder>... dataSetConfigurations) Schema of the dataset identified by the placeholder.
TemplateVersion.Builder	dataSetConfigurations(DataSetConfiguration... dataSetConfigurations) Schema of the dataset identified by the placeholder.
TemplateVersion.Builder	description(String description) The description of the template.
TemplateVersion.Builder	errors(Collection<TemplateError> errors) Errors associated with this template version.
TemplateVersion.Builder	errors(Consumer<TemplateError.Builder>... errors) Errors associated with this template version.
TemplateVersion.Builder	errors(TemplateError... errors) Errors associated with this template version.
TemplateVersion.Builder	sheets(Collection<Sheet> sheets) A list of the associated sheets with the unique identifier and name of each sheet.
TemplateVersion.Builder	sheets(Consumer<Sheet.Builder>... sheets) A list of the associated sheets with the unique identifier and name of each sheet.
TemplateVersion.Builder	sheets(Sheet... sheets) A list of the associated sheets with the unique identifier and name of each sheet.
TemplateVersion.Builder	sourceEntityArn(String sourceEntityArn) The Amazon Resource Name (ARN) of an analysis or template that was used to create this template.
TemplateVersion.Builder	status(ResourceStatus status) The status that is associated with the template.
TemplateVersion.Builder	status(String status) The status that is associated with the template.
TemplateVersion.Builder	themeArn(String themeArn) The ARN of the theme associated with this version of the template.
TemplateVersion.Builder	versionNumber(Long versionNumber) The version number of the template version.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

createdTime

TemplateVersion.Builder createdTime(Instant createdTime)

The time that this template version was created.

Parameters:

createdTime - The time that this template version was created.

Returns:

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

errors

TemplateVersion.Builder errors(Collection<TemplateError> errors)

Errors associated with this template version.

Parameters:

errors - Errors associated with this template version.

Returns:

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

errors

TemplateVersion.Builder errors(TemplateError... errors)

Errors associated with this template version.

Parameters:

errors - Errors associated with this template version.

Returns:

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

errors

TemplateVersion.Builder errors(Consumer<TemplateError.Builder>... errors)

Errors associated with this template version.

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

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

Parameters:

errors - a consumer that will call methods on TemplateError.Builder

Returns:

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

See Also:

#errors(java.util.Collection)

versionNumber

TemplateVersion.Builder versionNumber(Long versionNumber)

The version number of the template version.

Parameters:

versionNumber - The version number of the template version.

Returns:

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

status

TemplateVersion.Builder status(String status)

The status that is associated with the template.

• CREATION_IN_PROGRESS

• CREATION_SUCCESSFUL

• CREATION_FAILED

• UPDATE_IN_PROGRESS

• UPDATE_SUCCESSFUL

• UPDATE_FAILED

• DELETED

Parameters:

status - The status that is associated with the template.

• CREATION_IN_PROGRESS

• CREATION_SUCCESSFUL

• CREATION_FAILED

• UPDATE_IN_PROGRESS

• UPDATE_SUCCESSFUL

• UPDATE_FAILED

• DELETED

Returns:

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

See Also:

ResourceStatus, ResourceStatus

status

TemplateVersion.Builder status(ResourceStatus status)

The status that is associated with the template.

• CREATION_IN_PROGRESS

• CREATION_SUCCESSFUL

• CREATION_FAILED

• UPDATE_IN_PROGRESS

• UPDATE_SUCCESSFUL

• UPDATE_FAILED

• DELETED

Parameters:

status - The status that is associated with the template.

• CREATION_IN_PROGRESS

• CREATION_SUCCESSFUL

• CREATION_FAILED

• UPDATE_IN_PROGRESS

• UPDATE_SUCCESSFUL

• UPDATE_FAILED

• DELETED

Returns:

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

See Also:

ResourceStatus, ResourceStatus

dataSetConfigurations

TemplateVersion.Builder dataSetConfigurations(Collection<DataSetConfiguration> dataSetConfigurations)

Schema of the dataset identified by the placeholder. Any dashboard created from this template should be bound to new datasets matching the same schema described through this API operation.

Parameters:

dataSetConfigurations - Schema of the dataset identified by the placeholder. Any dashboard created from this template should be bound to new datasets matching the same schema described through this API operation.

Returns:

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

dataSetConfigurations

TemplateVersion.Builder dataSetConfigurations(DataSetConfiguration... dataSetConfigurations)

Schema of the dataset identified by the placeholder. Any dashboard created from this template should be bound to new datasets matching the same schema described through this API operation.

Parameters:

dataSetConfigurations - Schema of the dataset identified by the placeholder. Any dashboard created from this template should be bound to new datasets matching the same schema described through this API operation.

Returns:

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

dataSetConfigurations

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

Schema of the dataset identified by the placeholder. Any dashboard created from this template should be bound to new datasets matching the same schema described through this API operation.

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)

description

TemplateVersion.Builder description(String description)

The description of the template.

Parameters:

description - The description of the template.

Returns:

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

sourceEntityArn

TemplateVersion.Builder sourceEntityArn(String sourceEntityArn)

The Amazon Resource Name (ARN) of an analysis or template that was used to create this template.

Parameters:

sourceEntityArn - The Amazon Resource Name (ARN) of an analysis or template that was used to create this template.

Returns:

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

themeArn

TemplateVersion.Builder themeArn(String themeArn)

The ARN of the theme associated with this version of the template.

Parameters:

themeArn - The ARN of the theme associated with this version of the template.

Returns:

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

sheets

TemplateVersion.Builder sheets(Collection<Sheet> sheets)

A list of the associated sheets with the unique identifier and name of each sheet.

Parameters:

sheets - A list of the associated sheets with the unique identifier and name of each sheet.

Returns:

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

sheets

TemplateVersion.Builder sheets(Sheet... sheets)

A list of the associated sheets with the unique identifier and name of each sheet.

Parameters:

sheets - A list of the associated sheets with the unique identifier and name of each sheet.

Returns:

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

sheets

TemplateVersion.Builder sheets(Consumer<Sheet.Builder>... sheets)

A list of the associated sheets with the unique identifier and name of each sheet.

This is a convenience method that creates an instance of the Sheet.Builder avoiding the need to create one manually via Sheet.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 Sheet.Builder

Returns:

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

See Also:

#sheets(java.util.Collection)