Class DatasetProperties

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

Properties associated with the dataset.

See Also:

  • Method Details

    • datasetArn

      public final String datasetArn()

      The ARN of the dataset.

      Returns:
      The ARN of the dataset.

    • datasetName

      public final String datasetName()

      The name of the dataset.

      Returns:
      The name of the dataset.

    • datasetType

      public final DatasetType datasetType()

      The dataset type (training data or test data).

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

      Returns:
      The dataset type (training data or test data).
      See Also:

    • datasetTypeAsString

      public final String datasetTypeAsString()

      The dataset type (training data or test data).

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

      Returns:
      The dataset type (training data or test data).
      See Also:

    • datasetS3Uri

      public final String datasetS3Uri()

      The S3 URI where the dataset is stored.

      Returns:
      The S3 URI where the dataset is stored.

    • description

      public final String description()

      Description of the dataset.

      Returns:
      Description of the dataset.

    • status

      public final DatasetStatus status()

      The dataset status. While the system creates the dataset, the status is CREATING. When the dataset is ready to use, the status changes to COMPLETED.

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

      Returns:
      The dataset status. While the system creates the dataset, the status is CREATING. When the dataset is ready to use, the status changes to COMPLETED.
      See Also:

    • statusAsString

      public final String statusAsString()

      The dataset status. While the system creates the dataset, the status is CREATING. When the dataset is ready to use, the status changes to COMPLETED.

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

      Returns:
      The dataset status. While the system creates the dataset, the status is CREATING. When the dataset is ready to use, the status changes to COMPLETED.
      See Also:

    • message

      public final String message()

      A description of the status of the dataset.

      Returns:
      A description of the status of the dataset.

    • numberOfDocuments

      public final Long numberOfDocuments()

      The number of documents in the dataset.

      Returns:
      The number of documents in the dataset.

    • creationTime

      public final Instant creationTime()

      Creation time of the dataset.

      Returns:
      Creation time of the dataset.

    • endTime

      public final Instant endTime()

      Time when the data from the dataset becomes available in the data lake.

      Returns:
      Time when the data from the dataset becomes available in the data lake.

    • toBuilder

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

    • builder

      public static DatasetProperties.Builder builder()

    • serializableBuilderClass

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