Analysis (AWS Java SDK :: Services :: QuickSight 2.15.15 API)

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

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Analysis.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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()` 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()`
`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 String analysisId()
```
    The ID of the analysis.
    
    Returns:
    
    The ID of the analysis.
  - arn
```
public String arn()
```
    The Amazon Resource Name (ARN) of the analysis.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the analysis.
  - name
```
public String name()
```
    The descriptive name of the analysis.
    
    Returns:
    
    The descriptive name of the analysis.
  - status
```
public 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 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 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 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 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 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 String themeArn()
```
    The ARN of the theme of the analysis.
    
    Returns:
    
    The ARN of the theme of the analysis.
  - createdTime
```
public Instant createdTime()
```
    The time that the analysis was created.
    
    Returns:
    
    The time that the analysis was created.
  - lastUpdatedTime
```
public Instant lastUpdatedTime()
```
    The time that the analysis was last updated.
    
    Returns:
    
    The time that the analysis was last updated.
  - hasSheets
```
public 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 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()
```
    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 int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class Analysis

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

analysisId

arn

name

status

statusAsString

hasErrors

errors

hasDataSetArns

dataSetArns

themeArn

createdTime

lastUpdatedTime

hasSheets

sheets

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields