software.amazon.awssdk.services.transcribe.model

Class ListMedicalTranscriptionJobsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListMedicalTranscriptionJobsRequest.Builder,ListMedicalTranscriptionJobsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListMedicalTranscriptionJobsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ListMedicalTranscriptionJobsRequest.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 medical transcription jobs to return in each page of results.
String	nextToken() If you a receive a truncated result in the previous request of ListMedicalTranscriptionJobs, include NextToken to fetch the next set of jobs.
List<SdkField<?>>	sdkFields()
static Class<? extends ListMedicalTranscriptionJobsRequest.Builder>	serializableBuilderClass()
TranscriptionJobStatus	status() When specified, returns only medical transcription jobs with the specified status.
String	statusAsString() When specified, returns only medical transcription jobs with the specified status.
ListMedicalTranscriptionJobsRequest.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()

When specified, returns only medical 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 Medical 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 medical 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 Medical returns all transcription jobs ordered by creation date.

See Also:

TranscriptionJobStatus

statusAsString

public final String statusAsString()

When specified, returns only medical 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 Medical 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 medical 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 Medical returns all transcription jobs ordered by creation date.

See Also:

TranscriptionJobStatus

jobNameContains

public final 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 final String nextToken()

If you a receive a truncated result in the previous request of ListMedicalTranscriptionJobs, include NextToken to fetch the next set of jobs.

Returns:

If you a receive a truncated result in the previous request of ListMedicalTranscriptionJobs, include NextToken to fetch the next set of jobs.

maxResults

public final Integer maxResults()

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

Returns:

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

toBuilder

public ListMedicalTranscriptionJobsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListMedicalTranscriptionJobsRequest.Builder,ListMedicalTranscriptionJobsRequest>

Specified by:

toBuilder in class TranscribeRequest

builder

public static ListMedicalTranscriptionJobsRequest.Builder builder()

serializableBuilderClass

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