Interface CreateDashboardRequest.Builder

All Superinterfaces:

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

Enclosing class:

CreateDashboardRequest

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

Method Summary

Modifier and Type	Method	Description
CreateDashboardRequest.Builder	clientToken(String clientToken)	A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.
CreateDashboardRequest.Builder	dashboardDefinition(String dashboardDefinition)	The dashboard definition specified in a JSON literal.
CreateDashboardRequest.Builder	dashboardDescription(String dashboardDescription)	A description for the dashboard.
CreateDashboardRequest.Builder	dashboardName(String dashboardName)	A friendly name for 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	projectId(String projectId)	The ID of the project in which to create the dashboard.
CreateDashboardRequest.Builder	tags(Map<String,String> tags)	A list of key-value pairs that contain metadata for the dashboard.

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

overrideConfiguration

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

copy

Methods inherited from interface software.amazon.awssdk.services.iotsitewise.model.IoTSiteWiseRequest.Builder

build

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

projectId

CreateDashboardRequest.Builder projectId(String projectId)

The ID of the project in which to create the dashboard.

Parameters:

projectId - The ID of the project in which to create the dashboard.

Returns:

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

dashboardName

CreateDashboardRequest.Builder dashboardName(String dashboardName)

A friendly name for the dashboard.

Parameters:

dashboardName - A friendly name for the dashboard.

Returns:

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

dashboardDescription

CreateDashboardRequest.Builder dashboardDescription(String dashboardDescription)

A description for the dashboard.

Parameters:

dashboardDescription - A description for the dashboard.

Returns:

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

dashboardDefinition

CreateDashboardRequest.Builder dashboardDefinition(String dashboardDefinition)

The dashboard definition specified in a JSON literal.

• IoT SiteWise Monitor (Classic) see Create dashboards (CLI)

• IoT SiteWise Monitor (AI-aware) see Create dashboards (CLI)

in the IoT SiteWise User Guide

Parameters:

dashboardDefinition - The dashboard definition specified in a JSON literal.

• IoT SiteWise Monitor (Classic) see Create dashboards (CLI)

• IoT SiteWise Monitor (AI-aware) see Create dashboards (CLI)

in the IoT SiteWise User Guide

Returns:

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

clientToken

CreateDashboardRequest.Builder clientToken(String clientToken)

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

Parameters:

clientToken - A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

Returns:

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

tags

CreateDashboardRequest.Builder tags(Map<String,String> tags)

A list of key-value pairs that contain metadata for the dashboard. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.

Parameters:

tags - A list of key-value pairs that contain metadata for the dashboard. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.

Returns:

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

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.