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

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateTemplateRequest.Builder,CreateTemplateRequest>

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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CreateTemplateRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`awsAccountId()`	The ID for the Amazon Web Services account that the group is in.
`static CreateTemplateRequest.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()`
`boolean`	`hasPermissions()`	For responses, this returns true if the service returned a value for the Permissions property.
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`String`	`name()`	A display name for the template.
`List<ResourcePermission>`	`permissions()`	A list of resource permissions to be set on the template.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateTemplateRequest.Builder>`	`serializableBuilderClass()`
`TemplateSourceEntity`	`sourceEntity()`	The entity that you are using as a source when you create the template.
`List<Tag>`	`tags()`	Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
`String`	`templateId()`	An ID for the template that you want to create.
`CreateTemplateRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`ValidationStrategy`	`validationStrategy()`	TThe option to relax the validation needed to create a template with definition objects.
`String`	`versionDescription()`	A description of the current template version being created.

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 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
```
public final 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.
    
    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
```
public final String 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 the isEmpty() 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
```
public final List<ResourcePermission> 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
```
public final 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 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 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.
  - 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 the isEmpty() 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
```
public final List<Tag> 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
```
public final 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.
    
    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.
  - 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.
    
    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.
  - validationStrategy
```
public final ValidationStrategy 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
```
public CreateTemplateRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateTemplateRequest.Builder,CreateTemplateRequest>
    
    Specified by:
    
    toBuilder in class QuickSightRequest
  - builder
```
public static CreateTemplateRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateTemplateRequest.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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class CreateTemplateRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

awsAccountId

templateId

name

hasPermissions

permissions

sourceEntity

hasTags

tags

versionDescription

definition

validationStrategy

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField