Class DatasetDescription

java.lang.Object
software.amazon.awssdk.services.rekognition.model.DatasetDescription
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DatasetDescription.Builder,DatasetDescription>

@Generated("software.amazon.awssdk:codegen") public final class DatasetDescription extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DatasetDescription.Builder,DatasetDescription>

A description for a dataset. For more information, see DescribeDataset.

The status fields Status, StatusMessage, and StatusMessageCode reflect the last operation on the dataset.

See Also:
  • Method Details

    • creationTimestamp

      public final Instant creationTimestamp()

      The Unix timestamp for the time and date that the dataset was created.

      Returns:
      The Unix timestamp for the time and date that the dataset was created.
    • lastUpdatedTimestamp

      public final Instant lastUpdatedTimestamp()

      The Unix timestamp for the date and time that the dataset was last updated.

      Returns:
      The Unix timestamp for the date and time that the dataset was last updated.
    • status

      public final DatasetStatus status()

      The status of the dataset.

      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 status of the dataset.
      See Also:
    • statusAsString

      public final String statusAsString()

      The status of the dataset.

      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 status of the dataset.
      See Also:
    • statusMessage

      public final String statusMessage()

      The status message for the dataset.

      Returns:
      The status message for the dataset.
    • statusMessageCode

      public final DatasetStatusMessageCode statusMessageCode()

      The status message code for the dataset operation. If a service error occurs, try the API call again later. If a client error occurs, check the input parameters to the dataset API call that failed.

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

      Returns:
      The status message code for the dataset operation. If a service error occurs, try the API call again later. If a client error occurs, check the input parameters to the dataset API call that failed.
      See Also:
    • statusMessageCodeAsString

      public final String statusMessageCodeAsString()

      The status message code for the dataset operation. If a service error occurs, try the API call again later. If a client error occurs, check the input parameters to the dataset API call that failed.

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

      Returns:
      The status message code for the dataset operation. If a service error occurs, try the API call again later. If a client error occurs, check the input parameters to the dataset API call that failed.
      See Also:
    • datasetStats

      public final DatasetStats datasetStats()

      The status message code for the dataset.

      Returns:
      The status message code for the dataset.
    • toBuilder

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

      public static DatasetDescription.Builder builder()
    • serializableBuilderClass

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