Class DatasetSummary

java.lang.Object
software.amazon.awssdk.services.iotsitewise.model.DatasetSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DatasetSummary.Builder,DatasetSummary>
@Generated("software.amazon.awssdk:codegen") public final class DatasetSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DatasetSummary.Builder,DatasetSummary>

The summary details for the dataset.

See Also:

  • Method Details

    • id

      public final String id()

      The ID of the dataset.

      Returns:
      The ID of the dataset.

    • arn

      public final String arn()

      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}.

    • name

      public final String name()

      The name of the dataset.

      Returns:
      The name of the dataset.

    • description

      public final String description()

      A description about the dataset, and its functionality.

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

    • sourceType

      public final DatasetSourceType sourceType()

      The data source type of the dataset.

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

      Returns:
      The data source type of the dataset.
      See Also:

    • sourceTypeAsString

      public final String sourceTypeAsString()

      The data source type of the dataset.

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

      Returns:
      The data source type of the dataset.
      See Also:

    • 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:

    • creationDate

      public final Instant creationDate()

      The dataset creation date, in Unix epoch time.

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

    • lastUpdateDate

      public final Instant lastUpdateDate()

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

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

    • status

      public final DatasetStatus status()

      The status of the dataset. This contains the state and any error messages. The state is ACTIVE when ready to use.

      Returns:
      The status of the dataset. This contains the state and any error messages. The state is ACTIVE when ready to use.

    • enrichmentStatus

      public final DatasetEnrichment enrichmentStatus()

      The enrichment status of the dataset.

      Returns:
      The enrichment status of the dataset.

    • toBuilder

      public DatasetSummary.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<DatasetSummary.Builder,DatasetSummary>
      Returns:
      a builder for type T

    • builder

      public static DatasetSummary.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • 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)

    • 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.