DescribeBatchPredictionsRequest (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.AmazonWebServiceRequest
- - software.amazon.awssdk.services.machinelearning.model.DescribeBatchPredictionsRequest

All Implemented Interfaces:: Cloneable, ReadLimitInfo, ToCopyableBuilder<DescribeBatchPredictionsRequest.Builder,DescribeBatchPredictionsRequest>

@Generated("software.amazon.awssdk:codegen")
public class DescribeBatchPredictionsRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<DescribeBatchPredictionsRequest.Builder,DescribeBatchPredictionsRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DescribeBatchPredictionsRequest.Builder

Nested Classes
Modifier and Type	Class	Description
`static interface`	`DescribeBatchPredictionsRequest.Builder`

Field Summary
- Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest
  NOOP

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static DescribeBatchPredictionsRequest.Builder`	`builder()`
`String`	`eq()`	The equal to operator.
`boolean`	`equals(Object obj)`
`String`	`filterVariable()`	Use one of the following variables to filter a list of `BatchPrediction`:
`String`	`ge()`	The greater than or equal to operator.
`String`	`gt()`	The greater than operator.
`int`	`hashCode()`
`String`	`le()`	The less than or equal to operator.
`Integer`	`limit()`	The number of pages of information to include in the result.
`String`	`lt()`	The less than operator.
`String`	`ne()`	The not equal to operator.
`String`	`nextToken()`	An ID of the page in the paginated results.
`String`	`prefix()`	A string that is found at the beginning of a variable, such as `Name` or `Id`.
`static Class<? extends DescribeBatchPredictionsRequest.Builder>`	`serializableBuilderClass()`
`String`	`sortOrder()`	A two-value parameter that determines the sequence of the resulting list of `MLModel`s.
`DescribeBatchPredictionsRequest.Builder`	`toBuilder()`	Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

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

- Method Detail
  - filterVariable
```
public 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.
    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
  - eq
```
public String eq()
```
    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.
  - gt
```
public String gt()
```
    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.
  - lt
```
public String lt()
```
    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.
  - ge
```
public 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.
    
    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.
  - le
```
public 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.
    
    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.
  - ne
```
public String ne()
```
    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.
  - prefix
```
public 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
    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
  - sortOrder
```
public 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.
    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
  - nextToken
```
public String nextToken()
```
    An ID of the page in the paginated results.
    
    Returns:
    
    An ID of the page in the paginated results.
  - limit
```
public 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.
    
    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.
  - toBuilder
```
public DescribeBatchPredictionsRequest.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeBatchPredictionsRequest.Builder,DescribeBatchPredictionsRequest>
    
    Returns:
    
    a builder for type T
  - builder
```
public static DescribeBatchPredictionsRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeBatchPredictionsRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class DescribeBatchPredictionsRequest

Nested Class Summary

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

Method Summary

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Method Detail

filterVariable

eq

gt

lt

ge

le

ne

prefix

sortOrder

nextToken

limit

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString