com.amazonaws.services.machinelearning.model

Class PredictRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.machinelearning.model.PredictRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class PredictRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the Predict operation.

Generates a prediction for the observation using the specified MLModel .

NOTE: Note Not all response parameters will be populated because this is dependent on the type of requested model.

See Also:

AmazonMachineLearning.predict(PredictRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
PredictRequest()

Method Summary

Methods

Modifier and Type	Method and Description
PredictRequest	addRecordEntry(String key, String value) A map of variable name-value pairs that represent an observation.
PredictRequest	clearRecordEntries() Removes all the entries added into Record.
PredictRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getMLModelId() A unique identifier of the MLModel.
String	getPredictEndpoint() Returns the value of the PredictEndpoint property for this object.
Map<String,String>	getRecord() A map of variable name-value pairs that represent an observation.
int	hashCode()
void	setMLModelId(String mLModelId) A unique identifier of the MLModel.
void	setPredictEndpoint(String predictEndpoint) Sets the value of the PredictEndpoint property for this object.
void	setRecord(Map<String,String> record) A map of variable name-value pairs that represent an observation.
String	toString() Returns a string representation of this object; useful for testing and debugging.
PredictRequest	withMLModelId(String mLModelId) A unique identifier of the MLModel.
PredictRequest	withPredictEndpoint(String predictEndpoint) Sets the value of the PredictEndpoint property for this object.
PredictRequest	withRecord(Map<String,String> record) A map of variable name-value pairs that represent an observation.

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

PredictRequest

public PredictRequest()

Method Detail

getMLModelId

public String getMLModelId()

A unique identifier of the MLModel.

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_.-]+

Returns:

A unique identifier of the MLModel.

setMLModelId

public void setMLModelId(String mLModelId)

A unique identifier of the MLModel.

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_.-]+

Parameters:

mLModelId - A unique identifier of the MLModel.

withMLModelId

public PredictRequest withMLModelId(String mLModelId)

A unique identifier of 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:

mLModelId - A unique identifier of the MLModel.

Returns:

A reference to this updated object so that method calls can be chained together.

getRecord

public Map<String,String> getRecord()

A map of variable name-value pairs that represent an observation.

Returns:

A map of variable name-value pairs that represent an observation.

setRecord

public void setRecord(Map<String,String> record)

A map of variable name-value pairs that represent an observation.

Parameters:

record - A map of variable name-value pairs that represent an observation.

withRecord

public PredictRequest withRecord(Map<String,String> record)

A map of variable name-value pairs that represent an observation.

Returns a reference to this object so that method calls can be chained together.

Parameters:

record - A map of variable name-value pairs that represent an observation.

Returns:

A reference to this updated object so that method calls can be chained together.

addRecordEntry

public PredictRequest addRecordEntry(String key,
                            String value)

A map of variable name-value pairs that represent an observation.

The method adds a new key-value pair into Record parameter, and returns a reference to this object so that method calls can be chained together.

Parameters:

key - The key of the entry to be added into Record.

value - The corresponding value of the entry to be added into Record.

clearRecordEntries

public PredictRequest clearRecordEntries()

Removes all the entries added into Record.

Returns a reference to this object so that method calls can be chained together.

getPredictEndpoint

public String getPredictEndpoint()

Returns the value of the PredictEndpoint property for this object.

Constraints:
Length: 0 - 2048
Pattern: https://[a-zA-Z0-9-.]*\.amazon(aws)?\.com[/]?

Returns:

The value of the PredictEndpoint property for this object.

setPredictEndpoint

public void setPredictEndpoint(String predictEndpoint)

Sets the value of the PredictEndpoint property for this object.

Constraints:
Length: 0 - 2048
Pattern: https://[a-zA-Z0-9-.]*\.amazon(aws)?\.com[/]?

Parameters:

predictEndpoint - The new value for the PredictEndpoint property for this object.

withPredictEndpoint

public PredictRequest withPredictEndpoint(String predictEndpoint)

Sets the value of the PredictEndpoint property for this object.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 0 - 2048
Pattern: https://[a-zA-Z0-9-.]*\.amazon(aws)?\.com[/]?

Parameters:

predictEndpoint - The new value for the PredictEndpoint property for this object.

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 PredictRequest 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()