@Generated(value="software.amazon.awssdk:codegen") public final class GetEvaluationResponse extends MachineLearningResponse implements ToCopyableBuilder<GetEvaluationResponse.Builder,GetEvaluationResponse>
Represents the output of a GetEvaluation
operation and describes an Evaluation
.
Modifier and Type | Class and Description |
---|---|
static interface |
GetEvaluationResponse.Builder |
Modifier and Type | Method and Description |
---|---|
static GetEvaluationResponse.Builder |
builder() |
Long |
computeTime()
The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the
Evaluation , normalized and scaled on computation resources. |
Instant |
createdAt()
The time that the
Evaluation was created. |
String |
createdByIamUser()
The AWS user account that invoked the evaluation.
|
boolean |
equals(Object obj) |
String |
evaluationDataSourceId()
The
DataSource used for this evaluation. |
String |
evaluationId()
The evaluation ID which is same as the
EvaluationId in the request. |
Instant |
finishedAt()
The epoch time when Amazon Machine Learning marked the
Evaluation as COMPLETED or
FAILED . |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkResponse . |
int |
hashCode() |
String |
inputDataLocationS3()
The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).
|
Instant |
lastUpdatedAt()
The time of the most recent edit to the
Evaluation . |
String |
logUri()
A link to the file that contains logs of the
CreateEvaluation operation. |
String |
message()
A description of the most recent details about evaluating the
MLModel . |
String |
mlModelId()
The ID of the
MLModel that was the focus of the evaluation. |
String |
name()
A user-supplied name or description of the
Evaluation . |
PerformanceMetrics |
performanceMetrics()
Measurements of how well the
MLModel performed using observations referenced by the
DataSource . |
static Class<? extends GetEvaluationResponse.Builder> |
serializableBuilderClass() |
Instant |
startedAt()
The epoch time when Amazon Machine Learning marked the
Evaluation as INPROGRESS . |
EntityStatus |
status()
The status of the evaluation.
|
String |
statusAsString()
The status of the evaluation.
|
GetEvaluationResponse.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
sdkHttpResponse
copy
public String evaluationId()
The evaluation ID which is same as the EvaluationId
in the request.
EvaluationId
in the request.public String mlModelId()
The ID of the MLModel
that was the focus of the evaluation.
MLModel
that was the focus of the evaluation.public String evaluationDataSourceId()
The DataSource
used for this evaluation.
DataSource
used for this evaluation.public String inputDataLocationS3()
The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).
public String createdByIamUser()
The AWS user account that invoked the evaluation. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.
public Instant createdAt()
The time that the Evaluation
was created. The time is expressed in epoch time.
Evaluation
was created. The time is expressed in epoch time.public Instant lastUpdatedAt()
The time of the most recent edit to the Evaluation
. The time is expressed in epoch time.
Evaluation
. The time is expressed in epoch time.public String name()
A user-supplied name or description of the Evaluation
.
Evaluation
.public EntityStatus status()
The status of the evaluation. This element can have one of the following values:
PENDING
- Amazon Machine Language (Amazon ML) submitted a request to evaluate an
MLModel
.INPROGRESS
- The evaluation is underway.FAILED
- The request to evaluate an MLModel
did not run to completion. It is not
usable.COMPLETED
- The evaluation process completed successfully.DELETED
- The Evaluation
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()
.
PENDING
- Amazon Machine Language (Amazon ML) submitted a request to evaluate an
MLModel
.INPROGRESS
- The evaluation is underway.FAILED
- The request to evaluate an MLModel
did not run to completion. It
is not usable.COMPLETED
- The evaluation process completed successfully.DELETED
- The Evaluation
is marked as deleted. It is not usable.EntityStatus
public String statusAsString()
The status of the evaluation. This element can have one of the following values:
PENDING
- Amazon Machine Language (Amazon ML) submitted a request to evaluate an
MLModel
.INPROGRESS
- The evaluation is underway.FAILED
- The request to evaluate an MLModel
did not run to completion. It is not
usable.COMPLETED
- The evaluation process completed successfully.DELETED
- The Evaluation
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()
.
PENDING
- Amazon Machine Language (Amazon ML) submitted a request to evaluate an
MLModel
.INPROGRESS
- The evaluation is underway.FAILED
- The request to evaluate an MLModel
did not run to completion. It
is not usable.COMPLETED
- The evaluation process completed successfully.DELETED
- The Evaluation
is marked as deleted. It is not usable.EntityStatus
public PerformanceMetrics performanceMetrics()
Measurements of how well the MLModel
performed using observations referenced by the
DataSource
. One of the following metric is returned based on the type of the MLModel
:
BinaryAUC: A binary MLModel
uses the Area Under the Curve (AUC) technique to measure performance.
RegressionRMSE: A regression MLModel
uses the Root Mean Square Error (RMSE) technique to measure
performance. RMSE measures the difference between predicted and actual values for a single variable.
MulticlassAvgFScore: A multiclass MLModel
uses the F1 score technique to measure performance.
For more information about performance metrics, please see the Amazon Machine Learning Developer Guide.
MLModel
performed using observations referenced by the
DataSource
. One of the following metric is returned based on the type of the
MLModel
:
BinaryAUC: A binary MLModel
uses the Area Under the Curve (AUC) technique to measure
performance.
RegressionRMSE: A regression MLModel
uses the Root Mean Square Error (RMSE) technique to
measure performance. RMSE measures the difference between predicted and actual values for a single
variable.
MulticlassAvgFScore: A multiclass MLModel
uses the F1 score technique to measure
performance.
For more information about performance metrics, please see the Amazon Machine Learning Developer Guide.
public String logUri()
A link to the file that contains logs of the CreateEvaluation
operation.
CreateEvaluation
operation.public String message()
A description of the most recent details about evaluating the MLModel
.
MLModel
.public Long computeTime()
The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the
Evaluation
, normalized and scaled on computation resources. ComputeTime
is only
available if the Evaluation
is in the COMPLETED
state.
Evaluation
, normalized and scaled on computation resources. ComputeTime
is only
available if the Evaluation
is in the COMPLETED
state.public Instant finishedAt()
The epoch time when Amazon Machine Learning marked the Evaluation
as COMPLETED
or
FAILED
. FinishedAt
is only available when the Evaluation
is in the
COMPLETED
or FAILED
state.
Evaluation
as COMPLETED
or FAILED
. FinishedAt
is only available when the Evaluation
is in
the COMPLETED
or FAILED
state.public Instant startedAt()
The epoch time when Amazon Machine Learning marked the Evaluation
as INPROGRESS
.
StartedAt
isn't available if the Evaluation
is in the PENDING
state.
Evaluation
as INPROGRESS
. StartedAt
isn't available if the Evaluation
is in the PENDING
state.public GetEvaluationResponse.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<GetEvaluationResponse.Builder,GetEvaluationResponse>
toBuilder
in class AwsResponse
public static GetEvaluationResponse.Builder builder()
public static Class<? extends GetEvaluationResponse.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkResponse
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.getValueForField
in class SdkResponse
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.