Interface UpdateDashboardRequest.Builder

All Superinterfaces:

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

Enclosing class:

UpdateDashboardRequest

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

Method Summary

Modifier and Type	Method	Description
UpdateDashboardRequest.Builder	arn(String arn)	The ARN of the dashboard to update.
UpdateDashboardRequest.Builder	description(String description)	The new description for the dashboard.
UpdateDashboardRequest.Builder	name(String name)	The new name for the dashboard.
UpdateDashboardRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
UpdateDashboardRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
UpdateDashboardRequest.Builder	widgets(Collection<Widget> widgets)	The updated array of widget configurations for the dashboard.
UpdateDashboardRequest.Builder	widgets(Consumer<Widget.Builder>... widgets)	The updated array of widget configurations for the dashboard.
UpdateDashboardRequest.Builder	widgets(Widget... widgets)	The updated array of widget configurations for 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

arn

UpdateDashboardRequest.Builder arn(String arn)

The ARN of the dashboard to update.

Parameters:

arn - The ARN of the dashboard to update.

Returns:

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

name

UpdateDashboardRequest.Builder name(String name)

The new name for the dashboard. If not specified, the existing name is retained.

Parameters:

name - The new name for the dashboard. If not specified, the existing name is retained.

Returns:

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

description

UpdateDashboardRequest.Builder description(String description)

The new description for the dashboard. If not specified, the existing description is retained.

Parameters:

description - The new description for the dashboard. If not specified, the existing description is retained.

Returns:

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

widgets

UpdateDashboardRequest.Builder widgets(Collection<Widget> widgets)

The updated array of widget configurations for the dashboard. Replaces all existing widgets.

Parameters:

widgets - The updated array of widget configurations for the dashboard. Replaces all existing widgets.

Returns:

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

widgets

UpdateDashboardRequest.Builder widgets(Widget... widgets)

The updated array of widget configurations for the dashboard. Replaces all existing widgets.

Parameters:

widgets - The updated array of widget configurations for the dashboard. Replaces all existing widgets.

Returns:

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

widgets

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

The updated array of widget configurations for the dashboard. Replaces all existing 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>)

overrideConfiguration

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

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