Package software.amazon.awssdk.services.iotsitewise.model

Class CreateDashboardRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.iotsitewise.model.IoTSiteWiseRequest

software.amazon.awssdk.services.iotsitewise.model.CreateDashboardRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateDashboardRequest.Builder,CreateDashboardRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateDashboardRequest
extends IoTSiteWiseRequest
implements ToCopyableBuilder<CreateDashboardRequest.Builder,CreateDashboardRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateDashboardRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateDashboardRequest.Builder	builder()
String	clientToken()	A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.
String	dashboardDefinition()	The dashboard definition specified in a JSON literal.
String	dashboardDescription()	A description for the dashboard.
String	dashboardName()	A friendly name for the dashboard.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
String	projectId()	The ID of the project in which to create the dashboard.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateDashboardRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags()	A list of key-value pairs that contain metadata for the dashboard.
CreateDashboardRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

projectId

public final String projectId()

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

Returns:

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

dashboardName

public final String dashboardName()

A friendly name for the dashboard.

Returns:

A friendly name for the dashboard.

dashboardDescription

public final String dashboardDescription()

A description for the dashboard.

Returns:

A description for the dashboard.

dashboardDefinition

public final String dashboardDefinition()

The dashboard definition specified in a JSON literal. For detailed information, see Creating dashboards (CLI) in the IoT SiteWise User Guide.

Returns:

The dashboard definition specified in a JSON literal. For detailed information, see Creating dashboards (CLI) in the IoT SiteWise User Guide.

clientToken

public final 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.

Returns:

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.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final 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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

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.

toBuilder

public CreateDashboardRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateDashboardRequest.Builder,CreateDashboardRequest>

Specified by:

toBuilder in class IoTSiteWiseRequest

builder

public static CreateDashboardRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateDashboardRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo