Class DescribeEvaluationsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.machinelearning.model.DescribeEvaluationsRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DescribeEvaluationsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

• Serialized Form

Field Summary

Fields inherited from class AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor	Description
DescribeEvaluationsRequest()

Method Summary

Modifier and Type	Method	Description
DescribeEvaluationsRequest	clone()	Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getEQ()	The equal to operator.
String	getFilterVariable()	Use one of the following variable to filter a list of Evaluation objects:
String	getGE()	The greater than or equal to operator.
String	getGT()	The greater than operator.
String	getLE()	The less than or equal to operator.
Integer	getLimit()	The maximum number of Evaluation to include in the result.
String	getLT()	The less than operator.
String	getNE()	The not equal to operator.
String	getNextToken()	The ID of the page in the paginated results.
String	getPrefix()	A string that is found at the beginning of a variable, such as Name or Id.
String	getSortOrder()	A two-value parameter that determines the sequence of the resulting list of Evaluation.
int	hashCode()
void	setEQ(String eQ)	The equal to operator.
void	setFilterVariable(EvaluationFilterVariable filterVariable)	Use one of the following variable to filter a list of Evaluation objects:
void	setFilterVariable(String filterVariable)	Use one of the following variable to filter a list of Evaluation objects:
void	setGE(String gE)	The greater than or equal to operator.
void	setGT(String gT)	The greater than operator.
void	setLE(String lE)	The less than or equal to operator.
void	setLimit(Integer limit)	The maximum number of Evaluation to include in the result.
void	setLT(String lT)	The less than operator.
void	setNE(String nE)	The not equal to operator.
void	setNextToken(String nextToken)	The ID of the page in the paginated results.
void	setPrefix(String prefix)	A string that is found at the beginning of a variable, such as Name or Id.
void	setSortOrder(SortOrder sortOrder)	A two-value parameter that determines the sequence of the resulting list of Evaluation.
void	setSortOrder(String sortOrder)	A two-value parameter that determines the sequence of the resulting list of Evaluation.
String	toString()	Returns a string representation of this object; useful for testing and debugging.
DescribeEvaluationsRequest	withEQ(String eQ)	The equal to operator.
DescribeEvaluationsRequest	withFilterVariable(EvaluationFilterVariable filterVariable)	Use one of the following variable to filter a list of Evaluation objects:
DescribeEvaluationsRequest	withFilterVariable(String filterVariable)	Use one of the following variable to filter a list of Evaluation objects:
DescribeEvaluationsRequest	withGE(String gE)	The greater than or equal to operator.
DescribeEvaluationsRequest	withGT(String gT)	The greater than operator.
DescribeEvaluationsRequest	withLE(String lE)	The less than or equal to operator.
DescribeEvaluationsRequest	withLimit(Integer limit)	The maximum number of Evaluation to include in the result.
DescribeEvaluationsRequest	withLT(String lT)	The less than operator.
DescribeEvaluationsRequest	withNE(String nE)	The not equal to operator.
DescribeEvaluationsRequest	withNextToken(String nextToken)	The ID of the page in the paginated results.
DescribeEvaluationsRequest	withPrefix(String prefix)	A string that is found at the beginning of a variable, such as Name or Id.
DescribeEvaluationsRequest	withSortOrder(SortOrder sortOrder)	A two-value parameter that determines the sequence of the resulting list of Evaluation.
DescribeEvaluationsRequest	withSortOrder(String sortOrder)	A two-value parameter that determines the sequence of the resulting list of Evaluation.

Methods inherited from class AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

DescribeEvaluationsRequest

public DescribeEvaluationsRequest()

Method Details

setFilterVariable

public void setFilterVariable(String filterVariable)

Use one of the following variable to filter a list of Evaluation objects:

• CreatedAt - Sets the search criteria to the Evaluation creation date.
• Status - Sets the search criteria to the Evaluation status.
• Name - Sets the search criteria to the contents of Evaluation Name.
• IAMUser - Sets the search criteria to the user account that invoked an Evaluation.
• MLModelId - Sets the search criteria to the MLModel that was evaluated.
• DataSourceId - Sets the search criteria to the DataSource used in Evaluation.
• DataUri - Sets the search criteria to the data file(s) used in Evaluation. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.

Parameters:

filterVariable - Use one of the following variable to filter a list of Evaluation objects:

• CreatedAt - Sets the search criteria to the Evaluation creation date.
• Status - Sets the search criteria to the Evaluation status.
• Name - Sets the search criteria to the contents of Evaluation Name.
• IAMUser - Sets the search criteria to the user account that invoked an Evaluation.
• MLModelId - Sets the search criteria to the MLModel that was evaluated.
• DataSourceId - Sets the search criteria to the DataSource used in Evaluation.
• DataUri - Sets the search criteria to the data file(s) used in Evaluation. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.

See Also:

• EvaluationFilterVariable

getFilterVariable

public String getFilterVariable()

Use one of the following variable to filter a list of Evaluation objects:

• CreatedAt - Sets the search criteria to the Evaluation creation date.
• Status - Sets the search criteria to the Evaluation status.
• Name - Sets the search criteria to the contents of Evaluation Name.
• IAMUser - Sets the search criteria to the user account that invoked an Evaluation.
• MLModelId - Sets the search criteria to the MLModel that was evaluated.
• DataSourceId - Sets the search criteria to the DataSource used in Evaluation.
• DataUri - Sets the search criteria to the data file(s) used in Evaluation. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.

Returns:

Use one of the following variable to filter a list of Evaluation objects:

• CreatedAt - Sets the search criteria to the Evaluation creation date.
• Status - Sets the search criteria to the Evaluation status.
• Name - Sets the search criteria to the contents of Evaluation Name.
• IAMUser - Sets the search criteria to the user account that invoked an Evaluation.
• MLModelId - Sets the search criteria to the MLModel that was evaluated.
• DataSourceId - Sets the search criteria to the DataSource used in Evaluation.
• DataUri - Sets the search criteria to the data file(s) used in Evaluation. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.

See Also:

• EvaluationFilterVariable

withFilterVariable

public DescribeEvaluationsRequest withFilterVariable(String filterVariable)

Use one of the following variable to filter a list of Evaluation objects:

• CreatedAt - Sets the search criteria to the Evaluation creation date.
• Status - Sets the search criteria to the Evaluation status.
• Name - Sets the search criteria to the contents of Evaluation Name.
• IAMUser - Sets the search criteria to the user account that invoked an Evaluation.
• MLModelId - Sets the search criteria to the MLModel that was evaluated.
• DataSourceId - Sets the search criteria to the DataSource used in Evaluation.
• DataUri - Sets the search criteria to the data file(s) used in Evaluation. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.

Parameters:

filterVariable - Use one of the following variable to filter a list of Evaluation objects:

• CreatedAt - Sets the search criteria to the Evaluation creation date.
• Status - Sets the search criteria to the Evaluation status.
• Name - Sets the search criteria to the contents of Evaluation Name.
• IAMUser - Sets the search criteria to the user account that invoked an Evaluation.
• MLModelId - Sets the search criteria to the MLModel that was evaluated.
• DataSourceId - Sets the search criteria to the DataSource used in Evaluation.
• DataUri - Sets the search criteria to the data file(s) used in Evaluation. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.

Returns:

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

See Also:

• EvaluationFilterVariable

setFilterVariable

public void setFilterVariable(EvaluationFilterVariable filterVariable)

Use one of the following variable to filter a list of Evaluation objects:

• CreatedAt - Sets the search criteria to the Evaluation creation date.
• Status - Sets the search criteria to the Evaluation status.
• Name - Sets the search criteria to the contents of Evaluation Name.
• IAMUser - Sets the search criteria to the user account that invoked an Evaluation.
• MLModelId - Sets the search criteria to the MLModel that was evaluated.
• DataSourceId - Sets the search criteria to the DataSource used in Evaluation.
• DataUri - Sets the search criteria to the data file(s) used in Evaluation. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.

Parameters:

filterVariable - Use one of the following variable to filter a list of Evaluation objects:

• CreatedAt - Sets the search criteria to the Evaluation creation date.
• Status - Sets the search criteria to the Evaluation status.
• Name - Sets the search criteria to the contents of Evaluation Name.
• IAMUser - Sets the search criteria to the user account that invoked an Evaluation.
• MLModelId - Sets the search criteria to the MLModel that was evaluated.
• DataSourceId - Sets the search criteria to the DataSource used in Evaluation.
• DataUri - Sets the search criteria to the data file(s) used in Evaluation. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.

See Also:

• EvaluationFilterVariable

withFilterVariable

public DescribeEvaluationsRequest withFilterVariable(EvaluationFilterVariable filterVariable)

Use one of the following variable to filter a list of Evaluation objects:

• CreatedAt - Sets the search criteria to the Evaluation creation date.
• Status - Sets the search criteria to the Evaluation status.
• Name - Sets the search criteria to the contents of Evaluation Name.
• IAMUser - Sets the search criteria to the user account that invoked an Evaluation.
• MLModelId - Sets the search criteria to the MLModel that was evaluated.
• DataSourceId - Sets the search criteria to the DataSource used in Evaluation.
• DataUri - Sets the search criteria to the data file(s) used in Evaluation. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.

Parameters:

filterVariable - Use one of the following variable to filter a list of Evaluation objects:

• CreatedAt - Sets the search criteria to the Evaluation creation date.
• Status - Sets the search criteria to the Evaluation status.
• Name - Sets the search criteria to the contents of Evaluation Name.
• IAMUser - Sets the search criteria to the user account that invoked an Evaluation.
• MLModelId - Sets the search criteria to the MLModel that was evaluated.
• DataSourceId - Sets the search criteria to the DataSource used in Evaluation.
• DataUri - Sets the search criteria to the data file(s) used in Evaluation. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.

Returns:

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

See Also:

• EvaluationFilterVariable

setEQ

public void setEQ(String eQ)

The equal to operator. The Evaluation results will have FilterVariable values that exactly match the value specified with EQ.

Parameters:

eQ - The equal to operator. The Evaluation results will have FilterVariable values that exactly match the value specified with EQ.

getEQ

public String getEQ()

The equal to operator. The Evaluation results will have FilterVariable values that exactly match the value specified with EQ.

Returns:

The equal to operator. The Evaluation results will have FilterVariable values that exactly match the value specified with EQ.

withEQ

public DescribeEvaluationsRequest withEQ(String eQ)

The equal to operator. The Evaluation results will have FilterVariable values that exactly match the value specified with EQ.

Parameters:

eQ - The equal to operator. The Evaluation results will have FilterVariable values that exactly match the value specified with EQ.

Returns:

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

setGT

public void setGT(String gT)

The greater than operator. The Evaluation results will have FilterVariable values that are greater than the value specified with GT.

Parameters:

gT - The greater than operator. The Evaluation results will have FilterVariable values that are greater than the value specified with GT.

getGT

public String getGT()

The greater than operator. The Evaluation results will have FilterVariable values that are greater than the value specified with GT.

Returns:

The greater than operator. The Evaluation results will have FilterVariable values that are greater than the value specified with GT.

withGT

public DescribeEvaluationsRequest withGT(String gT)

The greater than operator. The Evaluation results will have FilterVariable values that are greater than the value specified with GT.

Parameters:

gT - The greater than operator. The Evaluation results will have FilterVariable values that are greater than the value specified with GT.

Returns:

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

setLT

public void setLT(String lT)

The less than operator. The Evaluation results will have FilterVariable values that are less than the value specified with LT.

Parameters:

lT - The less than operator. The Evaluation results will have FilterVariable values that are less than the value specified with LT.

getLT

public String getLT()

The less than operator. The Evaluation results will have FilterVariable values that are less than the value specified with LT.

Returns:

The less than operator. The Evaluation results will have FilterVariable values that are less than the value specified with LT.

withLT

public DescribeEvaluationsRequest withLT(String lT)

The less than operator. The Evaluation results will have FilterVariable values that are less than the value specified with LT.

Parameters:

lT - The less than operator. The Evaluation results will have FilterVariable values that are less than the value specified with LT.

Returns:

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

setGE

public void setGE(String gE)

The greater than or equal to operator. The Evaluation results will have FilterVariable values that are greater than or equal to the value specified with GE.

Parameters:

gE - The greater than or equal to operator. The Evaluation results will have FilterVariable values that are greater than or equal to the value specified with GE.

getGE

public String getGE()

The greater than or equal to operator. The Evaluation results will have FilterVariable values that are greater than or equal to the value specified with GE.

Returns:

The greater than or equal to operator. The Evaluation results will have FilterVariable values that are greater than or equal to the value specified with GE.

withGE

public DescribeEvaluationsRequest withGE(String gE)

The greater than or equal to operator. The Evaluation results will have FilterVariable values that are greater than or equal to the value specified with GE.

Parameters:

gE - The greater than or equal to operator. The Evaluation results will have FilterVariable values that are greater than or equal to the value specified with GE.

Returns:

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

setLE

public void setLE(String lE)

The less than or equal to operator. The Evaluation results will have FilterVariable values that are less than or equal to the value specified with LE.

Parameters:

lE - The less than or equal to operator. The Evaluation results will have FilterVariable values that are less than or equal to the value specified with LE.

getLE

public String getLE()

The less than or equal to operator. The Evaluation results will have FilterVariable values that are less than or equal to the value specified with LE.

Returns:

The less than or equal to operator. The Evaluation results will have FilterVariable values that are less than or equal to the value specified with LE.

withLE

public DescribeEvaluationsRequest withLE(String lE)

The less than or equal to operator. The Evaluation results will have FilterVariable values that are less than or equal to the value specified with LE.

Parameters:

lE - The less than or equal to operator. The Evaluation results will have FilterVariable values that are less than or equal to the value specified with LE.

Returns:

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

setNE

public void setNE(String nE)

The not equal to operator. The Evaluation results will have FilterVariable values not equal to the value specified with NE.

Parameters:

nE - The not equal to operator. The Evaluation results will have FilterVariable values not equal to the value specified with NE.

getNE

public String getNE()

The not equal to operator. The Evaluation results will have FilterVariable values not equal to the value specified with NE.

Returns:

The not equal to operator. The Evaluation results will have FilterVariable values not equal to the value specified with NE.

withNE

public DescribeEvaluationsRequest withNE(String nE)

The not equal to operator. The Evaluation results will have FilterVariable values not equal to the value specified with NE.

Parameters:

nE - The not equal to operator. The Evaluation results will have FilterVariable values not equal to the value specified with NE.

Returns:

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

setPrefix

public void setPrefix(String prefix)

A string that is found at the beginning of a variable, such as Name or Id.

For example, an Evaluation could have the Name 2014-09-09-HolidayGiftMailer. To search for this Evaluation, select Name for the FilterVariable and any of the following strings for the Prefix:

• 2014-09

• 2014-09-09

• 2014-09-09-Holiday

Parameters:

prefix - A string that is found at the beginning of a variable, such as Name or Id.

For example, an Evaluation could have the Name 2014-09-09-HolidayGiftMailer. To search for this Evaluation, select Name for the FilterVariable and any of the following strings for the Prefix:

• 2014-09

• 2014-09-09

• 2014-09-09-Holiday

getPrefix

public String getPrefix()

A string that is found at the beginning of a variable, such as Name or Id.

For example, an Evaluation could have the Name 2014-09-09-HolidayGiftMailer. To search for this Evaluation, select Name for the FilterVariable and any of the following strings for the Prefix:

• 2014-09

• 2014-09-09

• 2014-09-09-Holiday

Returns:

A string that is found at the beginning of a variable, such as Name or Id.

For example, an Evaluation could have the Name 2014-09-09-HolidayGiftMailer. To search for this Evaluation, select Name for the FilterVariable and any of the following strings for the Prefix:

• 2014-09

• 2014-09-09

• 2014-09-09-Holiday

withPrefix

public DescribeEvaluationsRequest withPrefix(String prefix)

A string that is found at the beginning of a variable, such as Name or Id.

For example, an Evaluation could have the Name 2014-09-09-HolidayGiftMailer. To search for this Evaluation, select Name for the FilterVariable and any of the following strings for the Prefix:

• 2014-09

• 2014-09-09

• 2014-09-09-Holiday

Parameters:

prefix - A string that is found at the beginning of a variable, such as Name or Id.

For example, an Evaluation could have the Name 2014-09-09-HolidayGiftMailer. To search for this Evaluation, select Name for the FilterVariable and any of the following strings for the Prefix:

• 2014-09

• 2014-09-09

• 2014-09-09-Holiday

Returns:

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

setSortOrder

public void setSortOrder(String sortOrder)

A two-value parameter that determines the sequence of the resulting list of Evaluation.

• asc - Arranges the list in ascending order (A-Z, 0-9).
• dsc - Arranges the list in descending order (Z-A, 9-0).

Results are sorted by FilterVariable.

Parameters:

sortOrder - A two-value parameter that determines the sequence of the resulting list of Evaluation.

• asc - Arranges the list in ascending order (A-Z, 0-9).
• dsc - Arranges the list in descending order (Z-A, 9-0).

Results are sorted by FilterVariable.

See Also:

• SortOrder

getSortOrder

public String getSortOrder()

A two-value parameter that determines the sequence of the resulting list of Evaluation.

• asc - Arranges the list in ascending order (A-Z, 0-9).
• dsc - Arranges the list in descending order (Z-A, 9-0).

Results are sorted by FilterVariable.

Returns:

A two-value parameter that determines the sequence of the resulting list of Evaluation.

• asc - Arranges the list in ascending order (A-Z, 0-9).
• dsc - Arranges the list in descending order (Z-A, 9-0).

Results are sorted by FilterVariable.

See Also:

• SortOrder

withSortOrder

public DescribeEvaluationsRequest withSortOrder(String sortOrder)

A two-value parameter that determines the sequence of the resulting list of Evaluation.

• asc - Arranges the list in ascending order (A-Z, 0-9).
• dsc - Arranges the list in descending order (Z-A, 9-0).

Results are sorted by FilterVariable.

Parameters:

sortOrder - A two-value parameter that determines the sequence of the resulting list of Evaluation.

• asc - Arranges the list in ascending order (A-Z, 0-9).
• dsc - Arranges the list in descending order (Z-A, 9-0).

Results are sorted by FilterVariable.

Returns:

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

See Also:

• SortOrder

setSortOrder

public void setSortOrder(SortOrder sortOrder)

A two-value parameter that determines the sequence of the resulting list of Evaluation.

• asc - Arranges the list in ascending order (A-Z, 0-9).
• dsc - Arranges the list in descending order (Z-A, 9-0).

Results are sorted by FilterVariable.

Parameters:

sortOrder - A two-value parameter that determines the sequence of the resulting list of Evaluation.

• asc - Arranges the list in ascending order (A-Z, 0-9).
• dsc - Arranges the list in descending order (Z-A, 9-0).

Results are sorted by FilterVariable.

See Also:

• SortOrder

withSortOrder

public DescribeEvaluationsRequest withSortOrder(SortOrder sortOrder)

A two-value parameter that determines the sequence of the resulting list of Evaluation.

• asc - Arranges the list in ascending order (A-Z, 0-9).
• dsc - Arranges the list in descending order (Z-A, 9-0).

Results are sorted by FilterVariable.

Parameters:

sortOrder - A two-value parameter that determines the sequence of the resulting list of Evaluation.

• asc - Arranges the list in ascending order (A-Z, 0-9).
• dsc - Arranges the list in descending order (Z-A, 9-0).

Results are sorted by FilterVariable.

Returns:

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

See Also:

• SortOrder

setNextToken

public void setNextToken(String nextToken)

The ID of the page in the paginated results.

Parameters:

nextToken - The ID of the page in the paginated results.

getNextToken

public String getNextToken()

The ID of the page in the paginated results.

Returns:

The ID of the page in the paginated results.

withNextToken

public DescribeEvaluationsRequest withNextToken(String nextToken)

The ID of the page in the paginated results.

Parameters:

nextToken - The ID of the page in the paginated results.

Returns:

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

setLimit

public void setLimit(Integer limit)

The maximum number of Evaluation to include in the result.

Parameters:

limit - The maximum number of Evaluation to include in the result.

getLimit

public Integer getLimit()

The maximum number of Evaluation to include in the result.

Returns:

The maximum number of Evaluation to include in the result.

withLimit

public DescribeEvaluationsRequest withLimit(Integer limit)

The maximum number of Evaluation to include in the result.

Parameters:

limit - The maximum number of Evaluation to include in the result.

Returns:

Returns a reference to this 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()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DescribeEvaluationsRequest 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()