com.amazonaws.services.iotsitewise.model

Class CreateDashboardRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.iotsitewise.model.CreateDashboardRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateDashboardRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateDashboardRequest()

Method Summary

Modifier and Type	Method and Description
CreateDashboardRequest	addTagsEntry(String key, String value) Add a single Tags entry
CreateDashboardRequest	clearTagsEntries() Removes all the entries added into Tags.
CreateDashboardRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getClientToken() A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.
String	getDashboardDefinition() The dashboard definition specified in a JSON literal.
String	getDashboardDescription() A description for the dashboard.
String	getDashboardName() A friendly name for the dashboard.
String	getProjectId() The ID of the project in which to create the dashboard.
Map<String,String>	getTags() A list of key-value pairs that contain metadata for the dashboard.
int	hashCode()
void	setClientToken(String clientToken) A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.
void	setDashboardDefinition(String dashboardDefinition) The dashboard definition specified in a JSON literal.
void	setDashboardDescription(String dashboardDescription) A description for the dashboard.
void	setDashboardName(String dashboardName) A friendly name for the dashboard.
void	setProjectId(String projectId) The ID of the project in which to create the dashboard.
void	setTags(Map<String,String> tags) A list of key-value pairs that contain metadata for the dashboard.
String	toString() Returns a string representation of this object.
CreateDashboardRequest	withClientToken(String clientToken) A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.
CreateDashboardRequest	withDashboardDefinition(String dashboardDefinition) The dashboard definition specified in a JSON literal.
CreateDashboardRequest	withDashboardDescription(String dashboardDescription) A description for the dashboard.
CreateDashboardRequest	withDashboardName(String dashboardName) A friendly name for the dashboard.
CreateDashboardRequest	withProjectId(String projectId) The ID of the project in which to create the dashboard.
CreateDashboardRequest	withTags(Map<String,String> tags) A list of key-value pairs that contain metadata for the dashboard.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateDashboardRequest

public CreateDashboardRequest()

Method Detail

setProjectId

public void setProjectId(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.

getProjectId

public String getProjectId()

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

Returns:

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

withProjectId

public CreateDashboardRequest withProjectId(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.

setDashboardName

public void setDashboardName(String dashboardName)

A friendly name for the dashboard.

Parameters:

dashboardName - A friendly name for the dashboard.

getDashboardName

public String getDashboardName()

A friendly name for the dashboard.

Returns:

A friendly name for the dashboard.

withDashboardName

public CreateDashboardRequest withDashboardName(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.

setDashboardDescription

public void setDashboardDescription(String dashboardDescription)

A description for the dashboard.

Parameters:

dashboardDescription - A description for the dashboard.

getDashboardDescription

public String getDashboardDescription()

A description for the dashboard.

Returns:

A description for the dashboard.

withDashboardDescription

public CreateDashboardRequest withDashboardDescription(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.

setDashboardDefinition

public void setDashboardDefinition(String 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.

getDashboardDefinition

public String getDashboardDefinition()

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.

withDashboardDefinition

public CreateDashboardRequest withDashboardDefinition(String 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.

setClientToken

public void setClientToken(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.

getClientToken

public String getClientToken()

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.

withClientToken

public CreateDashboardRequest withClientToken(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.

getTags

public Map<String,String> getTags()

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:

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.

setTags

public void setTags(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.

withTags

public CreateDashboardRequest withTags(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.

addTagsEntry

public CreateDashboardRequest addTagsEntry(String key,
                                           String value)

Add a single Tags entry

See Also:

withTags(java.util.Map<java.lang.String, java.lang.String>)

clearTagsEntries

public CreateDashboardRequest clearTagsEntries()

Removes all the entries added into Tags.

Returns:

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

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateDashboardRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()