Class DescribeBatchPredictionsRequest

    • Constructor Detail

      • DescribeBatchPredictionsRequest

        public DescribeBatchPredictionsRequest()
    • Method Detail

      • setFilterVariable

        public void setFilterVariable​(String filterVariable)

        Use one of the following variables to filter a list of BatchPrediction:

        • CreatedAt - Sets the search criteria to the BatchPrediction creation date.
        • Status - Sets the search criteria to the BatchPrediction status.
        • Name - Sets the search criteria to the contents of the BatchPrediction Name.
        • IAMUser - Sets the search criteria to the user account that invoked the BatchPrediction creation.
        • MLModelId - Sets the search criteria to the MLModel used in the BatchPrediction.
        • DataSourceId - Sets the search criteria to the DataSource used in the BatchPrediction.
        • DataURI - Sets the search criteria to the data file(s) used in the BatchPrediction. 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 variables to filter a list of BatchPrediction:

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

        public String getFilterVariable()

        Use one of the following variables to filter a list of BatchPrediction:

        • CreatedAt - Sets the search criteria to the BatchPrediction creation date.
        • Status - Sets the search criteria to the BatchPrediction status.
        • Name - Sets the search criteria to the contents of the BatchPrediction Name.
        • IAMUser - Sets the search criteria to the user account that invoked the BatchPrediction creation.
        • MLModelId - Sets the search criteria to the MLModel used in the BatchPrediction.
        • DataSourceId - Sets the search criteria to the DataSource used in the BatchPrediction.
        • DataURI - Sets the search criteria to the data file(s) used in the BatchPrediction. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.
        Returns:
        Use one of the following variables to filter a list of BatchPrediction:

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

        public DescribeBatchPredictionsRequest withFilterVariable​(String filterVariable)

        Use one of the following variables to filter a list of BatchPrediction:

        • CreatedAt - Sets the search criteria to the BatchPrediction creation date.
        • Status - Sets the search criteria to the BatchPrediction status.
        • Name - Sets the search criteria to the contents of the BatchPrediction Name.
        • IAMUser - Sets the search criteria to the user account that invoked the BatchPrediction creation.
        • MLModelId - Sets the search criteria to the MLModel used in the BatchPrediction.
        • DataSourceId - Sets the search criteria to the DataSource used in the BatchPrediction.
        • DataURI - Sets the search criteria to the data file(s) used in the BatchPrediction. 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 variables to filter a list of BatchPrediction:

        • CreatedAt - Sets the search criteria to the BatchPrediction creation date.
        • Status - Sets the search criteria to the BatchPrediction status.
        • Name - Sets the search criteria to the contents of the BatchPrediction Name.
        • IAMUser - Sets the search criteria to the user account that invoked the BatchPrediction creation.
        • MLModelId - Sets the search criteria to the MLModel used in the BatchPrediction.
        • DataSourceId - Sets the search criteria to the DataSource used in the BatchPrediction.
        • DataURI - Sets the search criteria to the data file(s) used in the BatchPrediction. 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:
        BatchPredictionFilterVariable
      • setFilterVariable

        public void setFilterVariable​(BatchPredictionFilterVariable filterVariable)

        Use one of the following variables to filter a list of BatchPrediction:

        • CreatedAt - Sets the search criteria to the BatchPrediction creation date.
        • Status - Sets the search criteria to the BatchPrediction status.
        • Name - Sets the search criteria to the contents of the BatchPrediction Name.
        • IAMUser - Sets the search criteria to the user account that invoked the BatchPrediction creation.
        • MLModelId - Sets the search criteria to the MLModel used in the BatchPrediction.
        • DataSourceId - Sets the search criteria to the DataSource used in the BatchPrediction.
        • DataURI - Sets the search criteria to the data file(s) used in the BatchPrediction. 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 variables to filter a list of BatchPrediction:

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

        public DescribeBatchPredictionsRequest withFilterVariable​(BatchPredictionFilterVariable filterVariable)

        Use one of the following variables to filter a list of BatchPrediction:

        • CreatedAt - Sets the search criteria to the BatchPrediction creation date.
        • Status - Sets the search criteria to the BatchPrediction status.
        • Name - Sets the search criteria to the contents of the BatchPrediction Name.
        • IAMUser - Sets the search criteria to the user account that invoked the BatchPrediction creation.
        • MLModelId - Sets the search criteria to the MLModel used in the BatchPrediction.
        • DataSourceId - Sets the search criteria to the DataSource used in the BatchPrediction.
        • DataURI - Sets the search criteria to the data file(s) used in the BatchPrediction. 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 variables to filter a list of BatchPrediction:

        • CreatedAt - Sets the search criteria to the BatchPrediction creation date.
        • Status - Sets the search criteria to the BatchPrediction status.
        • Name - Sets the search criteria to the contents of the BatchPrediction Name.
        • IAMUser - Sets the search criteria to the user account that invoked the BatchPrediction creation.
        • MLModelId - Sets the search criteria to the MLModel used in the BatchPrediction.
        • DataSourceId - Sets the search criteria to the DataSource used in the BatchPrediction.
        • DataURI - Sets the search criteria to the data file(s) used in the BatchPrediction. 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:
        BatchPredictionFilterVariable
      • setEQ

        public void setEQ​(String eQ)

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

        Parameters:
        eQ - The equal to operator. The BatchPrediction results will have FilterVariable values that exactly match the value specified with EQ.
      • getEQ

        public String getEQ()

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

        Returns:
        The equal to operator. The BatchPrediction results will have FilterVariable values that exactly match the value specified with EQ.
      • withEQ

        public DescribeBatchPredictionsRequest withEQ​(String eQ)

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

        Parameters:
        eQ - The equal to operator. The BatchPrediction 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 BatchPrediction results will have FilterVariable values that are greater than the value specified with GT.

        Parameters:
        gT - The greater than operator. The BatchPrediction results will have FilterVariable values that are greater than the value specified with GT.
      • getGT

        public String getGT()

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

        Returns:
        The greater than operator. The BatchPrediction results will have FilterVariable values that are greater than the value specified with GT.
      • withGT

        public DescribeBatchPredictionsRequest withGT​(String gT)

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

        Parameters:
        gT - The greater than operator. The BatchPrediction 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 BatchPrediction results will have FilterVariable values that are less than the value specified with LT.

        Parameters:
        lT - The less than operator. The BatchPrediction results will have FilterVariable values that are less than the value specified with LT.
      • getLT

        public String getLT()

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

        Returns:
        The less than operator. The BatchPrediction results will have FilterVariable values that are less than the value specified with LT.
      • withLT

        public DescribeBatchPredictionsRequest withLT​(String lT)

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

        Parameters:
        lT - The less than operator. The BatchPrediction 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 BatchPrediction 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 BatchPrediction 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 BatchPrediction 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 BatchPrediction results will have FilterVariable values that are greater than or equal to the value specified with GE.
      • withGE

        public DescribeBatchPredictionsRequest withGE​(String gE)

        The greater than or equal to operator. The BatchPrediction 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 BatchPrediction 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 BatchPrediction 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 BatchPrediction 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 BatchPrediction 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 BatchPrediction results will have FilterVariable values that are less than or equal to the value specified with LE.
      • withLE

        public DescribeBatchPredictionsRequest withLE​(String lE)

        The less than or equal to operator. The BatchPrediction 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 BatchPrediction 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 BatchPrediction results will have FilterVariable values not equal to the value specified with NE.

        Parameters:
        nE - The not equal to operator. The BatchPrediction results will have FilterVariable values not equal to the value specified with NE.
      • getNE

        public String getNE()

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

        Returns:
        The not equal to operator. The BatchPrediction results will have FilterVariable values not equal to the value specified with NE.
      • withNE

        public DescribeBatchPredictionsRequest withNE​(String nE)

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

        Parameters:
        nE - The not equal to operator. The BatchPrediction 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, a Batch Prediction operation could have the Name 2014-09-09-HolidayGiftMailer. To search for this BatchPrediction, 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, a Batch Prediction operation could have the Name 2014-09-09-HolidayGiftMailer. To search for this BatchPrediction, 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, a Batch Prediction operation could have the Name 2014-09-09-HolidayGiftMailer. To search for this BatchPrediction, 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, a Batch Prediction operation could have the Name 2014-09-09-HolidayGiftMailer. To search for this BatchPrediction, 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 DescribeBatchPredictionsRequest withPrefix​(String prefix)

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

        For example, a Batch Prediction operation could have the Name 2014-09-09-HolidayGiftMailer. To search for this BatchPrediction, 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, a Batch Prediction operation could have the Name 2014-09-09-HolidayGiftMailer. To search for this BatchPrediction, 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 MLModels.

        • 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 MLModels.

        • 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 MLModels.

        • 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 MLModels.

        • 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 DescribeBatchPredictionsRequest withSortOrder​(String sortOrder)

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

        • 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 MLModels.

        • 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 MLModels.

        • 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 MLModels.

        • 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 DescribeBatchPredictionsRequest withSortOrder​(SortOrder sortOrder)

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

        • 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 MLModels.

        • 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)

        An ID of the page in the paginated results.

        Parameters:
        nextToken - An ID of the page in the paginated results.
      • getNextToken

        public String getNextToken()

        An ID of the page in the paginated results.

        Returns:
        An ID of the page in the paginated results.
      • withNextToken

        public DescribeBatchPredictionsRequest withNextToken​(String nextToken)

        An ID of the page in the paginated results.

        Parameters:
        nextToken - An 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 number of pages of information to include in the result. The range of acceptable values is 1 through 100. The default value is 100.

        Parameters:
        limit - The number of pages of information to include in the result. The range of acceptable values is 1 through 100. The default value is 100.
      • getLimit

        public Integer getLimit()

        The number of pages of information to include in the result. The range of acceptable values is 1 through 100. The default value is 100.

        Returns:
        The number of pages of information to include in the result. The range of acceptable values is 1 through 100. The default value is 100.
      • withLimit

        public DescribeBatchPredictionsRequest withLimit​(Integer limit)

        The number of pages of information to include in the result. The range of acceptable values is 1 through 100. The default value is 100.

        Parameters:
        limit - The number of pages of information to include in the result. The range of acceptable values is 1 through 100. The default value is 100.
        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()
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object