Class PollForJobsRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
Represents the input of a poll for jobs action.
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddQueryParamEntry
(String key, String value) Removes all the entries added into QueryParam.clone()
Creates a shallow clone of this request.boolean
The maximum number of jobs to return in a poll for jobs call.A map of property names and values.int
hashCode()
void
setActionTypeId
(ActionTypeId actionTypeId) void
setMaxBatchSize
(Integer maxBatchSize) The maximum number of jobs to return in a poll for jobs call.void
setQueryParam
(Map<String, String> queryParam) A map of property names and values.toString()
Returns a string representation of this object; useful for testing and debugging.withActionTypeId
(ActionTypeId actionTypeId) withMaxBatchSize
(Integer maxBatchSize) The maximum number of jobs to return in a poll for jobs call.withQueryParam
(Map<String, String> queryParam) A map of property names and values.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
-
PollForJobsRequest
public PollForJobsRequest()
-
-
Method Details
-
setActionTypeId
- Parameters:
actionTypeId
-
-
getActionTypeId
- Returns:
-
withActionTypeId
- Parameters:
actionTypeId
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setMaxBatchSize
The maximum number of jobs to return in a poll for jobs call.
- Parameters:
maxBatchSize
- The maximum number of jobs to return in a poll for jobs call.
-
getMaxBatchSize
The maximum number of jobs to return in a poll for jobs call.
- Returns:
- The maximum number of jobs to return in a poll for jobs call.
-
withMaxBatchSize
The maximum number of jobs to return in a poll for jobs call.
- Parameters:
maxBatchSize
- The maximum number of jobs to return in a poll for jobs call.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getQueryParam
A map of property names and values. For an action type with no queryable properties, this value must be null or an empty map. For an action type with a queryable property, you must supply that property as a key in the map. Only jobs whose action configuration matches the mapped value will be returned.
- Returns:
- A map of property names and values. For an action type with no queryable properties, this value must be null or an empty map. For an action type with a queryable property, you must supply that property as a key in the map. Only jobs whose action configuration matches the mapped value will be returned.
-
setQueryParam
A map of property names and values. For an action type with no queryable properties, this value must be null or an empty map. For an action type with a queryable property, you must supply that property as a key in the map. Only jobs whose action configuration matches the mapped value will be returned.
- Parameters:
queryParam
- A map of property names and values. For an action type with no queryable properties, this value must be null or an empty map. For an action type with a queryable property, you must supply that property as a key in the map. Only jobs whose action configuration matches the mapped value will be returned.
-
withQueryParam
A map of property names and values. For an action type with no queryable properties, this value must be null or an empty map. For an action type with a queryable property, you must supply that property as a key in the map. Only jobs whose action configuration matches the mapped value will be returned.
- Parameters:
queryParam
- A map of property names and values. For an action type with no queryable properties, this value must be null or an empty map. For an action type with a queryable property, you must supply that property as a key in the map. Only jobs whose action configuration matches the mapped value will be returned.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
addQueryParamEntry
-
clearQueryParamEntries
Removes all the entries added into QueryParam. <p> 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:
-