java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.machinelearning.model.MachineLearningRequest
    - - software.amazon.awssdk.services.machinelearning.model.DescribeBatchPredictionsRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<DescribeBatchPredictionsRequest.Builder,DescribeBatchPredictionsRequest>

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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DescribeBatchPredictionsRequest.Builder

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)`
`boolean`	`equalsBySdkFields(Object obj)`
`BatchPredictionFilterVariable`	`filterVariable()`	Use one of the following variables to filter a list of `BatchPrediction`:
`String`	`filterVariableAsString()`	Use one of the following variables to filter a list of `BatchPrediction`:
`String`	`ge()`	The greater than or equal to operator.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`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`.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeBatchPredictionsRequest.Builder>`	`serializableBuilderClass()`
`SortOrder`	`sortOrder()`	A two-value parameter that determines the sequence of the resulting list of `MLModel`s.
`String`	`sortOrderAsString()`	A two-value parameter that determines the sequence of the resulting list of `MLModel`s.
`DescribeBatchPredictionsRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - filterVariable
```
public final 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.
    
    If the service returns an enum value that is not available in the current SDK version, filterVariable will return BatchPredictionFilterVariable.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from filterVariableAsString().
    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
  - filterVariableAsString
```
public final String filterVariableAsString()
```
    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.
    
    If the service returns an enum value that is not available in the current SDK version, filterVariable will return BatchPredictionFilterVariable.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from filterVariableAsString().
    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 final 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 final 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 final 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 final 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 final 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 final 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 final 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 final 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.
    
    If the service returns an enum value that is not available in the current SDK version, sortOrder will return SortOrder.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortOrderAsString().
    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
  - sortOrderAsString
```
public final String sortOrderAsString()
```
    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.
    
    If the service returns an enum value that is not available in the current SDK version, sortOrder will return SortOrder.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortOrderAsString().
    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 final String nextToken()
```
    An ID of the page in the paginated results.
    
    Returns:
    
    An ID of the page in the paginated results.
  - limit
```
public final 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeBatchPredictionsRequest.Builder,DescribeBatchPredictionsRequest>
    
    Specified by:
    
    toBuilder in class MachineLearningRequest
  - builder
```
public static DescribeBatchPredictionsRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeBatchPredictionsRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DescribeBatchPredictionsRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

filterVariable

filterVariableAsString

eq

gt

lt

ge

le

ne

prefix

sortOrder

sortOrderAsString

nextToken

limit

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields