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("software.amazon.awssdk:codegen") public final class DescribeDashboardResponse extends IoTSiteWiseResponse implements ToCopyableBuilder<DescribeDashboardResponse.Builder,DescribeDashboardResponse>

  • Method Details

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<DescribeDashboardResponse.Builder,DescribeDashboardResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.