Package software.amazon.awssdk.services.transcribe.model

Class ListMedicalScribeJobsRequest

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.ListMedicalScribeJobsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListMedicalScribeJobsRequest.Builder,ListMedicalScribeJobsRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListMedicalScribeJobsRequest extends TranscribeRequest implements ToCopyableBuilder<ListMedicalScribeJobsRequest.Builder,ListMedicalScribeJobsRequest>

  • Method Details

    • status

      public final MedicalScribeJobStatus status()

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

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

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

    • statusAsString

      public final String statusAsString()

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

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

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

    • jobNameContains

      public final String jobNameContains()

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

      Returns:
      Returns only the Medical Scribe jobs that contain the specified string. The search is not case sensitive.

    • nextToken

      public final String nextToken()

      If your ListMedicalScribeJobs 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 ListMedicalScribeJobs 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 Medical Scribe 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 Medical Scribe 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 ListMedicalScribeJobsRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<ListMedicalScribeJobsRequest.Builder,ListMedicalScribeJobsRequest>
      Specified by:
      toBuilder in class TranscribeRequest

    • builder

      public static ListMedicalScribeJobsRequest.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo