MedicalScribeJobSummary (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.transcribe.model

Class MedicalScribeJobSummary

java.lang.Object
- com.amazonaws.services.transcribe.model.MedicalScribeJobSummary

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class MedicalScribeJobSummary
extends Object
implements Serializable, Cloneable, StructuredPojo 
```
Provides detailed information about a specific Medical Scribe job.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

MedicalScribeJobSummary ()

Constructors
Constructor and Description
`MedicalScribeJobSummary ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`MedicalScribeJobSummary`	`clone ()`
`boolean`	`equals (Object obj)`
`Date`	`getCompletionTime ()` The date and time the specified Medical Scribe job finished processing.
`Date`	`getCreationTime ()` The date and time the specified Medical Scribe job request was made.
`String`	`getFailureReason ()` If `MedicalScribeJobStatus` is `FAILED`, `FailureReason` contains information about why the transcription job failed.
`String`	`getLanguageCode ()` The language code used to create your Medical Scribe job.
`String`	`getMedicalScribeJobName ()` The name of the Medical Scribe job.
`String`	`getMedicalScribeJobStatus ()` Provides the status of the specified Medical Scribe job.
`Date`	`getStartTime ()` The date and time your Medical Scribe job began processing.
`int`	`hashCode ()`
`void`	`marshall (ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCompletionTime (Date completionTime)` The date and time the specified Medical Scribe job finished processing.
`void`	`setCreationTime (Date creationTime)` The date and time the specified Medical Scribe job request was made.
`void`	`setFailureReason (String failureReason)` If `MedicalScribeJobStatus` is `FAILED`, `FailureReason` contains information about why the transcription job failed.
`void`	`setLanguageCode (String languageCode)` The language code used to create your Medical Scribe job.
`void`	`setMedicalScribeJobName (String medicalScribeJobName)` The name of the Medical Scribe job.
`void`	`setMedicalScribeJobStatus (String medicalScribeJobStatus)` Provides the status of the specified Medical Scribe job.
`void`	`setStartTime (Date startTime)` The date and time your Medical Scribe job began processing.
`String`	`toString ()` Returns a string representation of this object.
`MedicalScribeJobSummary`	`withCompletionTime (Date completionTime)` The date and time the specified Medical Scribe job finished processing.
`MedicalScribeJobSummary`	`withCreationTime (Date creationTime)` The date and time the specified Medical Scribe job request was made.
`MedicalScribeJobSummary`	`withFailureReason (String failureReason)` If `MedicalScribeJobStatus` is `FAILED`, `FailureReason` contains information about why the transcription job failed.
`MedicalScribeJobSummary`	`withLanguageCode (MedicalScribeLanguageCode languageCode)` The language code used to create your Medical Scribe job.
`MedicalScribeJobSummary`	`withLanguageCode (String languageCode)` The language code used to create your Medical Scribe job.
`MedicalScribeJobSummary`	`withMedicalScribeJobName (String medicalScribeJobName)` The name of the Medical Scribe job.
`MedicalScribeJobSummary`	`withMedicalScribeJobStatus (MedicalScribeJobStatus medicalScribeJobStatus)` Provides the status of the specified Medical Scribe job.
`MedicalScribeJobSummary`	`withMedicalScribeJobStatus (String medicalScribeJobStatus)` Provides the status of the specified Medical Scribe job.
`MedicalScribeJobSummary`	`withStartTime (Date startTime)` The date and time your Medical Scribe job began processing.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - MedicalScribeJobSummary
```
public MedicalScribeJobSummary()
```
- Method Detail
  - setMedicalScribeJobName
```
public void setMedicalScribeJobName(String medicalScribeJobName)
```
    The name of the Medical Scribe job. Job names are case sensitive and must be unique within an Amazon Web Services account.
    
    Parameters:
    
    medicalScribeJobName - The name of the Medical Scribe job. Job names are case sensitive and must be unique within an Amazon Web Services account.
  - getMedicalScribeJobName
```
public String getMedicalScribeJobName()
```
    The name of the Medical Scribe job. Job names are case sensitive and must be unique within an Amazon Web Services account.
    
    Returns:
    
    The name of the Medical Scribe job. Job names are case sensitive and must be unique within an Amazon Web Services account.
  - withMedicalScribeJobName
```
public MedicalScribeJobSummary withMedicalScribeJobName(String medicalScribeJobName)
```
    The name of the Medical Scribe job. Job names are case sensitive and must be unique within an Amazon Web Services account.
    
    Parameters:
    
    medicalScribeJobName - The name of the Medical Scribe job. Job names are case sensitive and must be unique within an Amazon Web Services account.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationTime
```
public void setCreationTime(Date creationTime)
```
    The date and time the specified Medical Scribe job request was made.
    
    Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022年05月04日T12:32:58.761000-07:00 represents a Medical Scribe job that started processing at 12:32 PM UTC-7 on May 4, 2022.
    
    Parameters:
    
    creationTime - The date and time the specified Medical Scribe job request was made.
    
    Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022年05月04日T12:32:58.761000-07:00 represents a Medical Scribe job that started processing at 12:32 PM UTC-7 on May 4, 2022.
  - getCreationTime
```
public Date getCreationTime()
```
    The date and time the specified Medical Scribe job request was made.
    
    Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022年05月04日T12:32:58.761000-07:00 represents a Medical Scribe job that started processing at 12:32 PM UTC-7 on May 4, 2022.
    
    Returns:
    
    The date and time the specified Medical Scribe job request was made.
    
    Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022年05月04日T12:32:58.761000-07:00 represents a Medical Scribe job that started processing at 12:32 PM UTC-7 on May 4, 2022.
  - withCreationTime
```
public MedicalScribeJobSummary withCreationTime(Date creationTime)
```
    The date and time the specified Medical Scribe job request was made.
    
    Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022年05月04日T12:32:58.761000-07:00 represents a Medical Scribe job that started processing at 12:32 PM UTC-7 on May 4, 2022.
    
    Parameters:
    
    creationTime - The date and time the specified Medical Scribe job request was made.
    
    Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022年05月04日T12:32:58.761000-07:00 represents a Medical Scribe job that started processing at 12:32 PM UTC-7 on May 4, 2022.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStartTime
```
public void setStartTime(Date startTime)
```
    The date and time your Medical Scribe job began processing.
    
    Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022年05月04日T12:32:58.789000-07:00 represents a Medical Scribe job that started processing at 12:32 PM UTC-7 on May 4, 2022.
    
    Parameters:
    
    startTime - The date and time your Medical Scribe job began processing.
    
    Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022年05月04日T12:32:58.789000-07:00 represents a Medical Scribe job that started processing at 12:32 PM UTC-7 on May 4, 2022.
  - getStartTime
```
public Date getStartTime()
```
    The date and time your Medical Scribe job began processing.
    
    Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022年05月04日T12:32:58.789000-07:00 represents a Medical Scribe job that started processing at 12:32 PM UTC-7 on May 4, 2022.
    
    Returns:
    
    The date and time your Medical Scribe job began processing.
    
    Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022年05月04日T12:32:58.789000-07:00 represents a Medical Scribe job that started processing at 12:32 PM UTC-7 on May 4, 2022.
  - withStartTime
```
public MedicalScribeJobSummary withStartTime(Date startTime)
```
    The date and time your Medical Scribe job began processing.
    
    Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022年05月04日T12:32:58.789000-07:00 represents a Medical Scribe job that started processing at 12:32 PM UTC-7 on May 4, 2022.
    
    Parameters:
    
    startTime - The date and time your Medical Scribe job began processing.
    
    Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022年05月04日T12:32:58.789000-07:00 represents a Medical Scribe job that started processing at 12:32 PM UTC-7 on May 4, 2022.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCompletionTime
```
public void setCompletionTime(Date completionTime)
```
    The date and time the specified Medical Scribe job finished processing.
    
    Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022年05月04日T12:32:58.761000-07:00 represents a Medical Scribe job that finished processing at 12:32 PM UTC-7 on May 4, 2022.
    
    Parameters:
    
    completionTime - The date and time the specified Medical Scribe job finished processing.
    
    Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022年05月04日T12:32:58.761000-07:00 represents a Medical Scribe job that finished processing at 12:32 PM UTC-7 on May 4, 2022.
  - getCompletionTime
```
public Date getCompletionTime()
```
    The date and time the specified Medical Scribe job finished processing.
    
    Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022年05月04日T12:32:58.761000-07:00 represents a Medical Scribe job that finished processing at 12:32 PM UTC-7 on May 4, 2022.
    
    Returns:
    
    The date and time the specified Medical Scribe job finished processing.
    
    Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022年05月04日T12:32:58.761000-07:00 represents a Medical Scribe job that finished processing at 12:32 PM UTC-7 on May 4, 2022.
  - withCompletionTime
```
public MedicalScribeJobSummary withCompletionTime(Date completionTime)
```
    The date and time the specified Medical Scribe job finished processing.
    
    Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022年05月04日T12:32:58.761000-07:00 represents a Medical Scribe job that finished processing at 12:32 PM UTC-7 on May 4, 2022.
    
    Parameters:
    
    completionTime - The date and time the specified Medical Scribe job finished processing.
    
    Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022年05月04日T12:32:58.761000-07:00 represents a Medical Scribe job that finished processing at 12:32 PM UTC-7 on May 4, 2022.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLanguageCode
```
public void setLanguageCode(String languageCode)
```
    The language code used to create your Medical Scribe job. US English (en-US) is the only supported language for Medical Scribe jobs.
    
    Parameters:
    
    languageCode - The language code used to create your Medical Scribe job. US English (en-US) is the only supported language for Medical Scribe jobs.
    
    See Also:
    
    MedicalScribeLanguageCode
  - getLanguageCode
```
public String getLanguageCode()
```
    The language code used to create your Medical Scribe job. US English (en-US) is the only supported language for Medical Scribe jobs.
    
    Returns:
    
    The language code used to create your Medical Scribe job. US English (en-US) is the only supported language for Medical Scribe jobs.
    
    See Also:
    
    MedicalScribeLanguageCode
  - withLanguageCode
```
public MedicalScribeJobSummary withLanguageCode(String languageCode)
```
    The language code used to create your Medical Scribe job. US English (en-US) is the only supported language for Medical Scribe jobs.
    
    Parameters:
    
    languageCode - The language code used to create your Medical Scribe job. US English (en-US) is the only supported language for Medical Scribe jobs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MedicalScribeLanguageCode
  - withLanguageCode
```
public MedicalScribeJobSummary withLanguageCode(MedicalScribeLanguageCode languageCode)
```
    The language code used to create your Medical Scribe job. US English (en-US) is the only supported language for Medical Scribe jobs.
    
    Parameters:
    
    languageCode - The language code used to create your Medical Scribe job. US English (en-US) is the only supported language for Medical Scribe jobs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MedicalScribeLanguageCode
  - setMedicalScribeJobStatus
```
public void setMedicalScribeJobStatus(String medicalScribeJobStatus)
```
    Provides the status of the specified Medical Scribe job.
    
    If the status is COMPLETED, the job is finished and you can find the results at the location specified in MedicalScribeOutput If the status is FAILED, FailureReason provides details on why your Medical Scribe job failed.
    
    Parameters:
    
    medicalScribeJobStatus - Provides the status of the specified Medical Scribe job.
    
    If the status is COMPLETED, the job is finished and you can find the results at the location specified in MedicalScribeOutput If the status is FAILED, FailureReason provides details on why your Medical Scribe job failed.
    
    See Also:
    
    MedicalScribeJobStatus
  - getMedicalScribeJobStatus
```
public String getMedicalScribeJobStatus()
```
    Provides the status of the specified Medical Scribe job.
    
    If the status is COMPLETED, the job is finished and you can find the results at the location specified in MedicalScribeOutput If the status is FAILED, FailureReason provides details on why your Medical Scribe job failed.
    
    Returns:
    
    Provides the status of the specified Medical Scribe job.
    
    If the status is COMPLETED, the job is finished and you can find the results at the location specified in MedicalScribeOutput If the status is FAILED, FailureReason provides details on why your Medical Scribe job failed.
    
    See Also:
    
    MedicalScribeJobStatus
  - withMedicalScribeJobStatus
```
public MedicalScribeJobSummary withMedicalScribeJobStatus(String medicalScribeJobStatus)
```
    Provides the status of the specified Medical Scribe job.
    
    If the status is COMPLETED, the job is finished and you can find the results at the location specified in MedicalScribeOutput If the status is FAILED, FailureReason provides details on why your Medical Scribe job failed.
    
    Parameters:
    
    medicalScribeJobStatus - Provides the status of the specified Medical Scribe job.
    
    If the status is COMPLETED, the job is finished and you can find the results at the location specified in MedicalScribeOutput If the status is FAILED, FailureReason provides details on why your Medical Scribe job failed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MedicalScribeJobStatus
  - withMedicalScribeJobStatus
```
public MedicalScribeJobSummary withMedicalScribeJobStatus(MedicalScribeJobStatus medicalScribeJobStatus)
```
    Provides the status of the specified Medical Scribe job.
    
    If the status is COMPLETED, the job is finished and you can find the results at the location specified in MedicalScribeOutput If the status is FAILED, FailureReason provides details on why your Medical Scribe job failed.
    
    Parameters:
    
    medicalScribeJobStatus - Provides the status of the specified Medical Scribe job.
    
    If the status is COMPLETED, the job is finished and you can find the results at the location specified in MedicalScribeOutput If the status is FAILED, FailureReason provides details on why your Medical Scribe job failed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MedicalScribeJobStatus
  - setFailureReason
```
public void setFailureReason(String failureReason)
```
    If MedicalScribeJobStatus is FAILED, FailureReason contains information about why the transcription job failed. See also: Common Errors.
    
    Parameters:
    
    failureReason - If MedicalScribeJobStatus is FAILED, FailureReason contains information about why the transcription job failed. See also: Common Errors.
  - getFailureReason
```
public String getFailureReason()
```
    If MedicalScribeJobStatus is FAILED, FailureReason contains information about why the transcription job failed. See also: Common Errors.
    
    Returns:
    
    If MedicalScribeJobStatus is FAILED, FailureReason contains information about why the transcription job failed. See also: Common Errors.
  - withFailureReason
```
public MedicalScribeJobSummary withFailureReason(String failureReason)
```
    If MedicalScribeJobStatus is FAILED, FailureReason contains information about why the transcription job failed. See also: Common Errors.
    
    Parameters:
    
    failureReason - If MedicalScribeJobStatus is FAILED, FailureReason contains information about why the transcription job failed. See also: Common Errors.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public MedicalScribeJobSummary clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Class MedicalScribeJobSummary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MedicalScribeJobSummary

Method Detail

setMedicalScribeJobName

getMedicalScribeJobName

withMedicalScribeJobName

setCreationTime

getCreationTime

withCreationTime

setStartTime

getStartTime

withStartTime

setCompletionTime

getCompletionTime

withCompletionTime

setLanguageCode

getLanguageCode

withLanguageCode

withLanguageCode

setMedicalScribeJobStatus

getMedicalScribeJobStatus

withMedicalScribeJobStatus

withMedicalScribeJobStatus

setFailureReason

getFailureReason

withFailureReason

toString

equals

hashCode

clone

marshall