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

Interface DescribeDashboardDefinitionResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<DescribeDashboardDefinitionResponse.Builder,DescribeDashboardDefinitionResponse>, QuickSightResponse.Builder, SdkBuilder<DescribeDashboardDefinitionResponse.Builder,DescribeDashboardDefinitionResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

DescribeDashboardDefinitionResponse

@Mutable
@NotThreadSafe
public static interface DescribeDashboardDefinitionResponse.Builder
extends QuickSightResponse.Builder, SdkPojo, CopyableBuilder<DescribeDashboardDefinitionResponse.Builder,DescribeDashboardDefinitionResponse>

Method Summary

Modifier and Type	Method	Description
DescribeDashboardDefinitionResponse.Builder	dashboardId(String dashboardId)	The ID of the dashboard described.
default DescribeDashboardDefinitionResponse.Builder	dashboardPublishOptions(Consumer<DashboardPublishOptions.Builder> dashboardPublishOptions)	Options for publishing the dashboard:
DescribeDashboardDefinitionResponse.Builder	dashboardPublishOptions(DashboardPublishOptions dashboardPublishOptions)	Options for publishing the dashboard:
default DescribeDashboardDefinitionResponse.Builder	definition(Consumer<DashboardVersionDefinition.Builder> definition)	The definition of a dashboard.
DescribeDashboardDefinitionResponse.Builder	definition(DashboardVersionDefinition definition)	The definition of a dashboard.
DescribeDashboardDefinitionResponse.Builder	errors(Collection<DashboardError> errors)	Errors associated with this dashboard version.
DescribeDashboardDefinitionResponse.Builder	errors(Consumer<DashboardError.Builder>... errors)	Errors associated with this dashboard version.
DescribeDashboardDefinitionResponse.Builder	errors(DashboardError... errors)	Errors associated with this dashboard version.
DescribeDashboardDefinitionResponse.Builder	name(String name)	The display name of the dashboard.
DescribeDashboardDefinitionResponse.Builder	requestId(String requestId)	The Amazon Web Services request ID for this operation.
DescribeDashboardDefinitionResponse.Builder	resourceStatus(String resourceStatus)	Status associated with the dashboard version.
DescribeDashboardDefinitionResponse.Builder	resourceStatus(ResourceStatus resourceStatus)	Status associated with the dashboard version.
DescribeDashboardDefinitionResponse.Builder	status(Integer status)	The HTTP status of the request.
DescribeDashboardDefinitionResponse.Builder	themeArn(String themeArn)	The ARN of the theme of the dashboard.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.services.quicksight.model.QuickSightResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Detail

dashboardId

DescribeDashboardDefinitionResponse.Builder dashboardId(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.

errors

DescribeDashboardDefinitionResponse.Builder errors(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.

errors

DescribeDashboardDefinitionResponse.Builder errors(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.

errors

DescribeDashboardDefinitionResponse.Builder errors(Consumer<DashboardError.Builder>... errors)

Errors associated with this dashboard version.

This is a convenience method that creates an instance of the DashboardError.Builder avoiding the need to create one manually via DashboardError.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #errors(List).

Parameters:

errors - a consumer that will call methods on DashboardError.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#errors(java.util.Collection)

name

DescribeDashboardDefinitionResponse.Builder name(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.

resourceStatus

DescribeDashboardDefinitionResponse.Builder resourceStatus(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, ResourceStatus

resourceStatus

DescribeDashboardDefinitionResponse.Builder resourceStatus(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, ResourceStatus

themeArn

DescribeDashboardDefinitionResponse.Builder themeArn(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.

definition

DescribeDashboardDefinitionResponse.Builder definition(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.

definition

default DescribeDashboardDefinitionResponse.Builder definition(Consumer<DashboardVersionDefinition.Builder> definition)

The definition of a dashboard.

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

This is a convenience method that creates an instance of the DashboardVersionDefinition.Builder avoiding the need to create one manually via DashboardVersionDefinition.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to definition(DashboardVersionDefinition).

Parameters:

definition - a consumer that will call methods on DashboardVersionDefinition.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

definition(DashboardVersionDefinition)

status

DescribeDashboardDefinitionResponse.Builder status(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.

requestId

DescribeDashboardDefinitionResponse.Builder requestId(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.

dashboardPublishOptions

DescribeDashboardDefinitionResponse.Builder dashboardPublishOptions(DashboardPublishOptions dashboardPublishOptions)

Options for publishing the dashboard:

• AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED. When this is set to DISABLED, 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.

• AvailabilityStatus for ExecutiveSummaryOption - This status can be either ENABLED or DISABLED. The option to build an executive summary is disabled when this is set to DISABLED. This option is ENABLED by default.

• AvailabilityStatus for DataStoriesSharingOption - This status can be either ENABLED or DISABLED. The option to share a data story is disabled when this is set to DISABLED. This option is ENABLED 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, 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.

• AvailabilityStatus for ExecutiveSummaryOption - This status can be either ENABLED or DISABLED. The option to build an executive summary is disabled when this is set to DISABLED. This option is ENABLED by default.

• AvailabilityStatus for DataStoriesSharingOption - This status can be either ENABLED or DISABLED. The option to share a data story is disabled when this is set to DISABLED. This option is ENABLED by default.

Returns:

Returns a reference to this object so that method calls can be chained together.

dashboardPublishOptions

default DescribeDashboardDefinitionResponse.Builder dashboardPublishOptions(Consumer<DashboardPublishOptions.Builder> dashboardPublishOptions)

Options for publishing the dashboard:

• AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED. When this is set to DISABLED, 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.

• AvailabilityStatus for ExecutiveSummaryOption - This status can be either ENABLED or DISABLED. The option to build an executive summary is disabled when this is set to DISABLED. This option is ENABLED by default.

• AvailabilityStatus for DataStoriesSharingOption - This status can be either ENABLED or DISABLED. The option to share a data story is disabled when this is set to DISABLED. This option is ENABLED by default.

This is a convenience method that creates an instance of the DashboardPublishOptions.Builder avoiding the need to create one manually via DashboardPublishOptions.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dashboardPublishOptions(DashboardPublishOptions).

Parameters:

dashboardPublishOptions - a consumer that will call methods on DashboardPublishOptions.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

dashboardPublishOptions(DashboardPublishOptions)