DescribeDashboardDefinitionResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.quicksight.model.DescribeDashboardDefinitionResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeDashboardDefinitionResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DescribeDashboardDefinitionResult()

Constructors
Constructor and Description
`DescribeDashboardDefinitionResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DescribeDashboardDefinitionResult`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getDashboardId()` The ID of the dashboard described.
`DashboardPublishOptions`	`getDashboardPublishOptions()` Options for publishing the dashboard:
`DashboardVersionDefinition`	`getDefinition()` The definition of a dashboard.
`List<DashboardError>`	`getErrors()` Errors associated with this dashboard version.
`String`	`getName()` The display name of the dashboard.
`String`	`getRequestId()` The Amazon Web Services request ID for this operation.
`String`	`getResourceStatus()` Status associated with the dashboard version.
`Integer`	`getStatus()` The HTTP status of the request.
`String`	`getThemeArn()` The ARN of the theme of the dashboard.
`int`	`hashCode()`
`void`	`setDashboardId(String dashboardId)` The ID of the dashboard described.
`void`	`setDashboardPublishOptions(DashboardPublishOptions dashboardPublishOptions)` Options for publishing the dashboard:
`void`	`setDefinition(DashboardVersionDefinition definition)` The definition of a dashboard.
`void`	`setErrors(Collection<DashboardError> errors)` Errors associated with this dashboard version.
`void`	`setName(String name)` The display name of the dashboard.
`void`	`setRequestId(String requestId)` The Amazon Web Services request ID for this operation.
`void`	`setResourceStatus(String resourceStatus)` Status associated with the dashboard version.
`void`	`setStatus(Integer status)` The HTTP status of the request.
`void`	`setThemeArn(String themeArn)` The ARN of the theme of the dashboard.
`String`	`toString()` Returns a string representation of this object.
`DescribeDashboardDefinitionResult`	`withDashboardId(String dashboardId)` The ID of the dashboard described.
`DescribeDashboardDefinitionResult`	`withDashboardPublishOptions(DashboardPublishOptions dashboardPublishOptions)` Options for publishing the dashboard:
`DescribeDashboardDefinitionResult`	`withDefinition(DashboardVersionDefinition definition)` The definition of a dashboard.
`DescribeDashboardDefinitionResult`	`withErrors(Collection<DashboardError> errors)` Errors associated with this dashboard version.
`DescribeDashboardDefinitionResult`	`withErrors(DashboardError... errors)` Errors associated with this dashboard version.
`DescribeDashboardDefinitionResult`	`withName(String name)` The display name of the dashboard.
`DescribeDashboardDefinitionResult`	`withRequestId(String requestId)` The Amazon Web Services request ID for this operation.
`DescribeDashboardDefinitionResult`	`withResourceStatus(ResourceStatus resourceStatus)` Status associated with the dashboard version.
`DescribeDashboardDefinitionResult`	`withResourceStatus(String resourceStatus)` Status associated with the dashboard version.
`DescribeDashboardDefinitionResult`	`withStatus(Integer status)` The HTTP status of the request.
`DescribeDashboardDefinitionResult`	`withThemeArn(String themeArn)` The ARN of the theme of the dashboard.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DescribeDashboardDefinitionResult
```
public DescribeDashboardDefinitionResult()
```
- Method Detail
  - setDashboardId
```
public void setDashboardId(String dashboardId)
```
    The ID of the dashboard described.
    
    Parameters:
    
    dashboardId - The ID of the dashboard described.
  - getDashboardId
```
public String getDashboardId()
```
    The ID of the dashboard described.
    
    Returns:
    
    The ID of the dashboard described.
  - withDashboardId
```
public DescribeDashboardDefinitionResult withDashboardId(String dashboardId)
```
    The ID of the dashboard described.
    
    Parameters:
    
    dashboardId - The ID of the dashboard described.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getErrors
```
public List<DashboardError> getErrors()
```
    Errors associated with this dashboard version.
    
    Returns:
    
    Errors associated with this dashboard version.
  - setErrors
```
public void setErrors(Collection<DashboardError> errors)
```
    Errors associated with this dashboard version.
    
    Parameters:
    
    errors - Errors associated with this dashboard version.
  - withErrors
```
public DescribeDashboardDefinitionResult withErrors(DashboardError... errors)
```
    Errors associated with this dashboard version.
    
    NOTE: This method appends the values to the existing list (if any). Use setErrors(java.util.Collection) or withErrors(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    errors - Errors associated with this dashboard version.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withErrors
```
public DescribeDashboardDefinitionResult withErrors(Collection<DashboardError> errors)
```
    Errors associated with this dashboard version.
    
    Parameters:
    
    errors - Errors associated with this dashboard version.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The display name of the dashboard.
    
    Parameters:
    
    name - The display name of the dashboard.
  - getName
```
public String getName()
```
    The display name of the dashboard.
    
    Returns:
    
    The display name of the dashboard.
  - withName
```
public DescribeDashboardDefinitionResult withName(String name)
```
    The display name of the dashboard.
    
    Parameters:
    
    name - The display name of the dashboard.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setResourceStatus
```
public void setResourceStatus(String resourceStatus)
```
    Status associated with the dashboard version.
    - CREATION_IN_PROGRESS
    - CREATION_SUCCESSFUL
    - CREATION_FAILED
    - UPDATE_IN_PROGRESS
    - UPDATE_SUCCESSFUL
    - UPDATE_FAILED
    - DELETED
    Parameters:
    resourceStatus - Status associated with the dashboard version.
    
    CREATION_IN_PROGRESS
    
    CREATION_SUCCESSFUL
    
    CREATION_FAILED
    
    UPDATE_IN_PROGRESS
    
    UPDATE_SUCCESSFUL
    
    UPDATE_FAILED
    
    DELETED
    See Also:
    
    ResourceStatus
  - getResourceStatus
```
public String getResourceStatus()
```
    Status associated with the dashboard version.
    - CREATION_IN_PROGRESS
    - CREATION_SUCCESSFUL
    - CREATION_FAILED
    - UPDATE_IN_PROGRESS
    - UPDATE_SUCCESSFUL
    - UPDATE_FAILED
    - DELETED
    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
  - withResourceStatus
```
public DescribeDashboardDefinitionResult withResourceStatus(String resourceStatus)
```
    Status associated with the dashboard version.
    - CREATION_IN_PROGRESS
    - CREATION_SUCCESSFUL
    - CREATION_FAILED
    - UPDATE_IN_PROGRESS
    - UPDATE_SUCCESSFUL
    - UPDATE_FAILED
    - DELETED
    Parameters:
    resourceStatus - Status associated with the dashboard version.
    
    CREATION_IN_PROGRESS
    
    CREATION_SUCCESSFUL
    
    CREATION_FAILED
    
    UPDATE_IN_PROGRESS
    
    UPDATE_SUCCESSFUL
    
    UPDATE_FAILED
    
    DELETED
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ResourceStatus
  - withResourceStatus
```
public DescribeDashboardDefinitionResult withResourceStatus(ResourceStatus resourceStatus)
```
    Status associated with the dashboard version.
    - CREATION_IN_PROGRESS
    - CREATION_SUCCESSFUL
    - CREATION_FAILED
    - UPDATE_IN_PROGRESS
    - UPDATE_SUCCESSFUL
    - UPDATE_FAILED
    - DELETED
    Parameters:
    resourceStatus - Status associated with the dashboard version.
    
    CREATION_IN_PROGRESS
    
    CREATION_SUCCESSFUL
    
    CREATION_FAILED
    
    UPDATE_IN_PROGRESS
    
    UPDATE_SUCCESSFUL
    
    UPDATE_FAILED
    
    DELETED
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ResourceStatus
  - setThemeArn
```
public void setThemeArn(String themeArn)
```
    The ARN of the theme of the dashboard.
    
    Parameters:
    
    themeArn - The ARN of the theme of the dashboard.
  - getThemeArn
```
public String getThemeArn()
```
    The ARN of the theme of the dashboard.
    
    Returns:
    
    The ARN of the theme of the dashboard.
  - withThemeArn
```
public DescribeDashboardDefinitionResult withThemeArn(String themeArn)
```
    The ARN of the theme of the dashboard.
    
    Parameters:
    
    themeArn - The ARN of the theme of the dashboard.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDefinition
```
public void setDefinition(DashboardVersionDefinition definition)
```
    The definition of a dashboard.
    
    A definition is the data model of all features in a Dashboard, Template, or Analysis.
    
    Parameters:
    
    definition - The definition of a dashboard.
    
    A definition is the data model of all features in a Dashboard, Template, or Analysis.
  - getDefinition
```
public DashboardVersionDefinition getDefinition()
```
    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.
  - withDefinition
```
public DescribeDashboardDefinitionResult withDefinition(DashboardVersionDefinition definition)
```
    The definition of a dashboard.
    
    A definition is the data model of all features in a Dashboard, Template, or Analysis.
    
    Parameters:
    
    definition - The definition of a dashboard.
    
    A definition is the data model of all features in a Dashboard, Template, or Analysis.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(Integer status)
```
    The HTTP status of the request.
    
    Parameters:
    
    status - The HTTP status of the request.
  - getStatus
```
public Integer getStatus()
```
    The HTTP status of the request.
    
    Returns:
    
    The HTTP status of the request.
  - withStatus
```
public DescribeDashboardDefinitionResult withStatus(Integer status)
```
    The HTTP status of the request.
    
    Parameters:
    
    status - The HTTP status of the request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRequestId
```
public void setRequestId(String requestId)
```
    The Amazon Web Services request ID for this operation.
    
    Parameters:
    
    requestId - The Amazon Web Services request ID for this operation.
  - getRequestId
```
public String getRequestId()
```
    The Amazon Web Services request ID for this operation.
    
    Returns:
    
    The Amazon Web Services request ID for this operation.
  - withRequestId
```
public DescribeDashboardDefinitionResult withRequestId(String requestId)
```
    The Amazon Web Services request ID for this operation.
    
    Parameters:
    
    requestId - The Amazon Web Services request ID for this operation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDashboardPublishOptions
```
public void setDashboardPublishOptions(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.
    Parameters:
    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.
  - getDashboardPublishOptions
```
public DashboardPublishOptions getDashboardPublishOptions()
```
    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.
  - withDashboardPublishOptions
```
public DescribeDashboardDefinitionResult withDashboardPublishOptions(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.
    Parameters:
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DescribeDashboardDefinitionResult clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.780

Class DescribeDashboardDefinitionResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

DescribeDashboardDefinitionResult

Method Detail

setDashboardId

getDashboardId

withDashboardId

getErrors

setErrors

withErrors

withErrors

setName

getName

withName

setResourceStatus

getResourceStatus

withResourceStatus

withResourceStatus

setThemeArn

getThemeArn

withThemeArn

setDefinition

getDefinition

withDefinition

setStatus

getStatus

withStatus

setRequestId

getRequestId

withRequestId

setDashboardPublishOptions

getDashboardPublishOptions

withDashboardPublishOptions

toString

equals

hashCode

clone