Package 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("software.amazon.awssdk:codegen")
public final class ListTranscriptionJobsRequest
extends TranscribeRequest
implements ToCopyableBuilder<ListTranscriptionJobsRequest.Builder,ListTranscriptionJobsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListTranscriptionJobsRequest.Builder

Method Summary

Modifier and Type	Method	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()	Returns only the transcription jobs that contain the specified string.
Integer	maxResults()	The maximum number of transcription jobs to return in each page of results.
String	nextToken()	If your ListTranscriptionJobs request returns more results than can be displayed, NextToken is displayed in the response with an associated string.
List<SdkField<?>>	sdkFields()
static Class<? extends ListTranscriptionJobsRequest.Builder>	serializableBuilderClass()
TranscriptionJobStatus	status()	Returns only transcription jobs with the specified status.
String	statusAsString()	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 final TranscriptionJobStatus status()

Returns only transcription jobs with the specified status. Jobs are ordered by creation date, with the newest job first. If you do not include Status, all transcription jobs are returned.

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:

Returns only transcription jobs with the specified status. Jobs are ordered by creation date, with the newest job first. If you do not include Status, all transcription jobs are returned.

See Also:

TranscriptionJobStatus

statusAsString

public final String statusAsString()

Returns only transcription jobs with the specified status. Jobs are ordered by creation date, with the newest job first. If you do not include Status, all transcription jobs are returned.

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:

Returns only transcription jobs with the specified status. Jobs are ordered by creation date, with the newest job first. If you do not include Status, all transcription jobs are returned.

See Also:

TranscriptionJobStatus

jobNameContains

public final String jobNameContains()

Returns only the transcription jobs that contain the specified string. The search is not case sensitive.

Returns:

Returns only the transcription jobs that contain the specified string. The search is not case sensitive.

nextToken

public final String nextToken()

If your ListTranscriptionJobs request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to view all your results.

Returns:

If your ListTranscriptionJobs request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to view all your results.

maxResults

public final Integer maxResults()

The maximum number of transcription jobs to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you do not specify a value, a default of 5 is used.

Returns:

The maximum number of transcription jobs to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you do not specify a value, a default of 5 is used.

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