software.amazon.awssdk.services.quicksight.model

Class CreateTemplateRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.quicksight.model.QuickSightRequest

software.amazon.awssdk.services.quicksight.model.CreateTemplateRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateTemplateRequest.Builder,CreateTemplateRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateTemplateRequest
extends QuickSightRequest
implements ToCopyableBuilder<CreateTemplateRequest.Builder,CreateTemplateRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateTemplateRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	awsAccountId() The ID for the AWS account that the group is in.
static CreateTemplateRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPermissions() Returns true if the Permissions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	name() A display name for the template.
List<ResourcePermission>	permissions() A list of resource permissions to be set on the template.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateTemplateRequest.Builder>	serializableBuilderClass()
TemplateSourceEntity	sourceEntity() The entity that you are using as a source when you create the template.
List<Tag>	tags() Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
String	templateId() An ID for the template that you want to create.
CreateTemplateRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	versionDescription() A description of the current template version being created.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

awsAccountId

public String awsAccountId()

The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

Returns:

The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

templateId

public String templateId()

An ID for the template that you want to create. This template is unique per AWS Region in each AWS account.

Returns:

An ID for the template that you want to create. This template is unique per AWS Region in each AWS account.

name

public String name()

A display name for the template.

Returns:

A display name for the template.

hasPermissions

public boolean hasPermissions()

Returns true if the Permissions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

permissions

public List<ResourcePermission> permissions()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasPermissions() to see if a value was sent in this field.

Returns:

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

sourceEntity

public 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 AWS Account and any QuickSight-supported AWS 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:

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 AWS Account and any QuickSight-supported AWS 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.

hasTags

public boolean hasTags()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tags

public List<Tag> tags()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasTags() to see if a value was sent in this field.

Returns:

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

versionDescription

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

Returns:

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.

toBuilder

public CreateTemplateRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateTemplateRequest.Builder,CreateTemplateRequest>

Specified by:

toBuilder in class QuickSightRequest

builder

public static CreateTemplateRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateTemplateRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo