Evaluation (AWS SDK for Java - 2.0.0-preview-1)

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

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<Evaluation.Builder,Evaluation>
```
@Generated("software.amazon.awssdk:codegen")
public class Evaluation
extends Object
implements StructuredPojo, 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.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface Evaluation.Builder

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()`
`Date`	`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 ID of the `DataSource` that is used to evaluate the `MLModel`.
`String`	`evaluationId()`	The ID that is assigned to the `Evaluation` at creation.
`Date`	`finishedAt()`
`int`	`hashCode()`
`String`	`inputDataLocationS3()`	The location and name of the data in Amazon Simple Storage Server (Amazon S3) that is used in the evaluation.
`Date`	`lastUpdatedAt()`	The time of the most recent edit to the `Evaluation`.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`	Marshalls this structured data using the given `ProtocolMarshaller`.
`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`.
`static Class<? extends Evaluation.Builder>`	`serializableBuilderClass()`
`Date`	`startedAt()`
`String`	`status()`	The status of the evaluation.
`Evaluation.Builder`	`toBuilder()`	Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - evaluationId
```
public 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 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 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 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 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 Date 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 Date 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 String name()
```
    A user-supplied name or description of the Evaluation.
    
    Returns:
    
    A user-supplied name or description of the Evaluation.
  - status
```
public String 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.
    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 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 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 Long computeTime()
```
    Returns:
  - finishedAt
```
public Date finishedAt()
```
    Returns:
  - startedAt
```
public Date startedAt()
```
    Returns:
  - toBuilder
```
public Evaluation.Builder 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 interface ToCopyableBuilder<Evaluation.Builder,Evaluation>
    
    Returns:
    
    a builder for type T
  - builder
```
public static Evaluation.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Evaluation.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Class Evaluation

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

evaluationId

mlModelId

evaluationDataSourceId

inputDataLocationS3

createdByIamUser

createdAt

lastUpdatedAt

name

status

performanceMetrics

message

computeTime

finishedAt

startedAt

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

marshall