com.amazonaws.services.quicksight.model

Class UpdateTemplateRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.quicksight.model.UpdateTemplateRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateTemplateRequest
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
UpdateTemplateRequest()

Method Summary

Modifier and Type	Method and Description
UpdateTemplateRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAwsAccountId() The ID of the Amazon Web Services account that contains the template that you're updating.
TemplateVersionDefinition	getDefinition() The definition of a template.
String	getName() The name for the template.
TemplateSourceEntity	getSourceEntity() The entity that you are using as a source when you update the template.
String	getTemplateId() The ID for the template.
ValidationStrategy	getValidationStrategy() The option to relax the validation needed to update a template with definition objects.
String	getVersionDescription() A description of the current template version that is being updated.
int	hashCode()
void	setAwsAccountId(String awsAccountId) The ID of the Amazon Web Services account that contains the template that you're updating.
void	setDefinition(TemplateVersionDefinition definition) The definition of a template.
void	setName(String name) The name for the template.
void	setSourceEntity(TemplateSourceEntity sourceEntity) The entity that you are using as a source when you update the template.
void	setTemplateId(String templateId) The ID for the template.
void	setValidationStrategy(ValidationStrategy validationStrategy) The option to relax the validation needed to update a template with definition objects.
void	setVersionDescription(String versionDescription) A description of the current template version that is being updated.
String	toString() Returns a string representation of this object.
UpdateTemplateRequest	withAwsAccountId(String awsAccountId) The ID of the Amazon Web Services account that contains the template that you're updating.
UpdateTemplateRequest	withDefinition(TemplateVersionDefinition definition) The definition of a template.
UpdateTemplateRequest	withName(String name) The name for the template.
UpdateTemplateRequest	withSourceEntity(TemplateSourceEntity sourceEntity) The entity that you are using as a source when you update the template.
UpdateTemplateRequest	withTemplateId(String templateId) The ID for the template.
UpdateTemplateRequest	withValidationStrategy(ValidationStrategy validationStrategy) The option to relax the validation needed to update a template with definition objects.
UpdateTemplateRequest	withVersionDescription(String versionDescription) A description of the current template version that is being updated.

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

UpdateTemplateRequest

public UpdateTemplateRequest()

Method Detail

setAwsAccountId

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

getAwsAccountId

public String getAwsAccountId()

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

Returns:

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

withAwsAccountId

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

setTemplateId

public void setTemplateId(String templateId)

The ID for the template.

Parameters:

templateId - The ID for the template.

getTemplateId

public String getTemplateId()

The ID for the template.

Returns:

The ID for the template.

withTemplateId

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

setSourceEntity

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

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

getSourceEntity

public TemplateSourceEntity getSourceEntity()

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

Returns:

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

withSourceEntity

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

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

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

getVersionDescription

public String getVersionDescription()

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:

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.

withVersionDescription

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

setName

public void setName(String name)

The name for the template.

Parameters:

name - The name for the template.

getName

public String getName()

The name for the template.

Returns:

The name for the template.

withName

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

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.

Parameters:

definition - The definition of a template.

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

getDefinition

public TemplateVersionDefinition getDefinition()

The definition of a template.

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

Returns:

The definition of a template.

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

withDefinition

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

setValidationStrategy

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

getValidationStrategy

public ValidationStrategy getValidationStrategy()

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

Returns:

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

withValidationStrategy

public UpdateTemplateRequest withValidationStrategy(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.

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 UpdateTemplateRequest 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()