software.amazon.awssdk.services.quicksight.model

Interface CreateTemplateRequest.Builder

All Superinterfaces:

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

Enclosing class:

CreateTemplateRequest

public static interface CreateTemplateRequest.Builder
extends QuickSightRequest.Builder, SdkPojo, CopyableBuilder<CreateTemplateRequest.Builder,CreateTemplateRequest>

Method Summary

Modifier and Type	Method and Description
CreateTemplateRequest.Builder	awsAccountId(String awsAccountId) The ID for the Amazon Web Services account that the group is in.
default CreateTemplateRequest.Builder	definition(Consumer<TemplateVersionDefinition.Builder> definition) The definition of a template.
CreateTemplateRequest.Builder	definition(TemplateVersionDefinition definition) The definition of a template.
CreateTemplateRequest.Builder	name(String name) A display name for the template.
CreateTemplateRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateTemplateRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateTemplateRequest.Builder	permissions(Collection<ResourcePermission> permissions) A list of resource permissions to be set on the template.
CreateTemplateRequest.Builder	permissions(Consumer<ResourcePermission.Builder>... permissions) A list of resource permissions to be set on the template.
CreateTemplateRequest.Builder	permissions(ResourcePermission... permissions) A list of resource permissions to be set on the template.
default CreateTemplateRequest.Builder	sourceEntity(Consumer<TemplateSourceEntity.Builder> sourceEntity) The entity that you are using as a source when you create the template.
CreateTemplateRequest.Builder	sourceEntity(TemplateSourceEntity sourceEntity) The entity that you are using as a source when you create the template.
CreateTemplateRequest.Builder	tags(Collection<Tag> tags) Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
CreateTemplateRequest.Builder	tags(Consumer<Tag.Builder>... tags) Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
CreateTemplateRequest.Builder	tags(Tag... tags) Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
CreateTemplateRequest.Builder	templateId(String templateId) An ID for the template that you want to create.
CreateTemplateRequest.Builder	versionDescription(String versionDescription) A description of the current template version being created.

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

build

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

overrideConfiguration

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

awsAccountId

CreateTemplateRequest.Builder awsAccountId(String awsAccountId)

The ID for the Amazon Web Services account that the group is in. You use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

Parameters:

awsAccountId - The ID for the Amazon Web Services account that the group is in. You use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

Returns:

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

templateId

CreateTemplateRequest.Builder templateId(String templateId)

An ID for the template that you want to create. This template is unique per Amazon Web Services Region; in each Amazon Web Services account.

Parameters:

templateId - An ID for the template that you want to create. This template is unique per Amazon Web Services Region; in each Amazon Web Services account.

Returns:

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

name

CreateTemplateRequest.Builder name(String name)

A display name for the template.

Parameters:

name - A display name for the template.

Returns:

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

permissions

CreateTemplateRequest.Builder permissions(Collection<ResourcePermission> permissions)

A list of resource permissions to be set on the template.

Parameters:

permissions - A list of resource permissions to be set on the template.

Returns:

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

permissions

CreateTemplateRequest.Builder permissions(ResourcePermission... permissions)

A list of resource permissions to be set on the template.

Parameters:

permissions - A list of resource permissions to be set on the template.

Returns:

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

permissions

CreateTemplateRequest.Builder permissions(Consumer<ResourcePermission.Builder>... permissions)

A list of resource permissions to be set on the template.

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

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

Parameters:

permissions - a consumer that will call methods on ResourcePermission.Builder

Returns:

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

See Also:

#permissions(java.util.Collection)

sourceEntity

CreateTemplateRequest.Builder sourceEntity(TemplateSourceEntity sourceEntity)

The entity that you are using as a source when you create 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 Amazon 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.

Either a SourceEntity or a Definition must be provided in order for the request to be valid.

Parameters:

sourceEntity - The entity that you are using as a source when you create 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 Amazon 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.

Either a SourceEntity or a Definition must be provided in order for the request to be valid.

Returns:

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

sourceEntity

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

The entity that you are using as a source when you create 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 Amazon 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.

Either a SourceEntity or a Definition must be provided in order for the request to be valid.

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)

tags

CreateTemplateRequest.Builder tags(Collection<Tag> tags)

Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

Parameters:

tags - Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

Returns:

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

tags

CreateTemplateRequest.Builder tags(Tag... tags)

Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

Parameters:

tags - Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

Returns:

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

tags

CreateTemplateRequest.Builder tags(Consumer<Tag.Builder>... tags)

Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

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

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

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

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

See Also:

#tags(java.util.Collection)

versionDescription

CreateTemplateRequest.Builder versionDescription(String versionDescription)

A description of the current template version being created. This API operation creates the first version of the template. Every time UpdateTemplate is called, a new version is created. Each version of the template maintains a description of the version in the VersionDescription field.

Parameters:

versionDescription - A description of the current template version being created. This API operation creates the first version of the template. Every time UpdateTemplate is called, a new version is created. 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.

definition

CreateTemplateRequest.Builder definition(TemplateVersionDefinition definition)

The definition of a template.

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

Either a SourceEntity or a Definition must be provided in order for the request to be valid.

Parameters:

definition - The definition of a template.

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

Either a SourceEntity or a Definition must be provided in order for the request to be valid.

Returns:

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

definition

default CreateTemplateRequest.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.

Either a SourceEntity or a Definition must be provided in order for the request to be valid.

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)

overrideConfiguration

CreateTemplateRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder