Package software.amazon.awssdk.services.quicksight.model

Interface UpdateAnalysisRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<UpdateAnalysisRequest.Builder,UpdateAnalysisRequest>, QuickSightRequest.Builder, SdkBuilder<UpdateAnalysisRequest.Builder,UpdateAnalysisRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

UpdateAnalysisRequest

@Mutable
@NotThreadSafe
public static interface UpdateAnalysisRequest.Builder
extends QuickSightRequest.Builder, SdkPojo, CopyableBuilder<UpdateAnalysisRequest.Builder,UpdateAnalysisRequest>

Method Summary

Modifier and Type	Method	Description
UpdateAnalysisRequest.Builder	analysisId(String analysisId)	The ID for the analysis that you're updating.
UpdateAnalysisRequest.Builder	awsAccountId(String awsAccountId)	The ID of the Amazon Web Services account that contains the analysis that you're updating.
default UpdateAnalysisRequest.Builder	definition(Consumer<AnalysisDefinition.Builder> definition)	The definition of an analysis.
UpdateAnalysisRequest.Builder	definition(AnalysisDefinition definition)	The definition of an analysis.
UpdateAnalysisRequest.Builder	name(String name)	A descriptive name for the analysis that you're updating.
UpdateAnalysisRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
UpdateAnalysisRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
default UpdateAnalysisRequest.Builder	parameters(Consumer<Parameters.Builder> parameters)	The parameter names and override values that you want to use.
UpdateAnalysisRequest.Builder	parameters(Parameters parameters)	The parameter names and override values that you want to use.
default UpdateAnalysisRequest.Builder	sourceEntity(Consumer<AnalysisSourceEntity.Builder> sourceEntity)	A source entity to use for the analysis that you're updating.
UpdateAnalysisRequest.Builder	sourceEntity(AnalysisSourceEntity sourceEntity)	A source entity to use for the analysis that you're updating.
UpdateAnalysisRequest.Builder	themeArn(String themeArn)	The Amazon Resource Name (ARN) for the theme to apply to the analysis that you're creating.
default UpdateAnalysisRequest.Builder	validationStrategy(Consumer<ValidationStrategy.Builder> validationStrategy)	The option to relax the validation needed to update an analysis with definition objects.
UpdateAnalysisRequest.Builder	validationStrategy(ValidationStrategy validationStrategy)	The option to relax the validation needed to update an analysis with definition objects.

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

overrideConfiguration

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

copy

Methods inherited from interface software.amazon.awssdk.services.quicksight.model.QuickSightRequest.Builder

build

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 Detail

awsAccountId

UpdateAnalysisRequest.Builder awsAccountId(String awsAccountId)

The ID of the Amazon Web Services account that contains the analysis that you're updating.

Parameters:

awsAccountId - The ID of the Amazon Web Services account that contains the analysis that you're updating.

Returns:

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

analysisId

UpdateAnalysisRequest.Builder analysisId(String analysisId)

The ID for the analysis that you're updating. This ID displays in the URL of the analysis.

Parameters:

analysisId - The ID for the analysis that you're updating. This ID displays in the URL of the analysis.

Returns:

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

name

UpdateAnalysisRequest.Builder name(String name)

A descriptive name for the analysis that you're updating. This name displays for the analysis in the QuickSight console.

Parameters:

name - A descriptive name for the analysis that you're updating. This name displays for the analysis in the QuickSight console.

Returns:

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

parameters

UpdateAnalysisRequest.Builder parameters(Parameters parameters)

The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.

Parameters:

parameters - The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.

Returns:

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

parameters

default UpdateAnalysisRequest.Builder parameters(Consumer<Parameters.Builder> parameters)

The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.

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

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

Parameters:

parameters - a consumer that will call methods on Parameters.Builder

Returns:

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

See Also:

parameters(Parameters)

sourceEntity

UpdateAnalysisRequest.Builder sourceEntity(AnalysisSourceEntity sourceEntity)

A source entity to use for the analysis that you're updating. This metadata structure contains details that describe a source template and one or more datasets.

Parameters:

sourceEntity - A source entity to use for the analysis that you're updating. This metadata structure contains details that describe a source template and one or more datasets.

Returns:

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

sourceEntity

default UpdateAnalysisRequest.Builder sourceEntity(Consumer<AnalysisSourceEntity.Builder> sourceEntity)

A source entity to use for the analysis that you're updating. This metadata structure contains details that describe a source template and one or more datasets.

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

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

Parameters:

sourceEntity - a consumer that will call methods on AnalysisSourceEntity.Builder

Returns:

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

See Also:

sourceEntity(AnalysisSourceEntity)

themeArn

UpdateAnalysisRequest.Builder themeArn(String themeArn)

The Amazon Resource Name (ARN) for the theme to apply to the analysis that you're creating. To see the theme in the QuickSight console, make sure that you have access to it.

Parameters:

themeArn - The Amazon Resource Name (ARN) for the theme to apply to the analysis that you're creating. To see the theme in the QuickSight console, make sure that you have access to it.

Returns:

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

definition

UpdateAnalysisRequest.Builder definition(AnalysisDefinition definition)

The definition of an analysis.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

Parameters:

definition - The definition of an analysis.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

Returns:

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

definition

default UpdateAnalysisRequest.Builder definition(Consumer<AnalysisDefinition.Builder> definition)

The definition of an analysis.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

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

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

Parameters:

definition - a consumer that will call methods on AnalysisDefinition.Builder

Returns:

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

See Also:

definition(AnalysisDefinition)

validationStrategy

UpdateAnalysisRequest.Builder validationStrategy(ValidationStrategy validationStrategy)

The option to relax the validation needed to update an analysis with definition objects. This skips the validation step for specific errors.

Parameters:

validationStrategy - The option to relax the validation needed to update an analysis 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 UpdateAnalysisRequest.Builder validationStrategy(Consumer<ValidationStrategy.Builder> validationStrategy)

The option to relax the validation needed to update an analysis 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:

validationStrategy(ValidationStrategy)

overrideConfiguration

UpdateAnalysisRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

UpdateAnalysisRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder