@Generated(value="software.amazon.awssdk:codegen") public class DescribeBatchPredictionsRequest extends MachineLearningRequest implements ToCopyableBuilder<DescribeBatchPredictionsRequest.Builder,DescribeBatchPredictionsRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
DescribeBatchPredictionsRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static DescribeBatchPredictionsRequest.Builder |
builder() |
String |
eq()
The equal to operator.
|
boolean |
equals(Object obj) |
BatchPredictionFilterVariable |
filterVariable()
Use one of the following variables to filter a list of
BatchPrediction : |
String |
filterVariableString()
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)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
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() |
SortOrder |
sortOrder()
A two-value parameter that determines the sequence of the resulting list of
MLModel s. |
String |
sortOrderString()
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() |
requestOverrideConfig
copy
public 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 filterVariableString()
.
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.BatchPredictionFilterVariable
public String filterVariableString()
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 filterVariableString()
.
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.BatchPredictionFilterVariable
public String eq()
The equal to operator. The BatchPrediction
results will have FilterVariable
values that
exactly match the value specified with EQ
.
BatchPrediction
results will have FilterVariable
values that exactly match the value specified with EQ
.public String gt()
The greater than operator. The BatchPrediction
results will have FilterVariable
values
that are greater than the value specified with GT
.
BatchPrediction
results will have FilterVariable
values that are greater than the value specified with GT
.public String lt()
The less than operator. The BatchPrediction
results will have FilterVariable
values
that are less than the value specified with LT
.
BatchPrediction
results will have FilterVariable
values that are less than the value specified with LT
.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
.
BatchPrediction
results will have
FilterVariable
values that are greater than or equal to the value specified with
GE
.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
.
BatchPrediction
results will have
FilterVariable
values that are less than or equal to the value specified with
LE
.public String ne()
The not equal to operator. The BatchPrediction
results will have FilterVariable
values
not equal to the value specified with NE
.
BatchPrediction
results will have FilterVariable
values not equal to the value specified with NE
.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
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
public SortOrder sortOrder()
A two-value parameter that determines the sequence of the resulting list of MLModel
s.
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
sortOrderString()
.
MLModel
s.
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
.
SortOrder
public String sortOrderString()
A two-value parameter that determines the sequence of the resulting list of MLModel
s.
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
sortOrderString()
.
MLModel
s.
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
.
SortOrder
public String nextToken()
An ID of the page in the paginated results.
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
.
1
through 100
. The default value is 100
.public DescribeBatchPredictionsRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DescribeBatchPredictionsRequest.Builder,DescribeBatchPredictionsRequest>
toBuilder
in class MachineLearningRequest
public static DescribeBatchPredictionsRequest.Builder builder()
public static Class<? extends DescribeBatchPredictionsRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.