software.amazon.awssdk.services.mediaconvert.model

Class ListJobsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.mediaconvert.model.MediaConvertRequest

software.amazon.awssdk.services.mediaconvert.model.ListJobsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListJobsRequest.Builder,ListJobsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class ListJobsRequest
extends MediaConvertRequest
implements ToCopyableBuilder<ListJobsRequest.Builder,ListJobsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListJobsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ListJobsRequest.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxResults() Optional.
String	nextToken() Use this string, provided with the response to a previous request, to request the next batch of jobs.
Order	order() When you request lists of resources, you can optionally specify whether they are sorted in ASCENDING or DESCENDING order.
String	orderAsString() When you request lists of resources, you can optionally specify whether they are sorted in ASCENDING or DESCENDING order.
String	queue() Provide a queue name to get back only jobs from that queue.
List<SdkField<?>>	sdkFields()
static Class<? extends ListJobsRequest.Builder>	serializableBuilderClass()
JobStatus	status() A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.
String	statusAsString() A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.
ListJobsRequest.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

maxResults

public Integer maxResults()

Optional. Number of jobs, up to twenty, that will be returned at one time.

Returns:

Optional. Number of jobs, up to twenty, that will be returned at one time.

nextToken

public String nextToken()

Use this string, provided with the response to a previous request, to request the next batch of jobs.

Returns:

Use this string, provided with the response to a previous request, to request the next batch of jobs.

order

public Order order()

When you request lists of resources, you can optionally specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.

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

Returns:

When you request lists of resources, you can optionally specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.

See Also:

Order

orderAsString

public String orderAsString()

When you request lists of resources, you can optionally specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.

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

Returns:

When you request lists of resources, you can optionally specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.

See Also:

Order

queue

public String queue()

Provide a queue name to get back only jobs from that queue.

Returns:

Provide a queue name to get back only jobs from that queue.

status

public JobStatus status()

A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.

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

Returns:

A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.

See Also:

JobStatus

statusAsString

public String statusAsString()

A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.

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

Returns:

A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.

See Also:

JobStatus

toBuilder

public ListJobsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListJobsRequest.Builder,ListJobsRequest>

Specified by:

toBuilder in class MediaConvertRequest

builder

public static ListJobsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ListJobsRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo