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)
List<AnalysisError>	errors() Errors associated with the analysis.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDataSetArns() For responses, this returns true if the service returned a value for the DataSetArns property.
boolean	hasErrors() For responses, this returns true if the service returned a value for the Errors property.
int	hashCode()
boolean	hasSheets() For responses, this returns true if the service returned a value for the Sheets property.
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()
String	toString() Returns a string representation of this object.

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.

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()

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.

hasDataSetArns

public final boolean hasDataSetArns()

For responses, this returns true if the service returned a value for the DataSetArns 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.

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.

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 hasDataSetArns() method.

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()

For responses, this returns true if the service returned a value for the Sheets 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.

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.

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 hasSheets() method.

Returns:

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

toBuilder

public Analysis.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Analysis.Builder,Analysis>

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)

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo