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:

ToCopyableBuilder<ListJobsRequest.Builder,ListJobsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public 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) Used to retrieve the value of a field from any class that extends SdkRequest.
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() Returns the value of the Order property for this object.
String	orderAsString() Returns the value of the Order property for this object.
String	queue() Provide a queue name to get back only jobs from that queue.
static Class<? extends ListJobsRequest.Builder>	serializableBuilderClass()
JobStatus	status() Returns the value of the Status property for this object.
String	statusAsString() Returns the value of the Status property for this object.
ListJobsRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

requestOverrideConfig

Methods inherited from class java.lang.Object

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()

Returns the value of the Order property for this object.

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:

The value of the Order property for this object.

See Also:

Order

orderAsString

public String orderAsString()

Returns the value of the Order property for this object.

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:

The value of the Order property for this object.

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()

Returns the value of the Status property for this object.

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:

The value of the Status property for this object.

See Also:

JobStatus

statusAsString

public String statusAsString()

Returns the value of the Status property for this object.

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:

The value of the Status property for this object.

See Also:

JobStatus

toBuilder

public ListJobsRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ListJobsRequest.Builder,ListJobsRequest>

Specified by:

toBuilder in class MediaConvertRequest

Returns:

a builder for type T

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()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value