Interface CreateAnalysisTemplateRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CleanRoomsRequest.Builder, CopyableBuilder<CreateAnalysisTemplateRequest.Builder,CreateAnalysisTemplateRequest>, SdkBuilder<CreateAnalysisTemplateRequest.Builder,CreateAnalysisTemplateRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateAnalysisTemplateRequest

@Mutable
@NotThreadSafe
public static interface CreateAnalysisTemplateRequest.Builder
extends CleanRoomsRequest.Builder, SdkPojo, CopyableBuilder<CreateAnalysisTemplateRequest.Builder,CreateAnalysisTemplateRequest>

Method Summary

Modifier and Type	Method	Description
CreateAnalysisTemplateRequest.Builder	analysisParameters(Collection<AnalysisParameter> analysisParameters)	The parameters of the analysis template.
CreateAnalysisTemplateRequest.Builder	analysisParameters(Consumer<AnalysisParameter.Builder>... analysisParameters)	The parameters of the analysis template.
CreateAnalysisTemplateRequest.Builder	analysisParameters(AnalysisParameter... analysisParameters)	The parameters of the analysis template.
CreateAnalysisTemplateRequest.Builder	description(String description)	The description of the analysis template.
default CreateAnalysisTemplateRequest.Builder	errorMessageConfiguration(Consumer<ErrorMessageConfiguration.Builder> errorMessageConfiguration)	The configuration that specifies the level of detail in error messages returned by analyses using this template.
CreateAnalysisTemplateRequest.Builder	errorMessageConfiguration(ErrorMessageConfiguration errorMessageConfiguration)	The configuration that specifies the level of detail in error messages returned by analyses using this template.
CreateAnalysisTemplateRequest.Builder	format(String format)	The format of the analysis template.
CreateAnalysisTemplateRequest.Builder	format(AnalysisFormat format)	The format of the analysis template.
CreateAnalysisTemplateRequest.Builder	membershipIdentifier(String membershipIdentifier)	The identifier for a membership resource.
CreateAnalysisTemplateRequest.Builder	name(String name)	The name of the analysis template.
CreateAnalysisTemplateRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateAnalysisTemplateRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default CreateAnalysisTemplateRequest.Builder	schema(Consumer<AnalysisSchema.Builder> schema)	Sets the value of the Schema property for this object.
CreateAnalysisTemplateRequest.Builder	schema(AnalysisSchema schema)	Sets the value of the Schema property for this object.
default CreateAnalysisTemplateRequest.Builder	source(Consumer<AnalysisSource.Builder> source)	The information in the analysis template.
CreateAnalysisTemplateRequest.Builder	source(AnalysisSource source)	The information in the analysis template.
CreateAnalysisTemplateRequest.Builder	tags(Map<String,String> tags)	An optional label that you can assign to a resource when you create it.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.cleanrooms.model.CleanRoomsRequest.Builder

build

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

description

CreateAnalysisTemplateRequest.Builder description(String description)

The description of the analysis template.

Parameters:

description - The description of the analysis template.

Returns:

Returns a reference to this object so that method calls can be chained together.

membershipIdentifier

CreateAnalysisTemplateRequest.Builder membershipIdentifier(String membershipIdentifier)

The identifier for a membership resource.

Parameters:

membershipIdentifier - The identifier for a membership resource.

Returns:

Returns a reference to this object so that method calls can be chained together.

name

CreateAnalysisTemplateRequest.Builder name(String name)

The name of the analysis template.

Parameters:

name - The name of the analysis template.

Returns:

Returns a reference to this object so that method calls can be chained together.

format

CreateAnalysisTemplateRequest.Builder format(String format)

The format of the analysis template.

Parameters:

format - The format of the analysis template.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• AnalysisFormat
• AnalysisFormat

format

CreateAnalysisTemplateRequest.Builder format(AnalysisFormat format)

The format of the analysis template.

Parameters:

format - The format of the analysis template.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• AnalysisFormat
• AnalysisFormat

source

CreateAnalysisTemplateRequest.Builder source(AnalysisSource source)

The information in the analysis template.

Parameters:

source - The information in the analysis template.

Returns:

Returns a reference to this object so that method calls can be chained together.

source

default CreateAnalysisTemplateRequest.Builder source(Consumer<AnalysisSource.Builder> source)

The information in the analysis template.

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

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

Parameters:

source - a consumer that will call methods on AnalysisSource.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• source(AnalysisSource)

tags

CreateAnalysisTemplateRequest.Builder tags(Map<String,String> tags)

An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.

Parameters:

tags - An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.

Returns:

Returns a reference to this object so that method calls can be chained together.

analysisParameters

CreateAnalysisTemplateRequest.Builder analysisParameters(Collection<AnalysisParameter> analysisParameters)

The parameters of the analysis template.

Parameters:

analysisParameters - The parameters of the analysis template.

Returns:

Returns a reference to this object so that method calls can be chained together.

analysisParameters

CreateAnalysisTemplateRequest.Builder analysisParameters(AnalysisParameter... analysisParameters)

The parameters of the analysis template.

Parameters:

analysisParameters - The parameters of the analysis template.

Returns:

Returns a reference to this object so that method calls can be chained together.

analysisParameters

CreateAnalysisTemplateRequest.Builder analysisParameters(Consumer<AnalysisParameter.Builder>... analysisParameters)

The parameters of the analysis template.

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

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

Parameters:

analysisParameters - a consumer that will call methods on AnalysisParameter.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• analysisParameters(java.util.Collection<AnalysisParameter>)

schema

CreateAnalysisTemplateRequest.Builder schema(AnalysisSchema schema)

Sets the value of the Schema property for this object.

Parameters:

schema - The new value for the Schema property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

schema

default CreateAnalysisTemplateRequest.Builder schema(Consumer<AnalysisSchema.Builder> schema)

Sets the value of the Schema property for this object. This is a convenience method that creates an instance of the AnalysisSchema.Builder avoiding the need to create one manually via AnalysisSchema.builder().

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

Parameters:

schema - a consumer that will call methods on AnalysisSchema.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• schema(AnalysisSchema)

errorMessageConfiguration

CreateAnalysisTemplateRequest.Builder errorMessageConfiguration(ErrorMessageConfiguration errorMessageConfiguration)

The configuration that specifies the level of detail in error messages returned by analyses using this template. When set to DETAILED, error messages include more information to help troubleshoot issues with PySpark jobs. Detailed error messages may expose underlying data, including sensitive information. Recommended for faster troubleshooting in development and testing environments.

Parameters:

errorMessageConfiguration - The configuration that specifies the level of detail in error messages returned by analyses using this template. When set to DETAILED, error messages include more information to help troubleshoot issues with PySpark jobs. Detailed error messages may expose underlying data, including sensitive information. Recommended for faster troubleshooting in development and testing environments.

Returns:

Returns a reference to this object so that method calls can be chained together.

errorMessageConfiguration

default CreateAnalysisTemplateRequest.Builder errorMessageConfiguration(Consumer<ErrorMessageConfiguration.Builder> errorMessageConfiguration)

The configuration that specifies the level of detail in error messages returned by analyses using this template. When set to DETAILED, error messages include more information to help troubleshoot issues with PySpark jobs. Detailed error messages may expose underlying data, including sensitive information. Recommended for faster troubleshooting in development and testing environments.

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

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

Parameters:

errorMessageConfiguration - a consumer that will call methods on ErrorMessageConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• errorMessageConfiguration(ErrorMessageConfiguration)

overrideConfiguration

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

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