Package software.amazon.awssdk.services.codepipeline.model

Class PollForJobsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.codepipeline.model.CodePipelineRequest

software.amazon.awssdk.services.codepipeline.model.PollForJobsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PollForJobsRequest.Builder,PollForJobsRequest>

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

Represents the input of a PollForJobs action.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PollForJobsRequest.Builder

Method Summary

Modifier and Type	Method	Description
ActionTypeId	actionTypeId()	Represents information about an action type.
static PollForJobsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasQueryParam()	For responses, this returns true if the service returned a value for the QueryParam property.
Integer	maxBatchSize()	The maximum number of jobs to return in a poll for jobs call.
Map<String,String>	queryParam()	A map of property names and values.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends PollForJobsRequest.Builder>	serializableBuilderClass()
PollForJobsRequest.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

actionTypeId

public final ActionTypeId actionTypeId()

Represents information about an action type.

Returns:

Represents information about an action type.

maxBatchSize

public final Integer maxBatchSize()

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.

hasQueryParam

public final boolean hasQueryParam()

For responses, this returns true if the service returned a value for the QueryParam property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

queryParam

public final 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 are returned.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasQueryParam() method.

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 are returned.

toBuilder

public PollForJobsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PollForJobsRequest.Builder,PollForJobsRequest>

Specified by:

toBuilder in class CodePipelineRequest

builder

public static PollForJobsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends PollForJobsRequest.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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo