software.amazon.awssdk.services.transcribe.model

Class ListCallAnalyticsJobsResponse

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListCallAnalyticsJobsResponse.Builder,ListCallAnalyticsJobsResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListCallAnalyticsJobsResponse.Builder

Method Summary

Modifier and Type	Method and Description
static ListCallAnalyticsJobsResponse.Builder	builder()
List<CallAnalyticsJobSummary>	callAnalyticsJobSummaries() A list of objects containing summary information for a transcription job.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCallAnalyticsJobSummaries() For responses, this returns true if the service returned a value for the CallAnalyticsJobSummaries property.
int	hashCode()
String	nextToken() The operation returns a page of jobs at a time.
List<SdkField<?>>	sdkFields()
static Class<? extends ListCallAnalyticsJobsResponse.Builder>	serializableBuilderClass()
CallAnalyticsJobStatus	status() When specified, returns only call analytics jobs with that status.
String	statusAsString() When specified, returns only call analytics jobs with that status.
ListCallAnalyticsJobsResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

When specified, returns only call analytics jobs with that status. Jobs are ordered by creation date, with the most recent 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 CallAnalyticsJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

When specified, returns only call analytics jobs with that status. Jobs are ordered by creation date, with the most recent jobs returned first. If you don't specify a status, Amazon Transcribe returns all transcription jobs ordered by creation date.

See Also:

CallAnalyticsJobStatus

statusAsString

public final String statusAsString()

When specified, returns only call analytics jobs with that status. Jobs are ordered by creation date, with the most recent 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 CallAnalyticsJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

When specified, returns only call analytics jobs with that status. Jobs are ordered by creation date, with the most recent jobs returned first. If you don't specify a status, Amazon Transcribe returns all transcription jobs ordered by creation date.

See Also:

CallAnalyticsJobStatus

nextToken

public final String nextToken()

The 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 your next request to the operation to return next page of jobs.

Returns:

The 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 your next request to the operation to return next page of jobs.

hasCallAnalyticsJobSummaries

public final boolean hasCallAnalyticsJobSummaries()

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

callAnalyticsJobSummaries

public final List<CallAnalyticsJobSummary> callAnalyticsJobSummaries()

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

Returns:

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

toBuilder

public ListCallAnalyticsJobsResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListCallAnalyticsJobsResponse.Builder,ListCallAnalyticsJobsResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static ListCallAnalyticsJobsResponse.Builder builder()

serializableBuilderClass

public static Class<? extends ListCallAnalyticsJobsResponse.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