software.amazon.awssdk.services.transcribe.model

Class ListTranscriptionJobsResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.transcribe.model.TranscribeResponse

software.amazon.awssdk.services.transcribe.model.ListTranscriptionJobsResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListTranscriptionJobsResponse.Builder,ListTranscriptionJobsResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListTranscriptionJobsResponse.Builder

Method Summary

Modifier and Type	Method and Description
static ListTranscriptionJobsResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTranscriptionJobSummaries() For responses, this returns true if the service returned a value for the TranscriptionJobSummaries property.
String	nextToken() The ListTranscriptionJobs operation returns a page of jobs at a time.
List<SdkField<?>>	sdkFields()
static Class<? extends ListTranscriptionJobsResponse.Builder>	serializableBuilderClass()
TranscriptionJobStatus	status() The requested status of the jobs returned.
String	statusAsString() The requested status of the jobs returned.
ListTranscriptionJobsResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<TranscriptionJobSummary>	transcriptionJobSummaries() A list of objects containing summary information for a transcription job.

Methods inherited from class software.amazon.awssdk.services.transcribe.model.TranscribeResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

The requested status of the jobs 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:

The requested status of the jobs returned.

See Also:

TranscriptionJobStatus

statusAsString

public final String statusAsString()

The requested status of the jobs 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:

The requested status of the jobs returned.

See Also:

TranscriptionJobStatus

nextToken

public final String nextToken()

The ListTranscriptionJobs operation returns a page of jobs at a time. The maximum size of the page is set by the MaxResults parameter. If there are more jobs in the list than the page size, Amazon Transcribe returns the NextPage token. Include the token in the next request to the ListTranscriptionJobs operation to return in the next page of jobs.

Returns:

The ListTranscriptionJobs operation returns a page of jobs at a time. The maximum size of the page is set by the MaxResults parameter. If there are more jobs in the list than the page size, Amazon Transcribe returns the NextPage token. Include the token in the next request to the ListTranscriptionJobs operation to return in the next page of jobs.

hasTranscriptionJobSummaries

public final boolean hasTranscriptionJobSummaries()

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

transcriptionJobSummaries

public final List<TranscriptionJobSummary> transcriptionJobSummaries()

A list of objects containing summary information for a transcription job.

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

Returns:

A list of objects containing summary information for a transcription job.

toBuilder

public ListTranscriptionJobsResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListTranscriptionJobsResponse.Builder,ListTranscriptionJobsResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static ListTranscriptionJobsResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo