Class DataSource

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

Represents the output of the GetDataSource operation.

The content consists of the detailed metadata and data file information and the current status of the DataSource.

See Also:

  • Method Details

    • dataSourceId

      public final String dataSourceId()

      The ID that is assigned to the DataSource during creation.

      Returns:
      The ID that is assigned to the DataSource during creation.

    • dataLocationS3

      public final String dataLocationS3()

      The location and name of the data in Amazon Simple Storage Service (Amazon S3) that is used by a DataSource.

      Returns:
      The location and name of the data in Amazon Simple Storage Service (Amazon S3) that is used by a DataSource.

    • dataRearrangement

      public final String dataRearrangement()

      A JSON string that represents the splitting and rearrangement requirement used when this DataSource was created.

      Returns:
      A JSON string that represents the splitting and rearrangement requirement used when this DataSource was created.

    • createdByIamUser

      public final String createdByIamUser()

      The AWS user account from which the DataSource was created. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.

      Returns:
      The AWS user account from which the DataSource was created. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.

    • createdAt

      public final Instant createdAt()

      The time that the DataSource was created. The time is expressed in epoch time.

      Returns:
      The time that the DataSource was created. The time is expressed in epoch time.

    • lastUpdatedAt

      public final Instant lastUpdatedAt()

      The time of the most recent edit to the BatchPrediction. The time is expressed in epoch time.

      Returns:
      The time of the most recent edit to the BatchPrediction. The time is expressed in epoch time.

    • dataSizeInBytes

      public final Long dataSizeInBytes()

      The total number of observations contained in the data files that the DataSource references.

      Returns:
      The total number of observations contained in the data files that the DataSource references.

    • numberOfFiles

      public final Long numberOfFiles()

      The number of data files referenced by the DataSource.

      Returns:
      The number of data files referenced by the DataSource.

    • name

      public final String name()

      A user-supplied name or description of the DataSource.

      Returns:
      A user-supplied name or description of the DataSource.

    • status

      public final EntityStatus status()

      The current status of the DataSource. This element can have one of the following values:

      • PENDING - Amazon Machine Learning (Amazon ML) submitted a request to create a DataSource.

      • INPROGRESS - The creation process is underway.

      • FAILED - The request to create a DataSource did not run to completion. It is not usable.

      • COMPLETED - The creation process completed successfully.

      • DELETED - The DataSource is marked as deleted. It is not usable.

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

      Returns:
      The current status of the DataSource. This element can have one of the following values:

      • PENDING - Amazon Machine Learning (Amazon ML) submitted a request to create a DataSource.

      • INPROGRESS - The creation process is underway.

      • FAILED - The request to create a DataSource did not run to completion. It is not usable.

      • COMPLETED - The creation process completed successfully.

      • DELETED - The DataSource is marked as deleted. It is not usable.

      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the DataSource. This element can have one of the following values:

      • PENDING - Amazon Machine Learning (Amazon ML) submitted a request to create a DataSource.

      • INPROGRESS - The creation process is underway.

      • FAILED - The request to create a DataSource did not run to completion. It is not usable.

      • COMPLETED - The creation process completed successfully.

      • DELETED - The DataSource is marked as deleted. It is not usable.

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

      Returns:
      The current status of the DataSource. This element can have one of the following values:

      • PENDING - Amazon Machine Learning (Amazon ML) submitted a request to create a DataSource.

      • INPROGRESS - The creation process is underway.

      • FAILED - The request to create a DataSource did not run to completion. It is not usable.

      • COMPLETED - The creation process completed successfully.

      • DELETED - The DataSource is marked as deleted. It is not usable.

      See Also:

    • message

      public final String message()

      A description of the most recent details about creating the DataSource.

      Returns:
      A description of the most recent details about creating the DataSource.

    • redshiftMetadata

      public final RedshiftMetadata redshiftMetadata()
      Returns the value of the RedshiftMetadata property for this object.
      Returns:
      The value of the RedshiftMetadata property for this object.

    • rdsMetadata

      public final RDSMetadata rdsMetadata()
      Returns the value of the RDSMetadata property for this object.
      Returns:
      The value of the RDSMetadata property for this object.

    • roleARN

      public final String roleARN()
      Returns the value of the RoleARN property for this object.
      Returns:
      The value of the RoleARN property for this object.

    • computeStatistics

      public final Boolean computeStatistics()

      The parameter is true if statistics need to be generated from the observation data.

      Returns:
      The parameter is true if statistics need to be generated from the observation data.

    • computeTime

      public final Long computeTime()
      Returns the value of the ComputeTime property for this object.
      Returns:
      The value of the ComputeTime property for this object.

    • finishedAt

      public final Instant finishedAt()
      Returns the value of the FinishedAt property for this object.
      Returns:
      The value of the FinishedAt property for this object.

    • startedAt

      public final Instant startedAt()
      Returns the value of the StartedAt property for this object.
      Returns:
      The value of the StartedAt property for this object.

    • toBuilder

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

    • builder

      public static DataSource.Builder builder()

    • serializableBuilderClass

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