Class GetDataSourceResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.machinelearning.model.MachineLearningResponse
software.amazon.awssdk.services.machinelearning.model.GetDataSourceResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetDataSourceResponse.Builder,GetDataSourceResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetDataSourceResponse extends MachineLearningResponse implements ToCopyableBuilder<GetDataSourceResponse.Builder,GetDataSourceResponse>

Represents the output of a GetDataSource operation and describes a DataSource.

  • Method Details

    • dataSourceId

      public final String dataSourceId()

      The ID assigned to the DataSource at creation. This value should be identical to the value of the DataSourceId in the request.

      Returns:
      The ID assigned to the DataSource at creation. This value should be identical to the value of the DataSourceId in the request.

    • dataLocationS3

      public final String dataLocationS3()

      The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).

      Returns:
      The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).

    • 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 DataSource. The time is expressed in epoch time.

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

    • dataSizeInBytes

      public final Long dataSizeInBytes()

      The total size of observations in the data files.

      Returns:
      The total size of observations in the data files.

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

    • logUri

      public final String logUri()

      A link to the file containing logs of CreateDataSourceFrom* operations.

      Returns:
      A link to the file containing logs of CreateDataSourceFrom* operations.

    • message

      public final String message()

      The user-supplied description of the most recent details about creating the DataSource.

      Returns:
      The user-supplied 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()

      The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the DataSource, normalized and scaled on computation resources. ComputeTime is only available if the DataSource is in the COMPLETED state and the ComputeStatistics is set to true.

      Returns:
      The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the DataSource, normalized and scaled on computation resources. ComputeTime is only available if the DataSource is in the COMPLETED state and the ComputeStatistics is set to true.

    • finishedAt

      public final Instant finishedAt()

      The epoch time when Amazon Machine Learning marked the DataSource as COMPLETED or FAILED. FinishedAt is only available when the DataSource is in the COMPLETED or FAILED state.

      Returns:
      The epoch time when Amazon Machine Learning marked the DataSource as COMPLETED or FAILED. FinishedAt is only available when the DataSource is in the COMPLETED or FAILED state.

    • startedAt

      public final Instant startedAt()

      The epoch time when Amazon Machine Learning marked the DataSource as INPROGRESS. StartedAt isn't available if the DataSource is in the PENDING state.

      Returns:
      The epoch time when Amazon Machine Learning marked the DataSource as INPROGRESS . StartedAt isn't available if the DataSource is in the PENDING state.

    • dataSourceSchema

      public final String dataSourceSchema()

      The schema used by all of the data files of this DataSource.

      Note: This parameter is provided as part of the verbose format.

      Returns:
      The schema used by all of the data files of this DataSource.

      Note: This parameter is provided as part of the verbose format.

    • toBuilder

      public GetDataSourceResponse.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<GetDataSourceResponse.Builder,GetDataSourceResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetDataSourceResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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