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

Class DescribeDashboardDefinitionResponse

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.DescribeDashboardDefinitionResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeDashboardDefinitionResponse.Builder,DescribeDashboardDefinitionResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeDashboardDefinitionResponse.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeDashboardDefinitionResponse.Builder	builder()
String	dashboardId()	The ID of the dashboard described.
DashboardPublishOptions	dashboardPublishOptions()	Options for publishing the dashboard:
DashboardVersionDefinition	definition()	The definition of a dashboard.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<DashboardError>	errors()	Errors associated with this dashboard version.
<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 display name of the dashboard.
String	requestId()	The Amazon Web Services request ID for this operation.
ResourceStatus	resourceStatus()	Status associated with the dashboard version.
String	resourceStatusAsString()	Status associated with the dashboard version.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeDashboardDefinitionResponse.Builder>	serializableBuilderClass()
Integer	status()	The HTTP status of the request.
String	themeArn()	The ARN of the theme of the dashboard.
DescribeDashboardDefinitionResponse.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

dashboardId

public final String dashboardId()

The ID of the dashboard described.

Returns:

The ID of the dashboard described.

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

Errors associated with this dashboard version.

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 this dashboard version.

name

public final String name()

The display name of the dashboard.

Returns:

The display name of the dashboard.

resourceStatus

public final ResourceStatus resourceStatus()

Status associated with the dashboard version.

• 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 dashboard version.

• 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 dashboard version.

• 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 dashboard version.

• 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 dashboard.

Returns:

The ARN of the theme of the dashboard.

definition

public final DashboardVersionDefinition definition()

The definition of a dashboard.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

Returns:

The definition of a dashboard.

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.

dashboardPublishOptions

public final DashboardPublishOptions dashboardPublishOptions()

Options for publishing the dashboard:

• AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED. When this is set to DISABLED, Amazon QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default.

• AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED. The visual option to export data to .CSV format isn't enabled when this is set to DISABLED. This option is ENABLED by default.

• VisibilityState for SheetControlsOption - This visibility state can be either COLLAPSED or EXPANDED. This option is COLLAPSED by default.

Returns:

Options for publishing the dashboard:

• AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED. When this is set to DISABLED, Amazon QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default.

• AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED. The visual option to export data to .CSV format isn't enabled when this is set to DISABLED. This option is ENABLED by default.

• VisibilityState for SheetControlsOption - This visibility state can be either COLLAPSED or EXPANDED. This option is COLLAPSED by default.

toBuilder

public DescribeDashboardDefinitionResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeDashboardDefinitionResponse.Builder,DescribeDashboardDefinitionResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static DescribeDashboardDefinitionResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeDashboardDefinitionResponse.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