Class UpdateTemplateRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<UpdateTemplateRequest.Builder,
UpdateTemplateRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The ID of the Amazon Web Services account that contains the template that you're updating.builder()
The definition of a template.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final String
name()
The name for the template.static Class
<? extends UpdateTemplateRequest.Builder> final TemplateSourceEntity
The entity that you are using as a source when you update the template.final String
The ID for the template.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final ValidationStrategy
The option to relax the validation needed to update a template with definition objects.final String
A description of the current template version that is being updated.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
The ID for the template.
- Returns:
- The ID for the template.
-
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 orSourceAnalysis
for an analysis. Both of these require an Amazon Resource Name (ARN). ForSourceTemplate
, specify the ARN of the source template. ForSourceAnalysis
, specify the ARN of the source analysis. TheSourceTemplate
ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region;.Use the
DataSetReferences
entity withinSourceTemplate
orSourceAnalysis
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 orSourceAnalysis
for an analysis. Both of these require an Amazon Resource Name (ARN). ForSourceTemplate
, specify the ARN of the source template. ForSourceAnalysis
, specify the ARN of the source analysis. TheSourceTemplate
ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region;.Use the
DataSetReferences
entity withinSourceTemplate
orSourceAnalysis
to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.
-
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 theVersionDescription
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 theVersionDescription
field.
-
name
The name for the template.
- Returns:
- The name for the template.
-
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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<UpdateTemplateRequest.Builder,
UpdateTemplateRequest> - Specified by:
toBuilder
in classQuickSightRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-