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

Class DescribeAnalysisDefinitionResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.quicksight.model.QuickSightResponse

software.amazon.awssdk.services.quicksight.model.DescribeAnalysisDefinitionResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeAnalysisDefinitionResponse.Builder,DescribeAnalysisDefinitionResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeAnalysisDefinitionResponse.Builder

Method Summary

Modifier and Type	Method	Description
String	analysisId()	The ID of the analysis described.
static DescribeAnalysisDefinitionResponse.Builder	builder()
AnalysisDefinition	definition()	The definition of an analysis.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<AnalysisError>	errors()	Errors associated with the analysis.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasErrors()	For responses, this returns true if the service returned a value for the Errors property.
int	hashCode()
String	name()	The descriptive name of the analysis.
String	requestId()	The Amazon Web Services request ID for this operation.
ResourceStatus	resourceStatus()	Status associated with the analysis.
String	resourceStatusAsString()	Status associated with the analysis.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeAnalysisDefinitionResponse.Builder>	serializableBuilderClass()
Integer	status()	The HTTP status of the request.
String	themeArn()	The ARN of the theme of the analysis.
DescribeAnalysisDefinitionResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.quicksight.model.QuickSightResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

analysisId

public final String analysisId()

The ID of the analysis described.

Returns:

The ID of the analysis described.

name

public final String name()

The descriptive name of the analysis.

Returns:

The descriptive name of the analysis.

hasErrors

public final boolean hasErrors()

For responses, this returns true if the service returned a value for the Errors property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

errors

public final List<AnalysisError> errors()

Errors associated with the analysis.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasErrors() method.

Returns:

Errors associated with the analysis.

resourceStatus

public final ResourceStatus resourceStatus()

Status associated with the analysis.

• CREATION_IN_PROGRESS

• CREATION_SUCCESSFUL

• CREATION_FAILED

• UPDATE_IN_PROGRESS

• UPDATE_SUCCESSFUL

• UPDATE_FAILED

• DELETED

If the service returns an enum value that is not available in the current SDK version, resourceStatus will return ResourceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceStatusAsString().

Returns:

Status associated with the analysis.

• CREATION_IN_PROGRESS

• CREATION_SUCCESSFUL

• CREATION_FAILED

• UPDATE_IN_PROGRESS

• UPDATE_SUCCESSFUL

• UPDATE_FAILED

• DELETED

See Also:

ResourceStatus

resourceStatusAsString

public final String resourceStatusAsString()

Status associated with the analysis.

• CREATION_IN_PROGRESS

• CREATION_SUCCESSFUL

• CREATION_FAILED

• UPDATE_IN_PROGRESS

• UPDATE_SUCCESSFUL

• UPDATE_FAILED

• DELETED

If the service returns an enum value that is not available in the current SDK version, resourceStatus will return ResourceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceStatusAsString().

Returns:

Status associated with the analysis.

• CREATION_IN_PROGRESS

• CREATION_SUCCESSFUL

• CREATION_FAILED

• UPDATE_IN_PROGRESS

• UPDATE_SUCCESSFUL

• UPDATE_FAILED

• DELETED

See Also:

ResourceStatus

themeArn

public final String themeArn()

The ARN of the theme of the analysis.

Returns:

The ARN of the theme of the analysis.

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.

status

public final Integer status()

The HTTP status of the request.

Returns:

The HTTP status of the request.

requestId

public final String requestId()

The Amazon Web Services request ID for this operation.

Returns:

The Amazon Web Services request ID for this operation.

toBuilder

public DescribeAnalysisDefinitionResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeAnalysisDefinitionResponse.Builder,DescribeAnalysisDefinitionResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static DescribeAnalysisDefinitionResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeAnalysisDefinitionResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo