PollForJobsRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.codepipeline.model.PollForJobsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PollForJobsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable
```
Represents the input of a PollForJobs action.

See Also:

AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

PollForJobsRequest()

Constructors
Constructor and Description
`PollForJobsRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PollForJobsRequest`	`addQueryParamEntry(String key, String value)`
`PollForJobsRequest`	`clearQueryParamEntries()` Removes all the entries added into QueryParam.
`PollForJobsRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals(Object obj)`
`ActionTypeId`	`getActionTypeId()` Represents information about an action type.
`Integer`	`getMaxBatchSize()` The maximum number of jobs to return in a poll for jobs call.
`Map<String,String>`	`getQueryParam()` A map of property names and values.
`int`	`hashCode()`
`void`	`setActionTypeId(ActionTypeId actionTypeId)` Represents information about an action type.
`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.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`PollForJobsRequest`	`withActionTypeId(ActionTypeId actionTypeId)` Represents information about an action type.
`PollForJobsRequest`	`withMaxBatchSize(Integer maxBatchSize)` The maximum number of jobs to return in a poll for jobs call.
`PollForJobsRequest`	`withQueryParam(Map<String,String> queryParam)` A map of property names and values.

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

- Constructor Detail
  - PollForJobsRequest
```
public PollForJobsRequest()
```
- Method Detail
  - setActionTypeId
```
public void setActionTypeId(ActionTypeId actionTypeId)
```
    Represents information about an action type.
    
    Parameters:
    
    actionTypeId - Represents information about an action type.
  - getActionTypeId
```
public ActionTypeId getActionTypeId()
```
    Represents information about an action type.
    
    Returns:
    
    Represents information about an action type.
  - withActionTypeId
```
public PollForJobsRequest withActionTypeId(ActionTypeId actionTypeId)
```
    Represents information about an action type.
    
    Parameters:
    
    actionTypeId - Represents information about an action type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaxBatchSize
```
public void setMaxBatchSize(Integer maxBatchSize)
```
    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
```
public Integer 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
```
public PollForJobsRequest withMaxBatchSize(Integer maxBatchSize)
```
    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
```
public Map<String,String> 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
```
public void setQueryParam(Map<String,String> 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.
    
    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
```
public PollForJobsRequest withQueryParam(Map<String,String> 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.
    
    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
```
public PollForJobsRequest addQueryParamEntry(String key,
                                             String value)
```
  - clearQueryParamEntries
```
public PollForJobsRequest clearQueryParamEntries()
```
    Removes all the entries added into QueryParam.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public PollForJobsRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

Did this page help you?

Class PollForJobsRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

PollForJobsRequest

Method Detail

setActionTypeId

getActionTypeId

withActionTypeId

setMaxBatchSize

getMaxBatchSize

withMaxBatchSize

getQueryParam

setQueryParam

withQueryParam

addQueryParamEntry

clearQueryParamEntries

toString

equals

hashCode

clone