java.lang.Object
- software.amazon.awssdk.services.machinelearning.model.Evaluation

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Evaluation.Builder,Evaluation>
```
@Generated("software.amazon.awssdk:codegen")
public final class Evaluation
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Evaluation.Builder,Evaluation>
```
Represents the output of GetEvaluation operation.

The content consists of the detailed metadata and data file information and the current status of the Evaluation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface Evaluation.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static Evaluation.Builder`	`builder()`
`Long`	`computeTime()`	Returns the value of the ComputeTime property for this object.
`Instant`	`createdAt()`	The time that the `Evaluation` was created.
`String`	`createdByIamUser()`	The AWS user account that invoked the evaluation.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`evaluationDataSourceId()`	The ID of the `DataSource` that is used to evaluate the `MLModel`.
`String`	`evaluationId()`	The ID that is assigned to the `Evaluation` at creation.
`Instant`	`finishedAt()`	Returns the value of the FinishedAt property for this object.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`inputDataLocationS3()`	The location and name of the data in Amazon Simple Storage Server (Amazon S3) that is used in the evaluation.
`Instant`	`lastUpdatedAt()`	The time of the most recent edit to the `Evaluation`.
`String`	`message()`	A description of the most recent details about evaluating the `MLModel`.
`String`	`mlModelId()`	The ID of the `MLModel` that is 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`.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Evaluation.Builder>`	`serializableBuilderClass()`
`Instant`	`startedAt()`	Returns the value of the StartedAt property for this object.
`EntityStatus`	`status()`	The status of the evaluation.
`String`	`statusAsString()`	The status of the evaluation.
`Evaluation.Builder`	`toBuilder()`
`String`	`toString()`	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
  - evaluationId
```
public final String evaluationId()
```
    The ID that is assigned to the Evaluation at creation.
    
    Returns:
    
    The ID that is assigned to the Evaluation at creation.
  - mlModelId
```
public final String mlModelId()
```
    The ID of the MLModel that is the focus of the evaluation.
    
    Returns:
    
    The ID of the MLModel that is the focus of the evaluation.
  - evaluationDataSourceId
```
public final String evaluationDataSourceId()
```
    The ID of the DataSource that is used to evaluate the MLModel.
    
    Returns:
    
    The ID of the DataSource that is used to evaluate the MLModel.
  - inputDataLocationS3
```
public final String inputDataLocationS3()
```
    The location and name of the data in Amazon Simple Storage Server (Amazon S3) that is used in the evaluation.
    
    Returns:
    
    The location and name of the data in Amazon Simple Storage Server (Amazon S3) that is used in the evaluation.
  - createdByIamUser
```
public final 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.
    
    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
```
public final Instant 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
```
public final Instant 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
```
public final String name()
```
    A user-supplied name or description of the Evaluation.
    
    Returns:
    
    A user-supplied name or description of the Evaluation.
  - status
```
public final EntityStatus status()
```
    The status of the evaluation. This element can have one of the following values:
    
    PENDING - Amazon Machine Learning (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().
    Returns:
    
    The status of the evaluation. This element can have one of the following values:
    
    PENDING - Amazon Machine Learning (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.
    
    See Also:
    
    EntityStatus
  - statusAsString
```
public final String statusAsString()
```
    The status of the evaluation. This element can have one of the following values:
    
    PENDING - Amazon Machine Learning (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().
    Returns:
    
    The status of the evaluation. This element can have one of the following values:
    
    PENDING - Amazon Machine Learning (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.
    
    See Also:
    
    EntityStatus
  - performanceMetrics
```
public final PerformanceMetrics performanceMetrics()
```
    Measurements of how well the MLModel performed, using observations referenced by the DataSource. One of the following metrics 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.
    Returns:
    
    Measurements of how well the MLModel performed, using observations referenced by the DataSource. One of the following metrics 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.
  - message
```
public final String 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
```
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 Evaluation.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Evaluation.Builder,Evaluation>
  - builder
```
public static Evaluation.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Evaluation.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - 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)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class Evaluation

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

evaluationId

mlModelId

evaluationDataSourceId

inputDataLocationS3

createdByIamUser

createdAt

lastUpdatedAt

name

status

statusAsString

performanceMetrics

message

computeTime

finishedAt

startedAt

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields