Class GetEvaluationResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetEvaluationResponse.Builder,
GetEvaluationResponse>
Represents the output of a GetEvaluation
operation and describes an Evaluation
.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final Long
The approximate CPU time in milliseconds that Amazon Machine Learning spent processing theEvaluation
, normalized and scaled on computation resources.final Instant
The time that theEvaluation
was created.final String
The AWS user account that invoked the evaluation.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
TheDataSource
used for this evaluation.final String
The evaluation ID which is same as theEvaluationId
in the request.final Instant
The epoch time when Amazon Machine Learning marked theEvaluation
asCOMPLETED
orFAILED
.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final String
The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).final Instant
The time of the most recent edit to theEvaluation
.final String
logUri()
A link to the file that contains logs of theCreateEvaluation
operation.final String
message()
A description of the most recent details about evaluating theMLModel
.final String
The ID of theMLModel
that was the focus of the evaluation.final String
name()
A user-supplied name or description of theEvaluation
.final PerformanceMetrics
Measurements of how well theMLModel
performed using observations referenced by theDataSource
.static Class
<? extends GetEvaluationResponse.Builder> final Instant
The epoch time when Amazon Machine Learning marked theEvaluation
asINPROGRESS
.final EntityStatus
status()
The status of the evaluation.final String
The status of the evaluation.Take this object and create a builder that contains all of the current property values of this object.final 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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
evaluationId
The evaluation ID which is same as the
EvaluationId
in the request.- Returns:
- The evaluation ID which is same as the
EvaluationId
in the request.
-
mlModelId
The ID of the
MLModel
that was the focus of the evaluation.- Returns:
- The ID of the
MLModel
that was the focus of the evaluation.
-
evaluationDataSourceId
The
DataSource
used for this evaluation.- Returns:
- The
DataSource
used for this evaluation.
-
inputDataLocationS3
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).
-
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.
- Returns:
- 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.
-
createdAt
The time that the
Evaluation
was created. The time is expressed in epoch time.- Returns:
- The time that the
Evaluation
was created. The time is expressed in epoch time.
-
lastUpdatedAt
The time of the most recent edit to the
Evaluation
. The time is expressed in epoch time.- Returns:
- The time of the most recent edit to the
Evaluation
. The time is expressed in epoch time.
-
name
A user-supplied name or description of the
Evaluation
.- Returns:
- A user-supplied name or description of the
Evaluation
.
-
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 anMLModel
. -
INPROGRESS
- The evaluation is underway. -
FAILED
- The request to evaluate anMLModel
did not run to completion. It is not usable. -
COMPLETED
- The evaluation process completed successfully. -
DELETED
- TheEvaluation
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 returnEntityStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- 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 anMLModel
. -
INPROGRESS
- The evaluation is underway. -
FAILED
- The request to evaluate anMLModel
did not run to completion. It is not usable. -
COMPLETED
- The evaluation process completed successfully. -
DELETED
- TheEvaluation
is marked as deleted. It is not usable.
-
- See Also:
-
-
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 anMLModel
. -
INPROGRESS
- The evaluation is underway. -
FAILED
- The request to evaluate anMLModel
did not run to completion. It is not usable. -
COMPLETED
- The evaluation process completed successfully. -
DELETED
- TheEvaluation
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 returnEntityStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- 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 anMLModel
. -
INPROGRESS
- The evaluation is underway. -
FAILED
- The request to evaluate anMLModel
did not run to completion. It is not usable. -
COMPLETED
- The evaluation process completed successfully. -
DELETED
- TheEvaluation
is marked as deleted. It is not usable.
-
- See Also:
-
-
performanceMetrics
Measurements of how well the
MLModel
performed using observations referenced by theDataSource
. One of the following metric is returned based on the type of theMLModel
:-
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.
- Returns:
- Measurements of how well the
MLModel
performed using observations referenced by theDataSource
. One of the following metric is returned based on the type of theMLModel
:-
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.
-
-
-
logUri
A link to the file that contains logs of the
CreateEvaluation
operation.- Returns:
- A link to the file that contains logs of the
CreateEvaluation
operation.
-
message
A description of the most recent details about evaluating the
MLModel
.- Returns:
- A description of the most recent details about evaluating the
MLModel
.
-
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 theEvaluation
is in theCOMPLETED
state.- Returns:
- 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 theEvaluation
is in theCOMPLETED
state.
-
finishedAt
The epoch time when Amazon Machine Learning marked the
Evaluation
asCOMPLETED
orFAILED
.FinishedAt
is only available when theEvaluation
is in theCOMPLETED
orFAILED
state.- Returns:
- The epoch time when Amazon Machine Learning marked the
Evaluation
asCOMPLETED
orFAILED
.FinishedAt
is only available when theEvaluation
is in theCOMPLETED
orFAILED
state.
-
startedAt
The epoch time when Amazon Machine Learning marked the
Evaluation
asINPROGRESS
.StartedAt
isn't available if theEvaluation
is in thePENDING
state.- Returns:
- The epoch time when Amazon Machine Learning marked the
Evaluation
asINPROGRESS
.StartedAt
isn't available if theEvaluation
is in thePENDING
state.
-
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 interfaceToCopyableBuilder<GetEvaluationResponse.Builder,
GetEvaluationResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. 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, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- 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
-