CreateEvaluationRequest (AWS SDK For Java for OSGi 1.10.1 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.machinelearning.model.CreateEvaluationRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable
```
public class CreateEvaluationRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable
```
Container for the parameters to the CreateEvaluation operation.
Creates a new Evaluation of an MLModel . An MLModel is evaluated on a set of observations associated to a DataSource . Like a DataSource for an MLModel , the DataSource for an Evaluation contains values for the Target Variable. The Evaluation compares the predicted result for each observation to the actual outcome and provides a summary so that you know how effective the MLModel functions on the test data. Evaluation generates a relevant performance metric such as BinaryAUC, RegressionRMSE or MulticlassAvgFScore based on the corresponding MLModelType : BINARY , REGRESSION or MULTICLASS .

CreateEvaluation is an asynchronous operation. In response to CreateEvaluation , Amazon Machine Learning (Amazon ML) immediately returns and sets the evaluation status to PENDING . After the Evaluation is created and ready for use, Amazon ML sets the status to COMPLETED .

You can use the GetEvaluation operation to check progress of the evaluation during the creation operation.

See Also:
AmazonMachineLearning.createEvaluation(CreateEvaluationRequest), Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

CreateEvaluationRequest()

Constructors
Constructor and Description
`CreateEvaluationRequest()`

Method Summary

Methods
Modifier and Type	Method and Description
`CreateEvaluationRequest`	`clone()` Creates a shallow clone of this request.
`boolean`	`equals(Object obj)`
`String`	`getEvaluationDataSourceId()` The ID of the `DataSource` for the evaluation.
`String`	`getEvaluationId()` A user-supplied ID that uniquely identifies the `Evaluation`.
`String`	`getEvaluationName()` A user-supplied name or description of the `Evaluation`.
`String`	`getMLModelId()` The ID of the `MLModel` to evaluate.
`int`	`hashCode()`
`void`	`setEvaluationDataSourceId(String evaluationDataSourceId)` The ID of the `DataSource` for the evaluation.
`void`	`setEvaluationId(String evaluationId)` A user-supplied ID that uniquely identifies the `Evaluation`.
`void`	`setEvaluationName(String evaluationName)` A user-supplied name or description of the `Evaluation`.
`void`	`setMLModelId(String mLModelId)` The ID of the `MLModel` to evaluate.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`CreateEvaluationRequest`	`withEvaluationDataSourceId(String evaluationDataSourceId)` The ID of the `DataSource` for the evaluation.
`CreateEvaluationRequest`	`withEvaluationId(String evaluationId)` A user-supplied ID that uniquely identifies the `Evaluation`.
`CreateEvaluationRequest`	`withEvaluationName(String evaluationName)` A user-supplied name or description of the `Evaluation`.
`CreateEvaluationRequest`	`withMLModelId(String mLModelId)` The ID of the `MLModel` to evaluate.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

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

- Constructor Detail
  - CreateEvaluationRequest
```
public CreateEvaluationRequest()
```
- Method Detail
  - getEvaluationId
```
public String getEvaluationId()
```
    A user-supplied ID that uniquely identifies the Evaluation.
    Constraints:
    Length: 1 - 64
    Pattern: [a-zA-Z0-9_.-]+
    
    Returns:
    A user-supplied ID that uniquely identifies the Evaluation.
  - setEvaluationId
```
public void setEvaluationId(String evaluationId)
```
    A user-supplied ID that uniquely identifies the Evaluation.
    Constraints:
    Length: 1 - 64
    Pattern: [a-zA-Z0-9_.-]+
    
    Parameters:
    evaluationId - A user-supplied ID that uniquely identifies the Evaluation.
  - withEvaluationId
```
public CreateEvaluationRequest withEvaluationId(String evaluationId)
```
    A user-supplied ID that uniquely identifies the Evaluation.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 64
    Pattern: [a-zA-Z0-9_.-]+
    
    Parameters:
    evaluationId - A user-supplied ID that uniquely identifies the Evaluation.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getEvaluationName
```
public String getEvaluationName()
```
    A user-supplied name or description of the Evaluation.
    Constraints:
    Length: 0 - 1024
    Pattern: .*\S.*|^$
    
    Returns:
    A user-supplied name or description of the Evaluation.
  - setEvaluationName
```
public void setEvaluationName(String evaluationName)
```
    A user-supplied name or description of the Evaluation.
    Constraints:
    Length: 0 - 1024
    Pattern: .*\S.*|^$
    
    Parameters:
    evaluationName - A user-supplied name or description of the Evaluation.
  - withEvaluationName
```
public CreateEvaluationRequest withEvaluationName(String evaluationName)
```
    A user-supplied name or description of the Evaluation.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 0 - 1024
    Pattern: .*\S.*|^$
    
    Parameters:
    evaluationName - A user-supplied name or description of the Evaluation.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getMLModelId
```
public String getMLModelId()
```
    The ID of the MLModel to evaluate.
    The schema used in creating the MLModel must match the schema of the DataSource used in the Evaluation.
    Constraints:
    Length: 1 - 64
    Pattern: [a-zA-Z0-9_.-]+
    
    Returns:
    The ID of the MLModel to evaluate.
    The schema used in creating the MLModel must match the schema of the DataSource used in the Evaluation.
  - setMLModelId
```
public void setMLModelId(String mLModelId)
```
    The ID of the MLModel to evaluate.
    The schema used in creating the MLModel must match the schema of the DataSource used in the Evaluation.
    Constraints:
    Length: 1 - 64
    Pattern: [a-zA-Z0-9_.-]+
    
    Parameters:
    mLModelId - The ID of the MLModel to evaluate.
    The schema used in creating the MLModel must match the schema of the DataSource used in the Evaluation.
  - withMLModelId
```
public CreateEvaluationRequest withMLModelId(String mLModelId)
```
    The ID of the MLModel to evaluate.
    The schema used in creating the MLModel must match the schema of the DataSource used in the Evaluation.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 64
    Pattern: [a-zA-Z0-9_.-]+
    
    Parameters:
    mLModelId - The ID of the MLModel to evaluate.
    The schema used in creating the MLModel must match the schema of the DataSource used in the Evaluation.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getEvaluationDataSourceId
```
public String getEvaluationDataSourceId()
```
    The ID of the DataSource for the evaluation. The schema of the DataSource must match the schema used to create the MLModel.
    Constraints:
    Length: 1 - 64
    Pattern: [a-zA-Z0-9_.-]+
    
    Returns:
    The ID of the DataSource for the evaluation. The schema of the DataSource must match the schema used to create the MLModel.
  - setEvaluationDataSourceId
```
public void setEvaluationDataSourceId(String evaluationDataSourceId)
```
    The ID of the DataSource for the evaluation. The schema of the DataSource must match the schema used to create the MLModel.
    Constraints:
    Length: 1 - 64
    Pattern: [a-zA-Z0-9_.-]+
    
    Parameters:
    evaluationDataSourceId - The ID of the DataSource for the evaluation. The schema of the DataSource must match the schema used to create the MLModel.
  - withEvaluationDataSourceId
```
public CreateEvaluationRequest withEvaluationDataSourceId(String evaluationDataSourceId)
```
    The ID of the DataSource for the evaluation. The schema of the DataSource must match the schema used to create the MLModel.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 64
    Pattern: [a-zA-Z0-9_.-]+
    
    Parameters:
    evaluationDataSourceId - The ID of the DataSource for the evaluation. The schema of the DataSource must match the schema used to create the MLModel.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    A string representation of this object.
    See Also:
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - clone
```
public CreateEvaluationRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    Object.clone()

Class CreateEvaluationRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateEvaluationRequest

Method Detail

getEvaluationId

setEvaluationId

withEvaluationId

getEvaluationName

setEvaluationName

withEvaluationName

getMLModelId

setMLModelId

withMLModelId

getEvaluationDataSourceId

setEvaluationDataSourceId

withEvaluationDataSourceId

toString

hashCode

equals

clone