Interface CreateDashboardRequest.Builder

All Superinterfaces:

AwsRequest.Builder, BcmDashboardsRequest.Builder, Buildable, CopyableBuilder<CreateDashboardRequest.Builder,CreateDashboardRequest>, SdkBuilder<CreateDashboardRequest.Builder,CreateDashboardRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateDashboardRequest

@Mutable
@NotThreadSafe
public static interface CreateDashboardRequest.Builder
extends BcmDashboardsRequest.Builder, SdkPojo, CopyableBuilder<CreateDashboardRequest.Builder,CreateDashboardRequest>

Method Summary

Modifier and Type	Method	Description
CreateDashboardRequest.Builder	description(String description)	A description of the dashboard's purpose or contents.
CreateDashboardRequest.Builder	name(String name)	The name of the dashboard.
CreateDashboardRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateDashboardRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
CreateDashboardRequest.Builder	resourceTags(Collection<ResourceTag> resourceTags)	The tags to apply to the dashboard resource for organization and management.
CreateDashboardRequest.Builder	resourceTags(Consumer<ResourceTag.Builder>... resourceTags)	The tags to apply to the dashboard resource for organization and management.
CreateDashboardRequest.Builder	resourceTags(ResourceTag... resourceTags)	The tags to apply to the dashboard resource for organization and management.
CreateDashboardRequest.Builder	widgets(Collection<Widget> widgets)	An array of widget configurations that define the visualizations to be displayed in the dashboard.
CreateDashboardRequest.Builder	widgets(Consumer<Widget.Builder>... widgets)	An array of widget configurations that define the visualizations to be displayed in the dashboard.
CreateDashboardRequest.Builder	widgets(Widget... widgets)	An array of widget configurations that define the visualizations to be displayed in the dashboard.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.bcmdashboards.model.BcmDashboardsRequest.Builder

build

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

copy

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

name

CreateDashboardRequest.Builder name(String name)

The name of the dashboard. The name must be unique within your account.

Parameters:

name - The name of the dashboard. The name must be unique within your account.

Returns:

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

description

CreateDashboardRequest.Builder description(String description)

A description of the dashboard's purpose or contents.

Parameters:

description - A description of the dashboard's purpose or contents.

Returns:

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

widgets

CreateDashboardRequest.Builder widgets(Collection<Widget> widgets)

An array of widget configurations that define the visualizations to be displayed in the dashboard. Each dashboard can contain up to 20 widgets.

Parameters:

widgets - An array of widget configurations that define the visualizations to be displayed in the dashboard. Each dashboard can contain up to 20 widgets.

Returns:

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

widgets

CreateDashboardRequest.Builder widgets(Widget... widgets)

An array of widget configurations that define the visualizations to be displayed in the dashboard. Each dashboard can contain up to 20 widgets.

Parameters:

widgets - An array of widget configurations that define the visualizations to be displayed in the dashboard. Each dashboard can contain up to 20 widgets.

Returns:

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

widgets

CreateDashboardRequest.Builder widgets(Consumer<Widget.Builder>... widgets)

An array of widget configurations that define the visualizations to be displayed in the dashboard. Each dashboard can contain up to 20 widgets.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to widgets(List<Widget>).

Parameters:

widgets - a consumer that will call methods on Widget.Builder

Returns:

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

See Also:

• widgets(java.util.Collection<Widget>)

resourceTags

CreateDashboardRequest.Builder resourceTags(Collection<ResourceTag> resourceTags)

The tags to apply to the dashboard resource for organization and management.

Parameters:

resourceTags - The tags to apply to the dashboard resource for organization and management.

Returns:

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

resourceTags

CreateDashboardRequest.Builder resourceTags(ResourceTag... resourceTags)

The tags to apply to the dashboard resource for organization and management.

Parameters:

resourceTags - The tags to apply to the dashboard resource for organization and management.

Returns:

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

resourceTags

CreateDashboardRequest.Builder resourceTags(Consumer<ResourceTag.Builder>... resourceTags)

The tags to apply to the dashboard resource for organization and management.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to resourceTags(List<ResourceTag>).

Parameters:

resourceTags - a consumer that will call methods on ResourceTag.Builder

Returns:

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

See Also:

• resourceTags(java.util.Collection<ResourceTag>)

overrideConfiguration

CreateDashboardRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateDashboardRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.