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

Class UpdateAnalysisRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateAnalysisRequest.Builder,UpdateAnalysisRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateAnalysisRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	analysisId()	The ID for the analysis that you're updating.
String	awsAccountId()	The ID of the Amazon Web Services account that contains the analysis that you're updating.
static UpdateAnalysisRequest.Builder	builder()
AnalysisDefinition	definition()	The definition of an analysis.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name()	A descriptive name for the analysis that you're updating.
Parameters	parameters()	The parameter names and override values that you want to use.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateAnalysisRequest.Builder>	serializableBuilderClass()
AnalysisSourceEntity	sourceEntity()	A source entity to use for the analysis that you're updating.
String	themeArn()	The Amazon Resource Name (ARN) for the theme to apply to the analysis that you're creating.
UpdateAnalysisRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
ValidationStrategy	validationStrategy()	The option to relax the validation needed to update an analysis with definition objects.

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 of the Amazon Web Services account that contains the analysis that you're updating.

Returns:

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

analysisId

public final String analysisId()

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

Returns:

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

name

public final String name()

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

Returns:

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

parameters

public final 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:

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.

sourceEntity

public final 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.

Returns:

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.

themeArn

public final 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.

Returns:

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.

definition

public final AnalysisDefinition definition()

The definition of an analysis.

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

Returns:

The definition of an analysis.

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

validationStrategy

public final ValidationStrategy validationStrategy()

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

Returns:

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

toBuilder

public UpdateAnalysisRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateAnalysisRequest.Builder,UpdateAnalysisRequest>

Specified by:

toBuilder in class QuickSightRequest

builder

public static UpdateAnalysisRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateAnalysisRequest.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