Interface CreateDashboardRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateDashboardRequest.Builder,
,CreateDashboardRequest> IoTSiteWiseRequest.Builder
,SdkBuilder<CreateDashboardRequest.Builder,
,CreateDashboardRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateDashboardRequest
public static interface CreateDashboardRequest.Builder
extends IoTSiteWiseRequest.Builder, SdkPojo, CopyableBuilder<CreateDashboardRequest.Builder,CreateDashboardRequest>
-
Method Summary
Modifier and TypeMethodDescriptionclientToken
(String clientToken) A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.dashboardDefinition
(String dashboardDefinition) The dashboard definition specified in a JSON literal.dashboardDescription
(String dashboardDescription) A description for the dashboard.dashboardName
(String dashboardName) A friendly name for the dashboard.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The ID of the project in which to create the dashboard.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, sdkFields
-
Method Details
-
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
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
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
The dashboard definition specified in a JSON literal. For detailed information, see Creating dashboards (CLI) in the IoT SiteWise User Guide.
- Parameters:
dashboardDefinition
- The dashboard definition specified in a JSON literal. For detailed information, see Creating dashboards (CLI) in the IoT SiteWise User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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 interfaceAwsRequest.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 interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-