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:
  • 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:
    • 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:
    • 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:
    • 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:
    • 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:
    • 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:
    • 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:
    • 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:
    • 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:
    • 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:
    • 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:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • 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: