software.amazon.awssdk.services.quicksight.model

Class Analysis

java.lang.Object

software.amazon.awssdk.services.quicksight.model.Analysis

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Analysis.Builder,Analysis>

@Generated(value="software.amazon.awssdk:codegen")
public final class Analysis
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Analysis.Builder,Analysis>

Metadata structure for an analysis in Amazon QuickSight

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Analysis.Builder

Method Summary

Modifier and Type	Method and Description
String	analysisId() The ID of the analysis.
String	arn() The Amazon Resource Name (ARN) of the analysis.
static Analysis.Builder	builder()
Instant	createdTime() The time that the analysis was created.
List<String>	dataSetArns() The ARNs of the datasets of the analysis.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
List<AnalysisError>	errors() Errors associated with the analysis.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDataSetArns() Returns true if the DataSetArns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasErrors() Returns true if the Errors property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasSheets() Returns true if the Sheets property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
Instant	lastUpdatedTime() The time that the analysis was last updated.
String	name() The descriptive name of the analysis.
List<SdkField<?>>	sdkFields()
static Class<? extends Analysis.Builder>	serializableBuilderClass()
List<Sheet>	sheets() A list of the associated sheets with the unique identifier and name of each sheet.
ResourceStatus	status() Status associated with the analysis.
String	statusAsString() Status associated with the analysis.
String	themeArn() The ARN of the theme of the analysis.
Analysis.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

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.

Returns:

The ID of the analysis.

arn

public final String arn()

The Amazon Resource Name (ARN) of the analysis.

Returns:

The Amazon Resource Name (ARN) of the analysis.

name

public final String name()

The descriptive name of the analysis.

Returns:

The descriptive name of the analysis.

status

public final ResourceStatus status()

Status associated with the analysis.

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

Returns:

Status associated with the analysis.

See Also:

ResourceStatus

statusAsString

public final String statusAsString()

Status associated with the analysis.

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

Returns:

Status associated with the analysis.

See Also:

ResourceStatus

hasErrors

public final boolean hasErrors()

Returns true if the Errors property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

You can use hasErrors() to see if a value was sent in this field.

Returns:

Errors associated with the analysis.

hasDataSetArns

public final boolean hasDataSetArns()

Returns true if the DataSetArns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

dataSetArns

public final List<String> dataSetArns()

The ARNs of the datasets of the analysis.

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

You can use hasDataSetArns() to see if a value was sent in this field.

Returns:

The ARNs of the datasets of the analysis.

themeArn

public final String themeArn()

The ARN of the theme of the analysis.

Returns:

The ARN of the theme of the analysis.

createdTime

public final Instant createdTime()

The time that the analysis was created.

Returns:

The time that the analysis was created.

lastUpdatedTime

public final Instant lastUpdatedTime()

The time that the analysis was last updated.

Returns:

The time that the analysis was last updated.

hasSheets

public final boolean hasSheets()

Returns true if the Sheets property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

sheets

public final List<Sheet> sheets()

A list of the associated sheets with the unique identifier and name of each sheet.

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

You can use hasSheets() to see if a value was sent in this field.

Returns:

A list of the associated sheets with the unique identifier and name of each sheet.

toBuilder

public Analysis.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<Analysis.Builder,Analysis>

Returns:

a builder for type T

builder

public static Analysis.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.