Class DescribeDatasetResponse

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.DescribeDatasetResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeDatasetResponse.Builder,DescribeDatasetResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeDatasetResponse extends IoTSiteWiseResponse implements ToCopyableBuilder<DescribeDatasetResponse.Builder,DescribeDatasetResponse>

  • Method Details

    • datasetId

      public final String datasetId()

      The ID of the dataset.

      Returns:
      The ID of the dataset.

    • datasetArn

      public final String datasetArn()

      The ARN of the dataset. The format is arn:${Partition}:iotsitewise:${Region}:${Account}:dataset/${DatasetId}.

      Returns:
      The ARN of the dataset. The format is arn:${Partition}:iotsitewise:${Region}:${Account}:dataset/${DatasetId}.

    • datasetName

      public final String datasetName()

      The name of the dataset.

      Returns:
      The name of the dataset.

    • datasetDescription

      public final String datasetDescription()

      A description about the dataset, and its functionality.

      Returns:
      A description about the dataset, and its functionality.

    • datasetType

      public final DatasetTypeEnum datasetType()

      The type of dataset: a session dataset, a curated dataset, or a connection to an external datasource.

      If the service returns an enum value that is not available in the current SDK version, datasetType will return DatasetTypeEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from datasetTypeAsString().

      Returns:
      The type of dataset: a session dataset, a curated dataset, or a connection to an external datasource.
      See Also:

    • datasetTypeAsString

      public final String datasetTypeAsString()

      The type of dataset: a session dataset, a curated dataset, or a connection to an external datasource.

      If the service returns an enum value that is not available in the current SDK version, datasetType will return DatasetTypeEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from datasetTypeAsString().

      Returns:
      The type of dataset: a session dataset, a curated dataset, or a connection to an external datasource.
      See Also:

    • datasetConfig

      public final DatasetConfig datasetConfig()

      The configuration for the dataset.

      Returns:
      The configuration for the dataset.

    • workspaceName

      public final String workspaceName()

      The name of the workspace that contains the dataset.

      Returns:
      The name of the workspace that contains the dataset.

    • hasMetadata

      public final boolean hasMetadata()
      For responses, this returns true if the service returned a value for the Metadata 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.

    • metadata

      public final Map<String,String> metadata()

      The metadata for the dataset.

      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 hasMetadata() method.

      Returns:
      The metadata for the dataset.

    • datasetSource

      public final DatasetSource datasetSource()

      The data source for the dataset.

      Returns:
      The data source for the dataset.

    • datasetStatus

      public final DatasetStatus datasetStatus()

      The status of the dataset. This contains the state and any error messages. State is CREATING after a successfull call to this API, and any associated error message. The state is ACTIVE when ready to use.

      Returns:
      The status of the dataset. This contains the state and any error messages. State is CREATING after a successfull call to this API, and any associated error message. The state is ACTIVE when ready to use.

    • datasetCreationDate

      public final Instant datasetCreationDate()

      The dataset creation date, in Unix epoch time.

      Returns:
      The dataset creation date, in Unix epoch time.

    • datasetLastUpdateDate

      public final Instant datasetLastUpdateDate()

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

      Returns:
      The date the dataset was last updated, in Unix epoch time.

    • datasetVersion

      public final String datasetVersion()

      The version of the dataset.

      Returns:
      The version of the dataset.

    • enrichmentStatus

      public final DatasetEnrichment enrichmentStatus()

      The enrichment status of the dataset.

      Returns:
      The enrichment status of the dataset.

    • toBuilder

      public DescribeDatasetResponse.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<DescribeDatasetResponse.Builder,DescribeDatasetResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeDatasetResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeDatasetResponse.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.