/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.quicksight.model; import java.io.Serializable; import javax.annotation.Generated; /** * * @see AWS API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class DescribeDashboardDefinitionResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable { /** *

* The ID of the dashboard described. *

*/ private String dashboardId; /** *

* Errors associated with this dashboard version. *

*/ private java.util.List errors; /** *

* The display name of the dashboard. *

*/ private String name; /** *

* Status associated with the dashboard version. *

* */ private String resourceStatus; /** *

* The ARN of the theme of the dashboard. *

*/ private String themeArn; /** *

* The definition of a dashboard. *

*

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

*/ private DashboardVersionDefinition definition; /** *

* The HTTP status of the request. *

*/ private Integer status; /** *

* The Amazon Web Services request ID for this operation. *

*/ private String requestId; /** *

* Options for publishing the dashboard: *

* */ private DashboardPublishOptions dashboardPublishOptions; /** *

* The ID of the dashboard described. *

* * @param dashboardId * The ID of the dashboard described. */ public void setDashboardId(String dashboardId) { this.dashboardId = dashboardId; } /** *

* The ID of the dashboard described. *

* * @return The ID of the dashboard described. */ public String getDashboardId() { return this.dashboardId; } /** *

* The ID of the dashboard described. *

* * @param dashboardId * The ID of the dashboard described. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeDashboardDefinitionResult withDashboardId(String dashboardId) { setDashboardId(dashboardId); return this; } /** *

* Errors associated with this dashboard version. *

* * @return Errors associated with this dashboard version. */ public java.util.List getErrors() { return errors; } /** *

* Errors associated with this dashboard version. *

* * @param errors * Errors associated with this dashboard version. */ public void setErrors(java.util.Collection errors) { if (errors == null) { this.errors = null; return; } this.errors = new java.util.ArrayList(errors); } /** *

* Errors associated with this dashboard version. *

*

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setErrors(java.util.Collection)} or {@link #withErrors(java.util.Collection)} if you want to override the * existing values. *

* * @param errors * Errors associated with this dashboard version. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeDashboardDefinitionResult withErrors(DashboardError... errors) { if (this.errors == null) { setErrors(new java.util.ArrayList(errors.length)); } for (DashboardError ele : errors) { this.errors.add(ele); } return this; } /** *

* Errors associated with this dashboard version. *

* * @param errors * Errors associated with this dashboard version. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeDashboardDefinitionResult withErrors(java.util.Collection errors) { setErrors(errors); return this; } /** *

* The display name of the dashboard. *

* * @param name * The display name of the dashboard. */ public void setName(String name) { this.name = name; } /** *

* The display name of the dashboard. *

* * @return The display name of the dashboard. */ public String getName() { return this.name; } /** *

* The display name of the dashboard. *

* * @param name * The display name of the dashboard. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeDashboardDefinitionResult withName(String name) { setName(name); return this; } /** *

* Status associated with the dashboard version. *

*
    *
  • *

    * CREATION_IN_PROGRESS *

    *
    • *
  • *

    * CREATION_SUCCESSFUL *

    *
    • *
  • *

    * CREATION_FAILED *

    *
    • *
  • *

    * UPDATE_IN_PROGRESS *

    *
    • *
  • *

    * UPDATE_SUCCESSFUL *

    *
    • *
  • *

    * UPDATE_FAILED *

    *
    • *
  • *

    * DELETED *

    *
    • *
* * @param resourceStatus * Status associated with the dashboard version.

*
    *
  • *

    * CREATION_IN_PROGRESS *

    *
    • *
  • *

    * CREATION_SUCCESSFUL *

    *
    • *
  • *

    * CREATION_FAILED *

    *
    • *
  • *

    * UPDATE_IN_PROGRESS *

    *
    • *
  • *

    * UPDATE_SUCCESSFUL *

    *
    • *
  • *

    * UPDATE_FAILED *

    *
    • *
  • *

    * DELETED *

    *
    • * @see ResourceStatus */ public void setResourceStatus(String resourceStatus) { this.resourceStatus = resourceStatus; } /** *

    * Status associated with the dashboard version. *

    *
      *
    • *

      * CREATION_IN_PROGRESS *

      *
      • *
    • *

      * CREATION_SUCCESSFUL *

      *
      • *
    • *

      * CREATION_FAILED *

      *
      • *
    • *

      * UPDATE_IN_PROGRESS *

      *
      • *
    • *

      * UPDATE_SUCCESSFUL *

      *
      • *
    • *

      * UPDATE_FAILED *

      *
      • *
    • *

      * DELETED *

      *
      • *
    * * @return Status associated with the dashboard version.

    *
      *
    • *

      * CREATION_IN_PROGRESS *

      *
      • *
    • *

      * CREATION_SUCCESSFUL *

      *
      • *
    • *

      * CREATION_FAILED *

      *
      • *
    • *

      * UPDATE_IN_PROGRESS *

      *
      • *
    • *

      * UPDATE_SUCCESSFUL *

      *
      • *
    • *

      * UPDATE_FAILED *

      *
      • *
    • *

      * DELETED *

      *
      • * @see ResourceStatus */ public String getResourceStatus() { return this.resourceStatus; } /** *

      * Status associated with the dashboard version. *

      *
        *
      • *

        * CREATION_IN_PROGRESS *

        *
        • *
      • *

        * CREATION_SUCCESSFUL *

        *
        • *
      • *

        * CREATION_FAILED *

        *
        • *
      • *

        * UPDATE_IN_PROGRESS *

        *
        • *
      • *

        * UPDATE_SUCCESSFUL *

        *
        • *
      • *

        * UPDATE_FAILED *

        *
        • *
      • *

        * DELETED *

        *
        • *
      * * @param resourceStatus * Status associated with the dashboard version.

      *
        *
      • *

        * CREATION_IN_PROGRESS *

        *
        • *
      • *

        * CREATION_SUCCESSFUL *

        *
        • *
      • *

        * CREATION_FAILED *

        *
        • *
      • *

        * UPDATE_IN_PROGRESS *

        *
        • *
      • *

        * UPDATE_SUCCESSFUL *

        *
        • *
      • *

        * UPDATE_FAILED *

        *
        • *
      • *

        * DELETED *

        *
        • * @return Returns a reference to this object so that method calls can be chained together. * @see ResourceStatus */ public DescribeDashboardDefinitionResult withResourceStatus(String resourceStatus) { setResourceStatus(resourceStatus); return this; } /** *

        * Status associated with the dashboard version. *

        *
          *
        • *

          * CREATION_IN_PROGRESS *

          *
          • *
        • *

          * CREATION_SUCCESSFUL *

          *
          • *
        • *

          * CREATION_FAILED *

          *
          • *
        • *

          * UPDATE_IN_PROGRESS *

          *
          • *
        • *

          * UPDATE_SUCCESSFUL *

          *
          • *
        • *

          * UPDATE_FAILED *

          *
          • *
        • *

          * DELETED *

          *
          • *
        * * @param resourceStatus * Status associated with the dashboard version.

        *
          *
        • *

          * CREATION_IN_PROGRESS *

          *
          • *
        • *

          * CREATION_SUCCESSFUL *

          *
          • *
        • *

          * CREATION_FAILED *

          *
          • *
        • *

          * UPDATE_IN_PROGRESS *

          *
          • *
        • *

          * UPDATE_SUCCESSFUL *

          *
          • *
        • *

          * UPDATE_FAILED *

          *
          • *
        • *

          * DELETED *

          *
          • * @return Returns a reference to this object so that method calls can be chained together. * @see ResourceStatus */ public DescribeDashboardDefinitionResult withResourceStatus(ResourceStatus resourceStatus) { this.resourceStatus = resourceStatus.toString(); return this; } /** *

          * The ARN of the theme of the dashboard. *

          * * @param themeArn * The ARN of the theme of the dashboard. */ public void setThemeArn(String themeArn) { this.themeArn = themeArn; } /** *

          * The ARN of the theme of the dashboard. *

          * * @return The ARN of the theme of the dashboard. */ public String getThemeArn() { return this.themeArn; } /** *

          * The ARN of the theme of the dashboard. *

          * * @param themeArn * The ARN of the theme of the dashboard. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeDashboardDefinitionResult withThemeArn(String themeArn) { setThemeArn(themeArn); return this; } /** *

          * The definition of a dashboard. *

          *

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

          * * @param definition * The definition of a dashboard.

          *

          * A definition is the data model of all features in a Dashboard, Template, or Analysis. */ public void setDefinition(DashboardVersionDefinition definition) { this.definition = definition; } /** *

          * The definition of a dashboard. *

          *

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

          * * @return The definition of a dashboard.

          *

          * A definition is the data model of all features in a Dashboard, Template, or Analysis. */ public DashboardVersionDefinition getDefinition() { return this.definition; } /** *

          * The definition of a dashboard. *

          *

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

          * * @param definition * The definition of a dashboard.

          *

          * A definition is the data model of all features in a Dashboard, Template, or Analysis. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeDashboardDefinitionResult withDefinition(DashboardVersionDefinition definition) { setDefinition(definition); return this; } /** *

          * The HTTP status of the request. *

          * * @param status * The HTTP status of the request. */ public void setStatus(Integer status) { this.status = status; } /** *

          * The HTTP status of the request. *

          * * @return The HTTP status of the request. */ public Integer getStatus() { return this.status; } /** *

          * The HTTP status of the request. *

          * * @param status * The HTTP status of the request. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeDashboardDefinitionResult withStatus(Integer status) { setStatus(status); return this; } /** *

          * The Amazon Web Services request ID for this operation. *

          * * @param requestId * The Amazon Web Services request ID for this operation. */ public void setRequestId(String requestId) { this.requestId = requestId; } /** *

          * The Amazon Web Services request ID for this operation. *

          * * @return The Amazon Web Services request ID for this operation. */ public String getRequestId() { return this.requestId; } /** *

          * The Amazon Web Services request ID for this operation. *

          * * @param requestId * The Amazon Web Services request ID for this operation. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeDashboardDefinitionResult withRequestId(String requestId) { setRequestId(requestId); return this; } /** *

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

            *
            • *
          * * @param 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. *

            *
            • */ public void setDashboardPublishOptions(DashboardPublishOptions dashboardPublishOptions) { this.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. *

              *
              • *
            * * @return 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. *

              *
              • */ public DashboardPublishOptions getDashboardPublishOptions() { return this.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. *

                *
                • *
              * * @param 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. *

                *
                • * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeDashboardDefinitionResult withDashboardPublishOptions(DashboardPublishOptions dashboardPublishOptions) { setDashboardPublishOptions(dashboardPublishOptions); return this; } /** * 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. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getDashboardId() != null) sb.append("DashboardId: ").append(getDashboardId()).append(","); if (getErrors() != null) sb.append("Errors: ").append(getErrors()).append(","); if (getName() != null) sb.append("Name: ").append(getName()).append(","); if (getResourceStatus() != null) sb.append("ResourceStatus: ").append(getResourceStatus()).append(","); if (getThemeArn() != null) sb.append("ThemeArn: ").append(getThemeArn()).append(","); if (getDefinition() != null) sb.append("Definition: ").append(getDefinition()).append(","); if (getStatus() != null) sb.append("Status: ").append(getStatus()).append(","); if (getRequestId() != null) sb.append("RequestId: ").append(getRequestId()).append(","); if (getDashboardPublishOptions() != null) sb.append("DashboardPublishOptions: ").append(getDashboardPublishOptions()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof DescribeDashboardDefinitionResult == false) return false; DescribeDashboardDefinitionResult other = (DescribeDashboardDefinitionResult) obj; if (other.getDashboardId() == null ^ this.getDashboardId() == null) return false; if (other.getDashboardId() != null && other.getDashboardId().equals(this.getDashboardId()) == false) return false; if (other.getErrors() == null ^ this.getErrors() == null) return false; if (other.getErrors() != null && other.getErrors().equals(this.getErrors()) == false) return false; if (other.getName() == null ^ this.getName() == null) return false; if (other.getName() != null && other.getName().equals(this.getName()) == false) return false; if (other.getResourceStatus() == null ^ this.getResourceStatus() == null) return false; if (other.getResourceStatus() != null && other.getResourceStatus().equals(this.getResourceStatus()) == false) return false; if (other.getThemeArn() == null ^ this.getThemeArn() == null) return false; if (other.getThemeArn() != null && other.getThemeArn().equals(this.getThemeArn()) == false) return false; if (other.getDefinition() == null ^ this.getDefinition() == null) return false; if (other.getDefinition() != null && other.getDefinition().equals(this.getDefinition()) == false) return false; if (other.getStatus() == null ^ this.getStatus() == null) return false; if (other.getStatus() != null && other.getStatus().equals(this.getStatus()) == false) return false; if (other.getRequestId() == null ^ this.getRequestId() == null) return false; if (other.getRequestId() != null && other.getRequestId().equals(this.getRequestId()) == false) return false; if (other.getDashboardPublishOptions() == null ^ this.getDashboardPublishOptions() == null) return false; if (other.getDashboardPublishOptions() != null && other.getDashboardPublishOptions().equals(this.getDashboardPublishOptions()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getDashboardId() == null) ? 0 : getDashboardId().hashCode()); hashCode = prime * hashCode + ((getErrors() == null) ? 0 : getErrors().hashCode()); hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode()); hashCode = prime * hashCode + ((getResourceStatus() == null) ? 0 : getResourceStatus().hashCode()); hashCode = prime * hashCode + ((getThemeArn() == null) ? 0 : getThemeArn().hashCode()); hashCode = prime * hashCode + ((getDefinition() == null) ? 0 : getDefinition().hashCode()); hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode()); hashCode = prime * hashCode + ((getRequestId() == null) ? 0 : getRequestId().hashCode()); hashCode = prime * hashCode + ((getDashboardPublishOptions() == null) ? 0 : getDashboardPublishOptions().hashCode()); return hashCode; } @Override public DescribeDashboardDefinitionResult clone() { try { return (DescribeDashboardDefinitionResult) super.clone(); } catch (CloneNotSupportedException e) { throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e); } } }