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

Interface UpdateTemplateRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<UpdateTemplateRequest.Builder,UpdateTemplateRequest>, QuickSightRequest.Builder, SdkBuilder<UpdateTemplateRequest.Builder,UpdateTemplateRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

UpdateTemplateRequest

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

Method Summary

Modifier and Type	Method	Description
UpdateTemplateRequest.Builder	awsAccountId(String awsAccountId)	The ID of the Amazon Web Services account that contains the template that you're updating.
default UpdateTemplateRequest.Builder	definition(Consumer<TemplateVersionDefinition.Builder> definition)	The definition of a template.
UpdateTemplateRequest.Builder	definition(TemplateVersionDefinition definition)	The definition of a template.
UpdateTemplateRequest.Builder	name(String name)	The name for the template.
UpdateTemplateRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
UpdateTemplateRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
default UpdateTemplateRequest.Builder	sourceEntity(Consumer<TemplateSourceEntity.Builder> sourceEntity)	The entity that you are using as a source when you update the template.
UpdateTemplateRequest.Builder	sourceEntity(TemplateSourceEntity sourceEntity)	The entity that you are using as a source when you update the template.
UpdateTemplateRequest.Builder	templateId(String templateId)	The ID for the template.
default UpdateTemplateRequest.Builder	validationStrategy(Consumer<ValidationStrategy.Builder> validationStrategy)	The option to relax the validation needed to update a template with definition objects.
UpdateTemplateRequest.Builder	validationStrategy(ValidationStrategy validationStrategy)	The option to relax the validation needed to update a template with definition objects.
UpdateTemplateRequest.Builder	versionDescription(String versionDescription)	A description of the current template version that is being updated.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

Methods inherited from interface software.amazon.awssdk.services.quicksight.model.QuickSightRequest.Builder

build

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

awsAccountId

UpdateTemplateRequest.Builder awsAccountId(String awsAccountId)

The ID of the Amazon Web Services account that contains the template that you're updating.

Parameters:

awsAccountId - The ID of the Amazon Web Services account that contains the template that you're updating.

Returns:

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

templateId

UpdateTemplateRequest.Builder templateId(String templateId)

The ID for the template.

Parameters:

templateId - The ID for the template.

Returns:

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

sourceEntity

UpdateTemplateRequest.Builder sourceEntity(TemplateSourceEntity sourceEntity)

The entity that you are using as a source when you update the template. In SourceEntity, you specify the type of object you're using as source: SourceTemplate for a template or SourceAnalysis for an analysis. Both of these require an Amazon Resource Name (ARN). For SourceTemplate, specify the ARN of the source template. For SourceAnalysis, specify the ARN of the source analysis. The SourceTemplate ARN can contain any Amazon Web Services account and any QuickSight-supported Amazon Web Services Region;.

Use the DataSetReferences entity within SourceTemplate or SourceAnalysis to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.

Parameters:

sourceEntity - The entity that you are using as a source when you update the template. In SourceEntity, you specify the type of object you're using as source: SourceTemplate for a template or SourceAnalysis for an analysis. Both of these require an Amazon Resource Name (ARN). For SourceTemplate, specify the ARN of the source template. For SourceAnalysis, specify the ARN of the source analysis. The SourceTemplate ARN can contain any Amazon Web Services account and any QuickSight-supported Amazon Web Services Region;.

Use the DataSetReferences entity within SourceTemplate or SourceAnalysis to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.

Returns:

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

sourceEntity

default UpdateTemplateRequest.Builder sourceEntity(Consumer<TemplateSourceEntity.Builder> sourceEntity)

The entity that you are using as a source when you update the template. In SourceEntity, you specify the type of object you're using as source: SourceTemplate for a template or SourceAnalysis for an analysis. Both of these require an Amazon Resource Name (ARN). For SourceTemplate, specify the ARN of the source template. For SourceAnalysis, specify the ARN of the source analysis. The SourceTemplate ARN can contain any Amazon Web Services account and any QuickSight-supported Amazon Web Services Region;.

Use the DataSetReferences entity within SourceTemplate or SourceAnalysis to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.

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

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

Parameters:

sourceEntity - a consumer that will call methods on TemplateSourceEntity.Builder

Returns:

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

See Also:

sourceEntity(TemplateSourceEntity)

versionDescription

UpdateTemplateRequest.Builder versionDescription(String versionDescription)

A description of the current template version that is being updated. Every time you call UpdateTemplate, you create a new version of the template. Each version of the template maintains a description of the version in the VersionDescription field.

Parameters:

versionDescription - A description of the current template version that is being updated. Every time you call UpdateTemplate, you create a new version of the template. Each version of the template maintains a description of the version in the VersionDescription field.

Returns:

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

name

UpdateTemplateRequest.Builder name(String name)

The name for the template.

Parameters:

name - The name for the template.

Returns:

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

definition

UpdateTemplateRequest.Builder definition(TemplateVersionDefinition definition)

The definition of a template.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

Parameters:

definition - The definition of a template.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

Returns:

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

definition

default UpdateTemplateRequest.Builder definition(Consumer<TemplateVersionDefinition.Builder> definition)

The definition of a template.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

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

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

Parameters:

definition - a consumer that will call methods on TemplateVersionDefinition.Builder

Returns:

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

See Also:

definition(TemplateVersionDefinition)

validationStrategy

UpdateTemplateRequest.Builder validationStrategy(ValidationStrategy validationStrategy)

The option to relax the validation needed to update a template with definition objects. This skips the validation step for specific errors.

Parameters:

validationStrategy - The option to relax the validation needed to update a template with definition objects. This skips the validation step for specific errors.

Returns:

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

validationStrategy

default UpdateTemplateRequest.Builder validationStrategy(Consumer<ValidationStrategy.Builder> validationStrategy)

The option to relax the validation needed to update a template with definition objects. This skips the validation step for specific errors.

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

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

Parameters:

validationStrategy - a consumer that will call methods on ValidationStrategy.Builder

Returns:

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

See Also:

validationStrategy(ValidationStrategy)

overrideConfiguration

UpdateTemplateRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

UpdateTemplateRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder