Class CreateTemplateRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateTemplateRequest.Builder,
CreateTemplateRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The ID for the Amazon Web Services account that the group is in.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 boolean
For responses, this returns true if the service returned a value for the Permissions property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
name()
A display name for the template.final List
<ResourcePermission> A list of resource permissions to be set on the template.static Class
<? extends CreateTemplateRequest.Builder> final TemplateSourceEntity
The entity that you are using as a source when you create the template.tags()
Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.final String
An ID for the template that you want to create.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
TThe option to relax the validation needed to create a template with definition objects.final String
A description of the current template version being created.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 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.
-
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:
- 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.
-
name
A display name for the template.
- Returns:
- A display name for the template.
-
hasPermissions
public final boolean hasPermissions()For responses, this returns true if the service returned a value for the Permissions property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasPermissions()
method.- Returns:
- A list of resource permissions to be set on the template.
-
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 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.Either a
SourceEntity
or aDefinition
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 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.Either a
SourceEntity
or aDefinition
must be provided in order for the request to be valid.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()
method.- Returns:
- Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
-
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 theVersionDescription
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 theVersionDescription
field.
-
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 aDefinition
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 aDefinition
must be provided in order for the request to be valid.
-
validationStrategy
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.
-
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<CreateTemplateRequest.Builder,
CreateTemplateRequest> - 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
-