software.amazon.awssdk.services.iotsitewise.model

Class DescribeDashboardResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.iotsitewise.model.IoTSiteWiseResponse

software.amazon.awssdk.services.iotsitewise.model.DescribeDashboardResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeDashboardResponse.Builder,DescribeDashboardResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeDashboardResponse
extends IoTSiteWiseResponse
implements ToCopyableBuilder<DescribeDashboardResponse.Builder,DescribeDashboardResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeDashboardResponse.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeDashboardResponse.Builder	builder()
String	dashboardArn() The ARN of the dashboard, which has the following format.
Instant	dashboardCreationDate() The date the dashboard was created, in Unix epoch time.
String	dashboardDefinition() The dashboard's definition JSON literal.
String	dashboardDescription() The dashboard's description.
String	dashboardId() The ID of the dashboard.
Instant	dashboardLastUpdateDate() The date the dashboard was last updated, in Unix epoch time.
String	dashboardName() The name of the dashboard.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	projectId() The ID of the project that the dashboard is in.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeDashboardResponse.Builder>	serializableBuilderClass()
DescribeDashboardResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.iotsitewise.model.IoTSiteWiseResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

dashboardId

public final String dashboardId()

The ID of the dashboard.

Returns:

The ID of the dashboard.

dashboardArn

public final String dashboardArn()

The ARN of the dashboard, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId}

Returns:

The ARN of the dashboard, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId}

dashboardName

public final String dashboardName()

The name of the dashboard.

Returns:

The name of the dashboard.

projectId

public final String projectId()

The ID of the project that the dashboard is in.

Returns:

The ID of the project that the dashboard is in.

dashboardDescription

public final String dashboardDescription()

The dashboard's description.

Returns:

The dashboard's description.

dashboardDefinition

public final String dashboardDefinition()

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

Returns:

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

dashboardCreationDate

public final Instant dashboardCreationDate()

The date the dashboard was created, in Unix epoch time.

Returns:

The date the dashboard was created, in Unix epoch time.

dashboardLastUpdateDate

public final Instant dashboardLastUpdateDate()

The date the dashboard was last updated, in Unix epoch time.

Returns:

The date the dashboard was last updated, in Unix epoch time.

toBuilder

public DescribeDashboardResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeDashboardResponse.Builder,DescribeDashboardResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static DescribeDashboardResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo