software.amazon.awssdk.services.transcribe.model

Class ListTranscriptionJobsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.transcribe.model.TranscribeRequest

software.amazon.awssdk.services.transcribe.model.ListTranscriptionJobsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListTranscriptionJobsRequest.Builder,ListTranscriptionJobsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListTranscriptionJobsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ListTranscriptionJobsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	jobNameContains() When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.
Integer	maxResults() The maximum number of jobs to return in the response.
String	nextToken() If the result of the previous request to ListTranscriptionJobs was truncated, include the NextToken to fetch the next set of jobs.
List<SdkField<?>>	sdkFields()
static Class<? extends ListTranscriptionJobsRequest.Builder>	serializableBuilderClass()
TranscriptionJobStatus	status() When specified, returns only transcription jobs with the specified status.
String	statusAsString() When specified, returns only transcription jobs with the specified status.
ListTranscriptionJobsRequest.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

status

public TranscriptionJobStatus status()

When specified, returns only transcription jobs with the specified status. Jobs are ordered by creation date, with the newest jobs returned first. If you don’t specify a status, Amazon Transcribe returns all transcription jobs ordered by creation date.

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

Returns:

When specified, returns only transcription jobs with the specified status. Jobs are ordered by creation date, with the newest jobs returned first. If you don’t specify a status, Amazon Transcribe returns all transcription jobs ordered by creation date.

See Also:

TranscriptionJobStatus

statusAsString

public String statusAsString()

When specified, returns only transcription jobs with the specified status. Jobs are ordered by creation date, with the newest jobs returned first. If you don’t specify a status, Amazon Transcribe returns all transcription jobs ordered by creation date.

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

Returns:

When specified, returns only transcription jobs with the specified status. Jobs are ordered by creation date, with the newest jobs returned first. If you don’t specify a status, Amazon Transcribe returns all transcription jobs ordered by creation date.

See Also:

TranscriptionJobStatus

jobNameContains

public String jobNameContains()

When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.

Returns:

When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.

nextToken

public String nextToken()

If the result of the previous request to ListTranscriptionJobs was truncated, include the NextToken to fetch the next set of jobs.

Returns:

If the result of the previous request to ListTranscriptionJobs was truncated, include the NextToken to fetch the next set of jobs.

maxResults

public Integer maxResults()

The maximum number of jobs to return in the response. If there are fewer results in the list, this response contains only the actual results.

Returns:

The maximum number of jobs to return in the response. If there are fewer results in the list, this response contains only the actual results.

toBuilder

public ListTranscriptionJobsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListTranscriptionJobsRequest.Builder,ListTranscriptionJobsRequest>

Specified by:

toBuilder in class TranscribeRequest

builder

public static ListTranscriptionJobsRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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