Class ListMedicalScribeJobsRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ListMedicalScribeJobsRequest.Builder,
ListMedicalScribeJobsRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final String
Returns only the Medical Scribe jobs that contain the specified string.final Integer
The maximum number of Medical Scribe jobs to return in each page of results.final String
If yourListMedicalScribeJobs
request returns more results than can be displayed,NextToken
is displayed in the response with an associated string.static Class
<? extends ListMedicalScribeJobsRequest.Builder> final MedicalScribeJobStatus
status()
Returns only Medical Scribe jobs with the specified status.final String
Returns only Medical Scribe jobs with the specified status.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 returnMedicalScribeJobStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- 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
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 returnMedicalScribeJobStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- 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
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
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, includingNextToken
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, includingNextToken
with the value of the copied string. Repeat as needed to view all your results.
-
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ListMedicalScribeJobsRequest.Builder,
ListMedicalScribeJobsRequest> - Specified by:
toBuilder
in classTranscribeRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-