Package software.amazon.awssdk.services.forecast.model

Class DatasetSummary

java.lang.Object
software.amazon.awssdk.services.forecast.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>

Provides a summary of the dataset properties used in the ListDatasets operation. To get the complete set of properties, call the DescribeDataset operation, and provide the DatasetArn.

See Also:

  • Method Details

    • datasetArn

      public final String datasetArn()

      The Amazon Resource Name (ARN) of the dataset.

      Returns:
      The Amazon Resource Name (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.

      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.
      See Also:

    • datasetTypeAsString

      public final String datasetTypeAsString()

      The dataset type.

      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.
      See Also:

    • domain

      public final Domain domain()

      The domain associated with the dataset.

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

      Returns:
      The domain associated with the dataset.
      See Also:

    • domainAsString

      public final String domainAsString()

      The domain associated with the dataset.

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

      Returns:
      The domain associated with the dataset.
      See Also:

    • creationTime

      public final Instant creationTime()

      When the dataset was created.

      Returns:
      When the dataset was created.

    • lastModificationTime

      public final Instant lastModificationTime()

      When you create a dataset, LastModificationTime is the same as CreationTime. While data is being imported to the dataset, LastModificationTime is the current time of the ListDatasets call. After a CreateDatasetImportJob operation has finished, LastModificationTime is when the import job completed or failed.

      Returns:
      When you create a dataset, LastModificationTime is the same as CreationTime. While data is being imported to the dataset, LastModificationTime is the current time of the ListDatasets call. After a CreateDatasetImportJob operation has finished, LastModificationTime is when the import job completed or failed.

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