GetEvaluationResponse (AWS SDK for Java

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.GetEvaluationResponse

All Implemented Interfaces:: ToCopyableBuilder<GetEvaluationResponse.Builder,GetEvaluationResponse>

@Generated(value="software.amazon.awssdk:codegen")
public class GetEvaluationResponse
extends MachineLearningResponse
implements ToCopyableBuilder<GetEvaluationResponse.Builder,GetEvaluationResponse>

Represents the output of a GetEvaluation operation and describes an Evaluation.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface GetEvaluationResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`GetEvaluationResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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()`

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

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

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

- Method Detail
  - evaluationId
```
public String 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
```
public String 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
```
public String evaluationDataSourceId()
```
    The DataSource used for this evaluation.
    
    Returns:
    
    The DataSource used for this evaluation.
  - inputDataLocationS3
```
public String 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
```
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 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 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 String name()
```
    A user-supplied name or description of the Evaluation.
    
    Returns:
    
    A user-supplied name or description of the Evaluation.
  - status
```
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().
    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 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 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().
    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 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 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.
    Returns:
    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.
  - logUri
```
public String 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
```
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()
```
    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.
    
    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 the Evaluation is in the COMPLETED state.
  - finishedAt
```
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.
    
    Returns:
    
    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.
  - startedAt
```
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.
    
    Returns:
    
    The epoch time when Amazon Machine Learning marked the Evaluation as INPROGRESS . StartedAt isn't available if the Evaluation is in the PENDING state.
  - toBuilder
```
public GetEvaluationResponse.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<GetEvaluationResponse.Builder,GetEvaluationResponse>
    
    Specified by:
    
    toBuilder in class AwsResponse
    
    Returns:
    
    a builder for type T
  - builder
```
public static GetEvaluationResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GetEvaluationResponse.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
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Description copied from class: SdkResponse
    
    Used to retrieve the value of a field from any class that extends 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.
    
    Overrides:
    
    getValueForField in class SdkResponse
    
    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

Class GetEvaluationResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.core.SdkResponse

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

logUri

message

computeTime

finishedAt

startedAt

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField