Interface UpdateAnalysisRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<UpdateAnalysisRequest.Builder,
,UpdateAnalysisRequest> QuickSightRequest.Builder
,SdkBuilder<UpdateAnalysisRequest.Builder,
,UpdateAnalysisRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
UpdateAnalysisRequest
-
Method Summary
Modifier and TypeMethodDescriptionanalysisId
(String analysisId) The ID for the analysis that you're updating.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.definition
(AnalysisDefinition definition) The definition of an analysis.A descriptive name for the analysis that you're updating.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.default UpdateAnalysisRequest.Builder
parameters
(Consumer<Parameters.Builder> parameters) The parameter names and override values that you want to use.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.sourceEntity
(AnalysisSourceEntity sourceEntity) A source entity to use for the analysis that you're updating.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.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, sdkFields
-
Method Details
-
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
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
A descriptive name for the analysis that you're updating. This name displays for the analysis in the Amazon QuickSight console.
- Parameters:
name
- A descriptive name for the analysis that you're updating. This name displays for the analysis in the Amazon QuickSight console.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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 theParameters.Builder
avoiding the need to create one manually viaParameters.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toparameters(Parameters)
.- Parameters:
parameters
- a consumer that will call methods onParameters.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theAnalysisSourceEntity.Builder
avoiding the need to create one manually viaAnalysisSourceEntity.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosourceEntity(AnalysisSourceEntity)
.- Parameters:
sourceEntity
- a consumer that will call methods onAnalysisSourceEntity.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
themeArn
The Amazon Resource Name (ARN) for the theme to apply to the analysis that you're creating. To see the theme in the Amazon 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 Amazon 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
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
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 theAnalysisDefinition.Builder
avoiding the need to create one manually viaAnalysisDefinition.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todefinition(AnalysisDefinition)
.- Parameters:
definition
- a consumer that will call methods onAnalysisDefinition.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theValidationStrategy.Builder
avoiding the need to create one manually viaValidationStrategy.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tovalidationStrategy(ValidationStrategy)
.- Parameters:
validationStrategy
- a consumer that will call methods onValidationStrategy.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
UpdateAnalysisRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
UpdateAnalysisRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-