Package software.amazon.awssdk.services.m2.model

Class ListBatchJobExecutionsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.m2.model.M2Request

software.amazon.awssdk.services.m2.model.ListBatchJobExecutionsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListBatchJobExecutionsRequest.Builder,ListBatchJobExecutionsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListBatchJobExecutionsRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	applicationId()	The unique identifier of the application.
static ListBatchJobExecutionsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<String>	executionIds()	The unique identifier of each batch job execution.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasExecutionIds()	For responses, this returns true if the service returned a value for the ExecutionIds property.
int	hashCode()
String	jobName()	The name of each batch job execution.
Integer	maxResults()	The maximum number of batch job executions to return.
String	nextToken()	A pagination token to control the number of batch job executions displayed in the list.
List<SdkField<?>>	sdkFields()
static Class<? extends ListBatchJobExecutionsRequest.Builder>	serializableBuilderClass()
Instant	startedAfter()	The time after which the batch job executions started.
Instant	startedBefore()	The time before the batch job executions started.
BatchJobExecutionStatus	status()	The status of the batch job executions.
String	statusAsString()	The status of the batch job executions.
ListBatchJobExecutionsRequest.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

applicationId

public final String applicationId()

The unique identifier of the application.

Returns:

The unique identifier of the application.

hasExecutionIds

public final boolean hasExecutionIds()

For responses, this returns true if the service returned a value for the ExecutionIds 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.

executionIds

public final List<String> executionIds()

The unique identifier of each batch job execution.

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 hasExecutionIds() method.

Returns:

The unique identifier of each batch job execution.

jobName

public final String jobName()

The name of each batch job execution.

Returns:

The name of each batch job execution.

maxResults

public final Integer maxResults()

The maximum number of batch job executions to return.

Returns:

The maximum number of batch job executions to return.

nextToken

public final String nextToken()

A pagination token to control the number of batch job executions displayed in the list.

Returns:

A pagination token to control the number of batch job executions displayed in the list.

startedAfter

public final Instant startedAfter()

The time after which the batch job executions started.

Returns:

The time after which the batch job executions started.

startedBefore

public final Instant startedBefore()

The time before the batch job executions started.

Returns:

The time before the batch job executions started.

status

public final BatchJobExecutionStatus status()

The status of the batch job executions.

If the service returns an enum value that is not available in the current SDK version, status will return BatchJobExecutionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The status of the batch job executions.

See Also:

BatchJobExecutionStatus

statusAsString

public final String statusAsString()

The status of the batch job executions.

If the service returns an enum value that is not available in the current SDK version, status will return BatchJobExecutionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The status of the batch job executions.

See Also:

BatchJobExecutionStatus

toBuilder

public ListBatchJobExecutionsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListBatchJobExecutionsRequest.Builder,ListBatchJobExecutionsRequest>

Specified by:

toBuilder in class M2Request

builder

public static ListBatchJobExecutionsRequest.Builder builder()

serializableBuilderClass

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