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
GetDataSourceoperation.The content consists of the detailed metadata and data file information and the current status of the
DataSource.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceDataSource.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DataSource.Builderbuilder()BooleancomputeStatistics()The parameter istrueif statistics need to be generated from the observation data.LongcomputeTime()Returns the value of the ComputeTime property for this object.InstantcreatedAt()The time that theDataSourcewas created.StringcreatedByIamUser()The AWS user account from which theDataSourcewas created.StringdataLocationS3()The location and name of the data in Amazon Simple Storage Service (Amazon S3) that is used by aDataSource.StringdataRearrangement()A JSON string that represents the splitting and rearrangement requirement used when thisDataSourcewas created.LongdataSizeInBytes()The total number of observations contained in the data files that theDataSourcereferences.StringdataSourceId()The ID that is assigned to theDataSourceduring creation.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)InstantfinishedAt()Returns the value of the FinishedAt property for this object.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()InstantlastUpdatedAt()The time of the most recent edit to theBatchPrediction.Stringmessage()A description of the most recent details about creating theDataSource.Stringname()A user-supplied name or description of theDataSource.LongnumberOfFiles()The number of data files referenced by theDataSource.RDSMetadatardsMetadata()Returns the value of the RDSMetadata property for this object.RedshiftMetadataredshiftMetadata()Returns the value of the RedshiftMetadata property for this object.StringroleARN()Returns the value of the RoleARN property for this object.List<SdkField<?>>sdkFields()static Class<? extends DataSource.Builder>serializableBuilderClass()InstantstartedAt()Returns the value of the StartedAt property for this object.EntityStatusstatus()The current status of theDataSource.StringstatusAsString()The current status of theDataSource.DataSource.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
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 that is assigned to the
DataSourceduring creation.- Returns:
- The ID that is assigned to the
DataSourceduring 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
DataSourcewas created.- Returns:
- A JSON string that represents the splitting and rearrangement requirement used when this
DataSourcewas created.
-
createdByIamUser
public final String createdByIamUser()
The AWS user account from which the
DataSourcewas 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
DataSourcewas 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
DataSourcewas created. The time is expressed in epoch time.- Returns:
- The time that the
DataSourcewas 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
DataSourcereferences.- Returns:
- The total number of observations contained in the data files that the
DataSourcereferences.
-
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
DataSourcedid not run to completion. It is not usable. -
COMPLETED - The creation process completed successfully.
-
DELETED - The
DataSourceis marked as deleted. It is not usable.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnEntityStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- 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
DataSourcedid not run to completion. It is not usable. -
COMPLETED - The creation process completed successfully.
-
DELETED - The
DataSourceis 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 Machine Learning (Amazon ML) submitted a request to create a
DataSource. -
INPROGRESS - The creation process is underway.
-
FAILED - The request to create a
DataSourcedid not run to completion. It is not usable. -
COMPLETED - The creation process completed successfully.
-
DELETED - The
DataSourceis marked as deleted. It is not usable.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnEntityStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- 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
DataSourcedid not run to completion. It is not usable. -
COMPLETED - The creation process completed successfully.
-
DELETED - The
DataSourceis marked as deleted. It is not usable.
-
- See Also:
EntityStatus
-
-
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
trueif statistics need to be generated from the observation data.- Returns:
- The parameter is
trueif 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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<DataSource.Builder,DataSource>
-
builder
public static DataSource.Builder builder()
-
serializableBuilderClass
public static Class<? extends DataSource.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-