Interface CreateTemplateRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateTemplateRequest.Builder,CreateTemplateRequest>, QuickSightRequest.Builder, SdkBuilder<CreateTemplateRequest.Builder,CreateTemplateRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateTemplateRequest
@Mutable @NotThreadSafe public static interface CreateTemplateRequest.Builder extends QuickSightRequest.Builder, SdkPojo, CopyableBuilder<CreateTemplateRequest.Builder,CreateTemplateRequest>

  • Method Details

    • awsAccountId

      CreateTemplateRequest.Builder awsAccountId(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 Quick Sight account.

      Parameters:
      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 Quick Sight account.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • templateId

      CreateTemplateRequest.Builder templateId(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • name

      CreateTemplateRequest.Builder name(String name)

      A display name for the template.

      Parameters:
      name - A display name for the template.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • permissions

      CreateTemplateRequest.Builder permissions(Collection<ResourcePermission> permissions)

      A list of resource permissions to be set on the template.

      Parameters:
      permissions - A list of resource permissions to be set on the template.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • permissions

      CreateTemplateRequest.Builder permissions(ResourcePermission... permissions)

      A list of resource permissions to be set on the template.

      Parameters:
      permissions - A list of resource permissions to be set on the template.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • permissions

      CreateTemplateRequest.Builder permissions(Consumer<ResourcePermission.Builder>... permissions)

      A list of resource permissions to be set on the template.

      This is a convenience method that creates an instance of the ResourcePermission.Builder avoiding the need to create one manually via ResourcePermission.builder() .

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to permissions(List<ResourcePermission>).

      Parameters:
      permissions - a consumer that will call methods on ResourcePermission.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sourceEntity

      CreateTemplateRequest.Builder sourceEntity(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 Quick Sight-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.

      Parameters:
      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 Quick Sight-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:
      Returns a reference to this object so that method calls can be chained together.

    • sourceEntity

      default CreateTemplateRequest.Builder sourceEntity(Consumer<TemplateSourceEntity.Builder> 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 Quick Sight-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.

      This is a convenience method that creates an instance of the TemplateSourceEntity.Builder avoiding the need to create one manually via TemplateSourceEntity.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sourceEntity(TemplateSourceEntity).

      Parameters:
      sourceEntity - a consumer that will call methods on TemplateSourceEntity.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

      CreateTemplateRequest.Builder tags(Collection<Tag> tags)

      Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

      Parameters:
      tags - Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateTemplateRequest.Builder tags(Tag... tags)

      Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

      Parameters:
      tags - Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateTemplateRequest.Builder tags(Consumer<Tag.Builder>... tags)

      Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • versionDescription

      CreateTemplateRequest.Builder versionDescription(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • definition

      CreateTemplateRequest.Builder definition(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • definition

      default CreateTemplateRequest.Builder definition(Consumer<TemplateVersionDefinition.Builder> 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.

      This is a convenience method that creates an instance of the TemplateVersionDefinition.Builder avoiding the need to create one manually via TemplateVersionDefinition.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to definition(TemplateVersionDefinition).

      Parameters:
      definition - a consumer that will call methods on TemplateVersionDefinition.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • validationStrategy

      CreateTemplateRequest.Builder validationStrategy(ValidationStrategy validationStrategy)

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

      Parameters:
      validationStrategy - TThe option to relax the validation needed to create 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.

    • validationStrategy

      default CreateTemplateRequest.Builder validationStrategy(Consumer<ValidationStrategy.Builder> validationStrategy)

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

      This is a convenience method that creates an instance of the ValidationStrategy.Builder avoiding the need to create one manually via ValidationStrategy.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to validationStrategy(ValidationStrategy).

      Parameters:
      validationStrategy - a consumer that will call methods on ValidationStrategy.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      CreateTemplateRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateTemplateRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.