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
GetDataSourceoperation and describes aDataSource.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceGetDataSourceResponse.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static GetDataSourceResponse.Builderbuilder()BooleancomputeStatistics()The parameter istrueif statistics need to be generated from the observation data.LongcomputeTime()The approximate CPU time in milliseconds that Amazon Machine Learning spent processing theDataSource, normalized and scaled on computation resources.InstantcreatedAt()The time that theDataSourcewas created.StringcreatedByIamUser()The AWS user account from which theDataSourcewas created.StringdataLocationS3()The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).StringdataRearrangement()A JSON string that represents the splitting and rearrangement requirement used when thisDataSourcewas created.LongdataSizeInBytes()The total size of observations in the data files.StringdataSourceId()The ID assigned to theDataSourceat creation.StringdataSourceSchema()The schema used by all of the data files of thisDataSource.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)InstantfinishedAt()The epoch time when Amazon Machine Learning marked theDataSourceasCOMPLETEDorFAILED.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()InstantlastUpdatedAt()The time of the most recent edit to theDataSource.StringlogUri()A link to the file containing logs ofCreateDataSourceFrom*operations.Stringmessage()The user-supplied 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 GetDataSourceResponse.Builder>serializableBuilderClass()InstantstartedAt()The epoch time when Amazon Machine Learning marked theDataSourceasINPROGRESS.EntityStatusstatus()The current status of theDataSource.StringstatusAsString()The current status of theDataSource.GetDataSourceResponse.BuildertoBuilder()StringtoString()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
DataSourceat creation. This value should be identical to the value of theDataSourceIdin the request.- Returns:
- The ID assigned to the
DataSourceat creation. This value should be identical to the value of theDataSourceIdin 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
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
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 aDataSource. -
INPROGRESS- The creation process is underway. -
FAILED- The request to create aDataSourcedid not run to completion. It is not usable. -
COMPLETED- The creation process completed successfully. -
DELETED- TheDataSourceis 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 ML submitted a request to create aDataSource. -
INPROGRESS- The creation process is underway. -
FAILED- The request to create aDataSourcedid not run to completion. It is not usable. -
COMPLETED- The creation process completed successfully. -
DELETED- TheDataSourceis 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 aDataSource. -
INPROGRESS- The creation process is underway. -
FAILED- The request to create aDataSourcedid not run to completion. It is not usable. -
COMPLETED- The creation process completed successfully. -
DELETED- TheDataSourceis 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 ML submitted a request to create aDataSource. -
INPROGRESS- The creation process is underway. -
FAILED- The request to create aDataSourcedid not run to completion. It is not usable. -
COMPLETED- The creation process completed successfully. -
DELETED- TheDataSourceis 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
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()
The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the
DataSource, normalized and scaled on computation resources.ComputeTimeis only available if theDataSourceis in theCOMPLETEDstate and theComputeStatisticsis set to true.- Returns:
- The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the
DataSource, normalized and scaled on computation resources.ComputeTimeis only available if theDataSourceis in theCOMPLETEDstate and theComputeStatisticsis set to true.
-
finishedAt
public final Instant finishedAt()
The epoch time when Amazon Machine Learning marked the
DataSourceasCOMPLETEDorFAILED.FinishedAtis only available when theDataSourceis in theCOMPLETEDorFAILEDstate.- Returns:
- The epoch time when Amazon Machine Learning marked the
DataSourceasCOMPLETEDorFAILED.FinishedAtis only available when theDataSourceis in theCOMPLETEDorFAILEDstate.
-
startedAt
public final Instant startedAt()
The epoch time when Amazon Machine Learning marked the
DataSourceasINPROGRESS.StartedAtisn't available if theDataSourceis in thePENDINGstate.- Returns:
- The epoch time when Amazon Machine Learning marked the
DataSourceasINPROGRESS.StartedAtisn't available if theDataSourceis in thePENDINGstate.
-
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:
toBuilderin interfaceToCopyableBuilder<GetDataSourceResponse.Builder,GetDataSourceResponse>- Specified by:
toBuilderin classAwsResponse
-
builder
public static GetDataSourceResponse.Builder builder()
-
serializableBuilderClass
public static Class<? extends GetDataSourceResponse.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsResponse
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsResponse
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkResponse
-
-