com.amazonaws.services.quicksight.model

Class CreateTemplateRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.quicksight.model.CreateTemplateRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateTemplateRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateTemplateRequest()

Method Summary

Modifier and Type	Method and Description
CreateTemplateRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAwsAccountId() The ID for the Amazon Web Services account that the group is in.
TemplateVersionDefinition	getDefinition() The definition of a template.
String	getName() A display name for the template.
List<ResourcePermission>	getPermissions() A list of resource permissions to be set on the template.
TemplateSourceEntity	getSourceEntity() The entity that you are using as a source when you create the template.
List<Tag>	getTags() Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
String	getTemplateId() An ID for the template that you want to create.
ValidationStrategy	getValidationStrategy() TThe option to relax the validation needed to create a template with definition objects.
String	getVersionDescription() A description of the current template version being created.
int	hashCode()
void	setAwsAccountId(String awsAccountId) The ID for the Amazon Web Services account that the group is in.
void	setDefinition(TemplateVersionDefinition definition) The definition of a template.
void	setName(String name) A display name for the template.
void	setPermissions(Collection<ResourcePermission> permissions) A list of resource permissions to be set on the template.
void	setSourceEntity(TemplateSourceEntity sourceEntity) The entity that you are using as a source when you create the template.
void	setTags(Collection<Tag> tags) Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
void	setTemplateId(String templateId) An ID for the template that you want to create.
void	setValidationStrategy(ValidationStrategy validationStrategy) TThe option to relax the validation needed to create a template with definition objects.
void	setVersionDescription(String versionDescription) A description of the current template version being created.
String	toString() Returns a string representation of this object.
CreateTemplateRequest	withAwsAccountId(String awsAccountId) The ID for the Amazon Web Services account that the group is in.
CreateTemplateRequest	withDefinition(TemplateVersionDefinition definition) The definition of a template.
CreateTemplateRequest	withName(String name) A display name for the template.
CreateTemplateRequest	withPermissions(Collection<ResourcePermission> permissions) A list of resource permissions to be set on the template.
CreateTemplateRequest	withPermissions(ResourcePermission... permissions) A list of resource permissions to be set on the template.
CreateTemplateRequest	withSourceEntity(TemplateSourceEntity sourceEntity) The entity that you are using as a source when you create the template.
CreateTemplateRequest	withTags(Collection<Tag> tags) Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
CreateTemplateRequest	withTags(Tag... tags) Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
CreateTemplateRequest	withTemplateId(String templateId) An ID for the template that you want to create.
CreateTemplateRequest	withValidationStrategy(ValidationStrategy validationStrategy) TThe option to relax the validation needed to create a template with definition objects.
CreateTemplateRequest	withVersionDescription(String versionDescription) A description of the current template version being created.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateTemplateRequest

public CreateTemplateRequest()

Method Detail

setAwsAccountId

public void setAwsAccountId(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.

getAwsAccountId

public String getAwsAccountId()

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:

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.

withAwsAccountId

public CreateTemplateRequest withAwsAccountId(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.

setTemplateId

public void setTemplateId(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.

getTemplateId

public String getTemplateId()

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:

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.

withTemplateId

public CreateTemplateRequest withTemplateId(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.

setName

public void setName(String name)

A display name for the template.

Parameters:

name - A display name for the template.

getName

public String getName()

A display name for the template.

Returns:

A display name for the template.

withName

public CreateTemplateRequest withName(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.

getPermissions

public List<ResourcePermission> getPermissions()

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

Returns:

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

setPermissions

public void setPermissions(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.

withPermissions

public CreateTemplateRequest withPermissions(ResourcePermission... permissions)

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

NOTE: This method appends the values to the existing list (if any). Use setPermissions(java.util.Collection) or withPermissions(java.util.Collection) if you want to override the existing values.

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.

withPermissions

public CreateTemplateRequest withPermissions(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.

setSourceEntity

public void setSourceEntity(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.

getSourceEntity

public TemplateSourceEntity getSourceEntity()

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:

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.

withSourceEntity

public CreateTemplateRequest withSourceEntity(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.

getTags

public List<Tag> getTags()

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

Returns:

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

setTags

public void setTags(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.

withTags

public CreateTemplateRequest withTags(Tag... tags)

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

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

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.

withTags

public CreateTemplateRequest withTags(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.

setVersionDescription

public void setVersionDescription(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.

getVersionDescription

public String getVersionDescription()

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.

withVersionDescription

public CreateTemplateRequest withVersionDescription(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.

setDefinition

public void setDefinition(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.

getDefinition

public TemplateVersionDefinition getDefinition()

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:

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.

withDefinition

public CreateTemplateRequest withDefinition(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.

setValidationStrategy

public void setValidationStrategy(ValidationStrategy validationStrategy)

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

Parameters:

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

getValidationStrategy

public ValidationStrategy getValidationStrategy()

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

Returns:

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

withValidationStrategy

public CreateTemplateRequest withValidationStrategy(ValidationStrategy validationStrategy)

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

Parameters:

validationStrategy - TThe option to relax the validation needed to create 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.

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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateTemplateRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()