GetDataSourceResponse (AWS Java SDK :: Services :: Amazon Machine Learning 2.15.51 API)

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(value="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.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface GetDataSourceResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`GetDataSourceResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static GetDataSourceResponse.Builder`	`builder()`
`Boolean`	`computeStatistics()` The parameter is `true` if statistics need to be generated from the observation data.
`Long`	`computeTime()` The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the `DataSource`, normalized and scaled on computation resources.
`Instant`	`createdAt()` The time that the `DataSource` was created.
`String`	`createdByIamUser()` The AWS user account from which the `DataSource` was created.
`String`	`dataLocationS3()` The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).
`String`	`dataRearrangement()` A JSON string that represents the splitting and rearrangement requirement used when this `DataSource` was created.
`Long`	`dataSizeInBytes()` The total size of observations in the data files.
`String`	`dataSourceId()` The ID assigned to the `DataSource` at creation.
`String`	`dataSourceSchema()` The schema used by all of the data files of this `DataSource`.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`Instant`	`finishedAt()` The epoch time when Amazon Machine Learning marked the `DataSource` as `COMPLETED` or `FAILED`.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Instant`	`lastUpdatedAt()` The time of the most recent edit to the `DataSource`.
`String`	`logUri()` A link to the file containing logs of `CreateDataSourceFrom*` operations.
`String`	`message()` The user-supplied description of the most recent details about creating the `DataSource`.
`String`	`name()` A user-supplied name or description of the `DataSource`.
`Long`	`numberOfFiles()` The number of data files referenced by the `DataSource`.
`RDSMetadata`	`rdsMetadata()` Returns the value of the RDSMetadata property for this object.
`RedshiftMetadata`	`redshiftMetadata()` Returns the value of the RedshiftMetadata property for this object.
`String`	`roleARN()` Returns the value of the RoleARN property for this object.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends GetDataSourceResponse.Builder>`	`serializableBuilderClass()`
`Instant`	`startedAt()` The epoch time when Amazon Machine Learning marked the `DataSource` as `INPROGRESS`.
`EntityStatus`	`status()` The current status of the `DataSource`.
`String`	`statusAsString()` The current status of the `DataSource`.
`GetDataSourceResponse.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.machinelearning.model.MachineLearningResponse
responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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:
    
    EntityStatus
  - 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:
    
    EntityStatus
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GetDataSourceResponse.Builder,GetDataSourceResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class GetDataSourceResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.machinelearning.model.MachineLearningResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

dataSourceId

dataLocationS3

dataRearrangement

createdByIamUser

createdAt

lastUpdatedAt

dataSizeInBytes

numberOfFiles

name

status

statusAsString

logUri

message

redshiftMetadata

rdsMetadata

roleARN

computeStatistics

computeTime

finishedAt

startedAt

dataSourceSchema

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields