Class DescribeBatchPredictionsRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
getEQ()
The equal to operator.Use one of the following variables to filter a list ofBatchPrediction
:getGE()
The greater than or equal to operator.getGT()
The greater than operator.getLE()
The less than or equal to operator.getLimit()
The number of pages of information to include in the result.getLT()
The less than operator.getNE()
The not equal to operator.An ID of the page in the paginated results.A string that is found at the beginning of a variable, such asName
orId
.A two-value parameter that determines the sequence of the resulting list ofMLModel
s.int
hashCode()
void
The equal to operator.void
setFilterVariable
(BatchPredictionFilterVariable filterVariable) Use one of the following variables to filter a list ofBatchPrediction
:void
setFilterVariable
(String filterVariable) Use one of the following variables to filter a list ofBatchPrediction
:void
The greater than or equal to operator.void
The greater than operator.void
The less than or equal to operator.void
The number of pages of information to include in the result.void
The less than operator.void
The not equal to operator.void
setNextToken
(String nextToken) An ID of the page in the paginated results.void
A string that is found at the beginning of a variable, such asName
orId
.void
setSortOrder
(SortOrder sortOrder) A two-value parameter that determines the sequence of the resulting list ofMLModel
s.void
setSortOrder
(String sortOrder) A two-value parameter that determines the sequence of the resulting list ofMLModel
s.toString()
Returns a string representation of this object; useful for testing and debugging.The equal to operator.withFilterVariable
(BatchPredictionFilterVariable filterVariable) Use one of the following variables to filter a list ofBatchPrediction
:withFilterVariable
(String filterVariable) Use one of the following variables to filter a list ofBatchPrediction
:The greater than or equal to operator.The greater than operator.The less than or equal to operator.The number of pages of information to include in the result.The less than operator.The not equal to operator.withNextToken
(String nextToken) An ID of the page in the paginated results.withPrefix
(String prefix) A string that is found at the beginning of a variable, such asName
orId
.withSortOrder
(SortOrder sortOrder) A two-value parameter that determines the sequence of the resulting list ofMLModel
s.withSortOrder
(String sortOrder) A two-value parameter that determines the sequence of the resulting list ofMLModel
s.Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
Constructor Details
-
DescribeBatchPredictionsRequest
public DescribeBatchPredictionsRequest()
-
-
Method Details
-
setFilterVariable
Use one of the following variables to filter a list of
BatchPrediction
:-
CreatedAt
- Sets the search criteria to theBatchPrediction
creation date. -
Status
- Sets the search criteria to theBatchPrediction
status. -
Name
- Sets the search criteria to the contents of theBatchPrediction
Name
. -
IAMUser
- Sets the search criteria to the user account that invoked theBatchPrediction
creation. -
MLModelId
- Sets the search criteria to theMLModel
used in theBatchPrediction
. -
DataSourceId
- Sets the search criteria to theDataSource
used in theBatchPrediction
. -
DataURI
- Sets the search criteria to the data file(s) used in theBatchPrediction
. 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 ofBatchPrediction
:-
CreatedAt
- Sets the search criteria to theBatchPrediction
creation date. -
Status
- Sets the search criteria to theBatchPrediction
status. -
Name
- Sets the search criteria to the contents of theBatchPrediction
Name
. -
IAMUser
- Sets the search criteria to the user account that invoked theBatchPrediction
creation. -
MLModelId
- Sets the search criteria to theMLModel
used in theBatchPrediction
. -
DataSourceId
- Sets the search criteria to theDataSource
used in theBatchPrediction
. -
DataURI
- Sets the search criteria to the data file(s) used in theBatchPrediction
. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.
-
- See Also:
-
-
getFilterVariable
Use one of the following variables to filter a list of
BatchPrediction
:-
CreatedAt
- Sets the search criteria to theBatchPrediction
creation date. -
Status
- Sets the search criteria to theBatchPrediction
status. -
Name
- Sets the search criteria to the contents of theBatchPrediction
Name
. -
IAMUser
- Sets the search criteria to the user account that invoked theBatchPrediction
creation. -
MLModelId
- Sets the search criteria to theMLModel
used in theBatchPrediction
. -
DataSourceId
- Sets the search criteria to theDataSource
used in theBatchPrediction
. -
DataURI
- Sets the search criteria to the data file(s) used in theBatchPrediction
. 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 theBatchPrediction
creation date. -
Status
- Sets the search criteria to theBatchPrediction
status. -
Name
- Sets the search criteria to the contents of theBatchPrediction
Name
. -
IAMUser
- Sets the search criteria to the user account that invoked theBatchPrediction
creation. -
MLModelId
- Sets the search criteria to theMLModel
used in theBatchPrediction
. -
DataSourceId
- Sets the search criteria to theDataSource
used in theBatchPrediction
. -
DataURI
- Sets the search criteria to the data file(s) used in theBatchPrediction
. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.
-
- See Also:
-
-
withFilterVariable
Use one of the following variables to filter a list of
BatchPrediction
:-
CreatedAt
- Sets the search criteria to theBatchPrediction
creation date. -
Status
- Sets the search criteria to theBatchPrediction
status. -
Name
- Sets the search criteria to the contents of theBatchPrediction
Name
. -
IAMUser
- Sets the search criteria to the user account that invoked theBatchPrediction
creation. -
MLModelId
- Sets the search criteria to theMLModel
used in theBatchPrediction
. -
DataSourceId
- Sets the search criteria to theDataSource
used in theBatchPrediction
. -
DataURI
- Sets the search criteria to the data file(s) used in theBatchPrediction
. 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 ofBatchPrediction
:-
CreatedAt
- Sets the search criteria to theBatchPrediction
creation date. -
Status
- Sets the search criteria to theBatchPrediction
status. -
Name
- Sets the search criteria to the contents of theBatchPrediction
Name
. -
IAMUser
- Sets the search criteria to the user account that invoked theBatchPrediction
creation. -
MLModelId
- Sets the search criteria to theMLModel
used in theBatchPrediction
. -
DataSourceId
- Sets the search criteria to theDataSource
used in theBatchPrediction
. -
DataURI
- Sets the search criteria to the data file(s) used in theBatchPrediction
. 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
Use one of the following variables to filter a list of
BatchPrediction
:-
CreatedAt
- Sets the search criteria to theBatchPrediction
creation date. -
Status
- Sets the search criteria to theBatchPrediction
status. -
Name
- Sets the search criteria to the contents of theBatchPrediction
Name
. -
IAMUser
- Sets the search criteria to the user account that invoked theBatchPrediction
creation. -
MLModelId
- Sets the search criteria to theMLModel
used in theBatchPrediction
. -
DataSourceId
- Sets the search criteria to theDataSource
used in theBatchPrediction
. -
DataURI
- Sets the search criteria to the data file(s) used in theBatchPrediction
. 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 ofBatchPrediction
:-
CreatedAt
- Sets the search criteria to theBatchPrediction
creation date. -
Status
- Sets the search criteria to theBatchPrediction
status. -
Name
- Sets the search criteria to the contents of theBatchPrediction
Name
. -
IAMUser
- Sets the search criteria to the user account that invoked theBatchPrediction
creation. -
MLModelId
- Sets the search criteria to theMLModel
used in theBatchPrediction
. -
DataSourceId
- Sets the search criteria to theDataSource
used in theBatchPrediction
. -
DataURI
- Sets the search criteria to the data file(s) used in theBatchPrediction
. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.
-
- See Also:
-
-
withFilterVariable
public DescribeBatchPredictionsRequest withFilterVariable(BatchPredictionFilterVariable filterVariable) Use one of the following variables to filter a list of
BatchPrediction
:-
CreatedAt
- Sets the search criteria to theBatchPrediction
creation date. -
Status
- Sets the search criteria to theBatchPrediction
status. -
Name
- Sets the search criteria to the contents of theBatchPrediction
Name
. -
IAMUser
- Sets the search criteria to the user account that invoked theBatchPrediction
creation. -
MLModelId
- Sets the search criteria to theMLModel
used in theBatchPrediction
. -
DataSourceId
- Sets the search criteria to theDataSource
used in theBatchPrediction
. -
DataURI
- Sets the search criteria to the data file(s) used in theBatchPrediction
. 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 ofBatchPrediction
:-
CreatedAt
- Sets the search criteria to theBatchPrediction
creation date. -
Status
- Sets the search criteria to theBatchPrediction
status. -
Name
- Sets the search criteria to the contents of theBatchPrediction
Name
. -
IAMUser
- Sets the search criteria to the user account that invoked theBatchPrediction
creation. -
MLModelId
- Sets the search criteria to theMLModel
used in theBatchPrediction
. -
DataSourceId
- Sets the search criteria to theDataSource
used in theBatchPrediction
. -
DataURI
- Sets the search criteria to the data file(s) used in theBatchPrediction
. 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
The equal to operator. The
BatchPrediction
results will haveFilterVariable
values that exactly match the value specified withEQ
.- Parameters:
eQ
- The equal to operator. TheBatchPrediction
results will haveFilterVariable
values that exactly match the value specified withEQ
.
-
getEQ
The equal to operator. The
BatchPrediction
results will haveFilterVariable
values that exactly match the value specified withEQ
.- Returns:
- The equal to operator. The
BatchPrediction
results will haveFilterVariable
values that exactly match the value specified withEQ
.
-
withEQ
The equal to operator. The
BatchPrediction
results will haveFilterVariable
values that exactly match the value specified withEQ
.- Parameters:
eQ
- The equal to operator. TheBatchPrediction
results will haveFilterVariable
values that exactly match the value specified withEQ
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setGT
The greater than operator. The
BatchPrediction
results will haveFilterVariable
values that are greater than the value specified withGT
.- Parameters:
gT
- The greater than operator. TheBatchPrediction
results will haveFilterVariable
values that are greater than the value specified withGT
.
-
getGT
The greater than operator. The
BatchPrediction
results will haveFilterVariable
values that are greater than the value specified withGT
.- Returns:
- The greater than operator. The
BatchPrediction
results will haveFilterVariable
values that are greater than the value specified withGT
.
-
withGT
The greater than operator. The
BatchPrediction
results will haveFilterVariable
values that are greater than the value specified withGT
.- Parameters:
gT
- The greater than operator. TheBatchPrediction
results will haveFilterVariable
values that are greater than the value specified withGT
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setLT
The less than operator. The
BatchPrediction
results will haveFilterVariable
values that are less than the value specified withLT
.- Parameters:
lT
- The less than operator. TheBatchPrediction
results will haveFilterVariable
values that are less than the value specified withLT
.
-
getLT
The less than operator. The
BatchPrediction
results will haveFilterVariable
values that are less than the value specified withLT
.- Returns:
- The less than operator. The
BatchPrediction
results will haveFilterVariable
values that are less than the value specified withLT
.
-
withLT
The less than operator. The
BatchPrediction
results will haveFilterVariable
values that are less than the value specified withLT
.- Parameters:
lT
- The less than operator. TheBatchPrediction
results will haveFilterVariable
values that are less than the value specified withLT
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setGE
The greater than or equal to operator. The
BatchPrediction
results will haveFilterVariable
values that are greater than or equal to the value specified withGE
.- Parameters:
gE
- The greater than or equal to operator. TheBatchPrediction
results will haveFilterVariable
values that are greater than or equal to the value specified withGE
.
-
getGE
The greater than or equal to operator. The
BatchPrediction
results will haveFilterVariable
values that are greater than or equal to the value specified withGE
.- Returns:
- The greater than or equal to operator. The
BatchPrediction
results will haveFilterVariable
values that are greater than or equal to the value specified withGE
.
-
withGE
The greater than or equal to operator. The
BatchPrediction
results will haveFilterVariable
values that are greater than or equal to the value specified withGE
.- Parameters:
gE
- The greater than or equal to operator. TheBatchPrediction
results will haveFilterVariable
values that are greater than or equal to the value specified withGE
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setLE
The less than or equal to operator. The
BatchPrediction
results will haveFilterVariable
values that are less than or equal to the value specified withLE
.- Parameters:
lE
- The less than or equal to operator. TheBatchPrediction
results will haveFilterVariable
values that are less than or equal to the value specified withLE
.
-
getLE
The less than or equal to operator. The
BatchPrediction
results will haveFilterVariable
values that are less than or equal to the value specified withLE
.- Returns:
- The less than or equal to operator. The
BatchPrediction
results will haveFilterVariable
values that are less than or equal to the value specified withLE
.
-
withLE
The less than or equal to operator. The
BatchPrediction
results will haveFilterVariable
values that are less than or equal to the value specified withLE
.- Parameters:
lE
- The less than or equal to operator. TheBatchPrediction
results will haveFilterVariable
values that are less than or equal to the value specified withLE
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setNE
The not equal to operator. The
BatchPrediction
results will haveFilterVariable
values not equal to the value specified withNE
.- Parameters:
nE
- The not equal to operator. TheBatchPrediction
results will haveFilterVariable
values not equal to the value specified withNE
.
-
getNE
The not equal to operator. The
BatchPrediction
results will haveFilterVariable
values not equal to the value specified withNE
.- Returns:
- The not equal to operator. The
BatchPrediction
results will haveFilterVariable
values not equal to the value specified withNE
.
-
withNE
The not equal to operator. The
BatchPrediction
results will haveFilterVariable
values not equal to the value specified withNE
.- Parameters:
nE
- The not equal to operator. TheBatchPrediction
results will haveFilterVariable
values not equal to the value specified withNE
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setPrefix
A string that is found at the beginning of a variable, such as
Name
orId
.For example, a
Batch Prediction
operation could have theName
2014-09-09-HolidayGiftMailer
. To search for thisBatchPrediction
, selectName
for theFilterVariable
and any of the following strings for thePrefix
:-
2014-09
-
2014-09-09
-
2014-09-09-Holiday
- Parameters:
prefix
- A string that is found at the beginning of a variable, such asName
orId
.For example, a
Batch Prediction
operation could have theName
2014-09-09-HolidayGiftMailer
. To search for thisBatchPrediction
, selectName
for theFilterVariable
and any of the following strings for thePrefix
:-
2014-09
-
2014-09-09
-
2014-09-09-Holiday
-
-
-
getPrefix
A string that is found at the beginning of a variable, such as
Name
orId
.For example, a
Batch Prediction
operation could have theName
2014-09-09-HolidayGiftMailer
. To search for thisBatchPrediction
, selectName
for theFilterVariable
and any of the following strings for thePrefix
:-
2014-09
-
2014-09-09
-
2014-09-09-Holiday
- Returns:
- A string that is found at the beginning of a variable, such as
Name
orId
.For example, a
Batch Prediction
operation could have theName
2014-09-09-HolidayGiftMailer
. To search for thisBatchPrediction
, selectName
for theFilterVariable
and any of the following strings for thePrefix
:-
2014-09
-
2014-09-09
-
2014-09-09-Holiday
-
-
-
withPrefix
A string that is found at the beginning of a variable, such as
Name
orId
.For example, a
Batch Prediction
operation could have theName
2014-09-09-HolidayGiftMailer
. To search for thisBatchPrediction
, selectName
for theFilterVariable
and any of the following strings for thePrefix
:-
2014-09
-
2014-09-09
-
2014-09-09-Holiday
- Parameters:
prefix
- A string that is found at the beginning of a variable, such asName
orId
.For example, a
Batch Prediction
operation could have theName
2014-09-09-HolidayGiftMailer
. To search for thisBatchPrediction
, selectName
for theFilterVariable
and any of the following strings for thePrefix
:-
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
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
.- Parameters:
sortOrder
- A two-value parameter that determines the sequence of the resulting list ofMLModel
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
.-
- See Also:
-
-
getSortOrder
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
.- Returns:
- 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
. -
- See Also:
-
-
withSortOrder
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
.- Parameters:
sortOrder
- A two-value parameter that determines the sequence of the resulting list ofMLModel
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
.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
setSortOrder
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
.- Parameters:
sortOrder
- A two-value parameter that determines the sequence of the resulting list ofMLModel
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
.-
- See Also:
-
-
withSortOrder
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
.- Parameters:
sortOrder
- A two-value parameter that determines the sequence of the resulting list ofMLModel
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
.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
setNextToken
An ID of the page in the paginated results.
- Parameters:
nextToken
- An ID of the page in the paginated results.
-
getNextToken
An ID of the page in the paginated results.
- Returns:
- An ID of the page in the paginated results.
-
withNextToken
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
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
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
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
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
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 classAmazonWebServiceRequest
- See Also:
-