Class Analysis
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Analysis.Builder,
Analysis>
Metadata structure for an analysis in Amazon QuickSight
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The ID of the analysis.final String
arn()
The Amazon Resource Name (ARN) of the analysis.static Analysis.Builder
builder()
final Instant
The time that the analysis was created.The ARNs of the datasets of the analysis.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final List
<AnalysisError> errors()
Errors associated with the analysis.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the DataSetArns property.final boolean
For responses, this returns true if the service returned a value for the Errors property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Sheets property.final Instant
The time that the analysis was last updated.final String
name()
The descriptive name of the analysis.static Class
<? extends Analysis.Builder> sheets()
A list of the associated sheets with the unique identifier and name of each sheet.final ResourceStatus
status()
Status associated with the analysis.final String
Status associated with the analysis.final String
themeArn()
The ARN of the theme of the analysis.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
analysisId
The ID of the analysis.
- Returns:
- The ID of the analysis.
-
arn
The Amazon Resource Name (ARN) of the analysis.
- Returns:
- The Amazon Resource Name (ARN) of the analysis.
-
name
The descriptive name of the analysis.
- Returns:
- The descriptive name of the analysis.
-
status
Status associated with the analysis.
If the service returns an enum value that is not available in the current SDK version,
status
will returnResourceStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- Status associated with the analysis.
- See Also:
-
statusAsString
Status associated with the analysis.
If the service returns an enum value that is not available in the current SDK version,
status
will returnResourceStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- Status associated with the analysis.
- See Also:
-
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 theisEmpty()
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
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 theisEmpty()
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
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
The ARN of the theme of the analysis.
- Returns:
- The ARN of the theme of the analysis.
-
createdTime
The time that the analysis was created.
- Returns:
- The time that the analysis was created.
-
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 theisEmpty()
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
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
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 interfaceToCopyableBuilder<Analysis.Builder,
Analysis> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-