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

Class UpdateTemplateRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateTemplateRequest.Builder,UpdateTemplateRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateTemplateRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	awsAccountId()	The ID of the Amazon Web Services account that contains the template that you're updating.
static UpdateTemplateRequest.Builder	builder()
TemplateVersionDefinition	definition()	The definition of a template.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name()	The name for the template.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateTemplateRequest.Builder>	serializableBuilderClass()
TemplateSourceEntity	sourceEntity()	The entity that you are using as a source when you update the template.
String	templateId()	The ID for the template.
UpdateTemplateRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
ValidationStrategy	validationStrategy()	The option to relax the validation needed to update a template with definition objects.
String	versionDescription()	A description of the current template version that is being updated.

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 final String awsAccountId()

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.

templateId

public final String templateId()

The ID for the template.

Returns:

The ID for the template.

sourceEntity

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

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.

versionDescription

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

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.

name

public final String name()

The name for the template.

Returns:

The name for the template.

definition

public final TemplateVersionDefinition definition()

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.

validationStrategy

public final ValidationStrategy validationStrategy()

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.

toBuilder

public UpdateTemplateRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateTemplateRequest.Builder,UpdateTemplateRequest>

Specified by:

toBuilder in class QuickSightRequest

builder

public static UpdateTemplateRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo