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>

  • Method Details

    • 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:

    • 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:

    • 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()
      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<DescribeDashboardDefinitionResponse.Builder,DescribeDashboardDefinitionResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • 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)
      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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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