MedicalScribeJob (AWS SDK for Java

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

All Implemented Interfaces:

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

To view the status of the specified Medical Scribe job, check the MedicalScribeJobStatus field. If the status is COMPLETED, the job is finished and you can find the results at the locations specified in MedicalScribeOutput. If the status is FAILED, FailureReason provides details on why your Medical Scribe job failed.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

MedicalScribeJob()

Constructors
Constructor and Description
`MedicalScribeJob()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MedicalScribeJob`	`clone()`
`boolean`	`equals(Object obj)`
`List<MedicalScribeChannelDefinition>`	`getChannelDefinitions()` Makes it possible to specify which speaker is on which channel.
`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`	`getDataAccessRoleArn()` The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files, write to the output bucket, and use your KMS key if supplied.
`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.
`Media`	`getMedia()`
`String`	`getMedicalScribeJobName()` The name of the Medical Scribe job.
`String`	`getMedicalScribeJobStatus()` Provides the status of the specified Medical Scribe job.
`MedicalScribeOutput`	`getMedicalScribeOutput()` The location of the output of your Medical Scribe job.
`MedicalScribeSettings`	`getSettings()` Makes it possible to control how your Medical Scribe job is processed using a `MedicalScribeSettings` object.
`Date`	`getStartTime()` The date and time your Medical Scribe job began processing.
`List<Tag>`	`getTags()` Adds one or more custom tags, each in the form of a key:value pair, to the Medica Scribe job.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setChannelDefinitions(Collection<MedicalScribeChannelDefinition> channelDefinitions)` Makes it possible to specify which speaker is on which channel.
`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`	`setDataAccessRoleArn(String dataAccessRoleArn)` The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files, write to the output bucket, and use your KMS key if supplied.
`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`	`setMedia(Media media)`
`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`	`setMedicalScribeOutput(MedicalScribeOutput medicalScribeOutput)` The location of the output of your Medical Scribe job.
`void`	`setSettings(MedicalScribeSettings settings)` Makes it possible to control how your Medical Scribe job is processed using a `MedicalScribeSettings` object.
`void`	`setStartTime(Date startTime)` The date and time your Medical Scribe job began processing.
`void`	`setTags(Collection<Tag> tags)` Adds one or more custom tags, each in the form of a key:value pair, to the Medica Scribe job.
`String`	`toString()` Returns a string representation of this object.
`MedicalScribeJob`	`withChannelDefinitions(Collection<MedicalScribeChannelDefinition> channelDefinitions)` Makes it possible to specify which speaker is on which channel.
`MedicalScribeJob`	`withChannelDefinitions(MedicalScribeChannelDefinition... channelDefinitions)` Makes it possible to specify which speaker is on which channel.
`MedicalScribeJob`	`withCompletionTime(Date completionTime)` The date and time the specified Medical Scribe job finished processing.
`MedicalScribeJob`	`withCreationTime(Date creationTime)` The date and time the specified Medical Scribe job request was made.
`MedicalScribeJob`	`withDataAccessRoleArn(String dataAccessRoleArn)` The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files, write to the output bucket, and use your KMS key if supplied.
`MedicalScribeJob`	`withFailureReason(String failureReason)` If `MedicalScribeJobStatus` is `FAILED`, `FailureReason` contains information about why the transcription job failed.
`MedicalScribeJob`	`withLanguageCode(MedicalScribeLanguageCode languageCode)` The language code used to create your Medical Scribe job.
`MedicalScribeJob`	`withLanguageCode(String languageCode)` The language code used to create your Medical Scribe job.
`MedicalScribeJob`	`withMedia(Media media)`
`MedicalScribeJob`	`withMedicalScribeJobName(String medicalScribeJobName)` The name of the Medical Scribe job.
`MedicalScribeJob`	`withMedicalScribeJobStatus(MedicalScribeJobStatus medicalScribeJobStatus)` Provides the status of the specified Medical Scribe job.
`MedicalScribeJob`	`withMedicalScribeJobStatus(String medicalScribeJobStatus)` Provides the status of the specified Medical Scribe job.
`MedicalScribeJob`	`withMedicalScribeOutput(MedicalScribeOutput medicalScribeOutput)` The location of the output of your Medical Scribe job.
`MedicalScribeJob`	`withSettings(MedicalScribeSettings settings)` Makes it possible to control how your Medical Scribe job is processed using a `MedicalScribeSettings` object.
`MedicalScribeJob`	`withStartTime(Date startTime)` The date and time your Medical Scribe job began processing.
`MedicalScribeJob`	`withTags(Collection<Tag> tags)` Adds one or more custom tags, each in the form of a key:value pair, to the Medica Scribe job.
`MedicalScribeJob`	`withTags(Tag... tags)` Adds one or more custom tags, each in the form of a key:value pair, to the Medica Scribe job.

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

- Constructor Detail
  - MedicalScribeJob
```
public MedicalScribeJob()
```
- 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 MedicalScribeJob 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.
  - 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 MedicalScribeJob 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 MedicalScribeJob 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
  - 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 MedicalScribeJob 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 MedicalScribeJob 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
  - setMedia
```
public void setMedia(Media media)
```
    Parameters:
    
    media -
  - getMedia
```
public Media getMedia()
```
    Returns:
  - withMedia
```
public MedicalScribeJob withMedia(Media media)
```
    Parameters:
    
    media -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMedicalScribeOutput
```
public void setMedicalScribeOutput(MedicalScribeOutput medicalScribeOutput)
```
    The location of the output of your Medical Scribe job. ClinicalDocumentUri holds the Amazon S3 URI for the Clinical Document and TranscriptFileUri holds the Amazon S3 URI for the Transcript.
    
    Parameters:
    
    medicalScribeOutput - The location of the output of your Medical Scribe job. ClinicalDocumentUri holds the Amazon S3 URI for the Clinical Document and TranscriptFileUri holds the Amazon S3 URI for the Transcript.
  - getMedicalScribeOutput
```
public MedicalScribeOutput getMedicalScribeOutput()
```
    The location of the output of your Medical Scribe job. ClinicalDocumentUri holds the Amazon S3 URI for the Clinical Document and TranscriptFileUri holds the Amazon S3 URI for the Transcript.
    
    Returns:
    
    The location of the output of your Medical Scribe job. ClinicalDocumentUri holds the Amazon S3 URI for the Clinical Document and TranscriptFileUri holds the Amazon S3 URI for the Transcript.
  - withMedicalScribeOutput
```
public MedicalScribeJob withMedicalScribeOutput(MedicalScribeOutput medicalScribeOutput)
```
    The location of the output of your Medical Scribe job. ClinicalDocumentUri holds the Amazon S3 URI for the Clinical Document and TranscriptFileUri holds the Amazon S3 URI for the Transcript.
    
    Parameters:
    
    medicalScribeOutput - The location of the output of your Medical Scribe job. ClinicalDocumentUri holds the Amazon S3 URI for the Clinical Document and TranscriptFileUri holds the Amazon S3 URI for the Transcript.
    
    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-04T12: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-04T12: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-04T12: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-04T12: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 MedicalScribeJob 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-04T12: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-04T12: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.
  - 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-04T12: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-04T12: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-04T12: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-04T12: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 MedicalScribeJob 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-04T12: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-04T12: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.
  - 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-04T12: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-04T12: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-04T12: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-04T12: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 MedicalScribeJob 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-04T12: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-04T12: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.
  - 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 MedicalScribeJob 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.
  - setSettings
```
public void setSettings(MedicalScribeSettings settings)
```
    Makes it possible to control how your Medical Scribe job is processed using a MedicalScribeSettings object. Specify ChannelIdentification if ChannelDefinitions are set. Enabled ShowSpeakerLabels if ChannelIdentification and ChannelDefinitions are not set. One and only one of ChannelIdentification and ShowSpeakerLabels must be set. If ShowSpeakerLabels is set, MaxSpeakerLabels must also be set. Use Settings to specify a vocabulary or vocabulary filter or both using VocabularyName, VocabularyFilterName. VocabularyFilterMethod must be specified if VocabularyFilterName is set.
    
    Parameters:
    
    settings - Makes it possible to control how your Medical Scribe job is processed using a MedicalScribeSettings object. Specify ChannelIdentification if ChannelDefinitions are set. Enabled ShowSpeakerLabels if ChannelIdentification and ChannelDefinitions are not set. One and only one of ChannelIdentification and ShowSpeakerLabels must be set. If ShowSpeakerLabels is set, MaxSpeakerLabels must also be set. Use Settings to specify a vocabulary or vocabulary filter or both using VocabularyName, VocabularyFilterName. VocabularyFilterMethod must be specified if VocabularyFilterName is set.
  - getSettings
```
public MedicalScribeSettings getSettings()
```
    Makes it possible to control how your Medical Scribe job is processed using a MedicalScribeSettings object. Specify ChannelIdentification if ChannelDefinitions are set. Enabled ShowSpeakerLabels if ChannelIdentification and ChannelDefinitions are not set. One and only one of ChannelIdentification and ShowSpeakerLabels must be set. If ShowSpeakerLabels is set, MaxSpeakerLabels must also be set. Use Settings to specify a vocabulary or vocabulary filter or both using VocabularyName, VocabularyFilterName. VocabularyFilterMethod must be specified if VocabularyFilterName is set.
    
    Returns:
    
    Makes it possible to control how your Medical Scribe job is processed using a MedicalScribeSettings object. Specify ChannelIdentification if ChannelDefinitions are set. Enabled ShowSpeakerLabels if ChannelIdentification and ChannelDefinitions are not set. One and only one of ChannelIdentification and ShowSpeakerLabels must be set. If ShowSpeakerLabels is set, MaxSpeakerLabels must also be set. Use Settings to specify a vocabulary or vocabulary filter or both using VocabularyName, VocabularyFilterName. VocabularyFilterMethod must be specified if VocabularyFilterName is set.
  - withSettings
```
public MedicalScribeJob withSettings(MedicalScribeSettings settings)
```
    Makes it possible to control how your Medical Scribe job is processed using a MedicalScribeSettings object. Specify ChannelIdentification if ChannelDefinitions are set. Enabled ShowSpeakerLabels if ChannelIdentification and ChannelDefinitions are not set. One and only one of ChannelIdentification and ShowSpeakerLabels must be set. If ShowSpeakerLabels is set, MaxSpeakerLabels must also be set. Use Settings to specify a vocabulary or vocabulary filter or both using VocabularyName, VocabularyFilterName. VocabularyFilterMethod must be specified if VocabularyFilterName is set.
    
    Parameters:
    
    settings - Makes it possible to control how your Medical Scribe job is processed using a MedicalScribeSettings object. Specify ChannelIdentification if ChannelDefinitions are set. Enabled ShowSpeakerLabels if ChannelIdentification and ChannelDefinitions are not set. One and only one of ChannelIdentification and ShowSpeakerLabels must be set. If ShowSpeakerLabels is set, MaxSpeakerLabels must also be set. Use Settings to specify a vocabulary or vocabulary filter or both using VocabularyName, VocabularyFilterName. VocabularyFilterMethod must be specified if VocabularyFilterName is set.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDataAccessRoleArn
```
public void setDataAccessRoleArn(String dataAccessRoleArn)
```
    The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files, write to the output bucket, and use your KMS key if supplied. If the role that you specify doesn’t have the appropriate permissions your request fails.
    
    IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. For example: arn:aws:iam::111122223333:role/Admin.
    
    For more information, see IAM ARNs.
    
    Parameters:
    
    dataAccessRoleArn - The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files, write to the output bucket, and use your KMS key if supplied. If the role that you specify doesn’t have the appropriate permissions your request fails.
    
    IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. For example: arn:aws:iam::111122223333:role/Admin.
    
    For more information, see IAM ARNs.
  - getDataAccessRoleArn
```
public String getDataAccessRoleArn()
```
    The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files, write to the output bucket, and use your KMS key if supplied. If the role that you specify doesn’t have the appropriate permissions your request fails.
    
    IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. For example: arn:aws:iam::111122223333:role/Admin.
    
    For more information, see IAM ARNs.
    
    Returns:
    
    The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files, write to the output bucket, and use your KMS key if supplied. If the role that you specify doesn’t have the appropriate permissions your request fails.
    
    IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. For example: arn:aws:iam::111122223333:role/Admin.
    
    For more information, see IAM ARNs.
  - withDataAccessRoleArn
```
public MedicalScribeJob withDataAccessRoleArn(String dataAccessRoleArn)
```
    The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files, write to the output bucket, and use your KMS key if supplied. If the role that you specify doesn’t have the appropriate permissions your request fails.
    
    IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. For example: arn:aws:iam::111122223333:role/Admin.
    
    For more information, see IAM ARNs.
    
    Parameters:
    
    dataAccessRoleArn - The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files, write to the output bucket, and use your KMS key if supplied. If the role that you specify doesn’t have the appropriate permissions your request fails.
    
    IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. For example: arn:aws:iam::111122223333:role/Admin.
    
    For more information, see IAM ARNs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getChannelDefinitions
```
public List<MedicalScribeChannelDefinition> getChannelDefinitions()
```
    Makes it possible to specify which speaker is on which channel. For example, if the clinician is the first participant to speak, you would set ChannelId of the first ChannelDefinition in the list to 0 (to indicate the first channel) and ParticipantRole to CLINICIAN (to indicate that it's the clinician speaking). Then you would set the ChannelId of the second ChannelDefinition in the list to 1 (to indicate the second channel) and ParticipantRole to PATIENT (to indicate that it's the patient speaking).
    
    Returns:
    
    Makes it possible to specify which speaker is on which channel. For example, if the clinician is the first participant to speak, you would set ChannelId of the first ChannelDefinition in the list to 0 (to indicate the first channel) and ParticipantRole to CLINICIAN (to indicate that it's the clinician speaking). Then you would set the ChannelId of the second ChannelDefinition in the list to 1 (to indicate the second channel) and ParticipantRole to PATIENT (to indicate that it's the patient speaking).
  - setChannelDefinitions
```
public void setChannelDefinitions(Collection<MedicalScribeChannelDefinition> channelDefinitions)
```
    Makes it possible to specify which speaker is on which channel. For example, if the clinician is the first participant to speak, you would set ChannelId of the first ChannelDefinition in the list to 0 (to indicate the first channel) and ParticipantRole to CLINICIAN (to indicate that it's the clinician speaking). Then you would set the ChannelId of the second ChannelDefinition in the list to 1 (to indicate the second channel) and ParticipantRole to PATIENT (to indicate that it's the patient speaking).
    
    Parameters:
    
    channelDefinitions - Makes it possible to specify which speaker is on which channel. For example, if the clinician is the first participant to speak, you would set ChannelId of the first ChannelDefinition in the list to 0 (to indicate the first channel) and ParticipantRole to CLINICIAN (to indicate that it's the clinician speaking). Then you would set the ChannelId of the second ChannelDefinition in the list to 1 (to indicate the second channel) and ParticipantRole to PATIENT (to indicate that it's the patient speaking).
  - withChannelDefinitions
```
public MedicalScribeJob withChannelDefinitions(MedicalScribeChannelDefinition... channelDefinitions)
```
    Makes it possible to specify which speaker is on which channel. For example, if the clinician is the first participant to speak, you would set ChannelId of the first ChannelDefinition in the list to 0 (to indicate the first channel) and ParticipantRole to CLINICIAN (to indicate that it's the clinician speaking). Then you would set the ChannelId of the second ChannelDefinition in the list to 1 (to indicate the second channel) and ParticipantRole to PATIENT (to indicate that it's the patient speaking).
    
    NOTE: This method appends the values to the existing list (if any). Use setChannelDefinitions(java.util.Collection) or withChannelDefinitions(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    channelDefinitions - Makes it possible to specify which speaker is on which channel. For example, if the clinician is the first participant to speak, you would set ChannelId of the first ChannelDefinition in the list to 0 (to indicate the first channel) and ParticipantRole to CLINICIAN (to indicate that it's the clinician speaking). Then you would set the ChannelId of the second ChannelDefinition in the list to 1 (to indicate the second channel) and ParticipantRole to PATIENT (to indicate that it's the patient speaking).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withChannelDefinitions
```
public MedicalScribeJob withChannelDefinitions(Collection<MedicalScribeChannelDefinition> channelDefinitions)
```
    Makes it possible to specify which speaker is on which channel. For example, if the clinician is the first participant to speak, you would set ChannelId of the first ChannelDefinition in the list to 0 (to indicate the first channel) and ParticipantRole to CLINICIAN (to indicate that it's the clinician speaking). Then you would set the ChannelId of the second ChannelDefinition in the list to 1 (to indicate the second channel) and ParticipantRole to PATIENT (to indicate that it's the patient speaking).
    
    Parameters:
    
    channelDefinitions - Makes it possible to specify which speaker is on which channel. For example, if the clinician is the first participant to speak, you would set ChannelId of the first ChannelDefinition in the list to 0 (to indicate the first channel) and ParticipantRole to CLINICIAN (to indicate that it's the clinician speaking). Then you would set the ChannelId of the second ChannelDefinition in the list to 1 (to indicate the second channel) and ParticipantRole to PATIENT (to indicate that it's the patient speaking).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public List<Tag> getTags()
```
    Adds one or more custom tags, each in the form of a key:value pair, to the Medica Scribe job.
    
    To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
    
    Returns:
    
    Adds one or more custom tags, each in the form of a key:value pair, to the Medica Scribe job.
    
    To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    Adds one or more custom tags, each in the form of a key:value pair, to the Medica Scribe job.
    
    To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
    
    Parameters:
    
    tags - Adds one or more custom tags, each in the form of a key:value pair, to the Medica Scribe job.
    
    To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
  - withTags
```
public MedicalScribeJob withTags(Tag... tags)
```
    Adds one or more custom tags, each in the form of a key:value pair, to the Medica Scribe job.
    
    To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
    
    NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    tags - Adds one or more custom tags, each in the form of a key:value pair, to the Medica Scribe job.
    
    To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public MedicalScribeJob withTags(Collection<Tag> tags)
```
    Adds one or more custom tags, each in the form of a key:value pair, to the Medica Scribe job.
    
    To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
    
    Parameters:
    
    tags - Adds one or more custom tags, each in the form of a key:value pair, to the Medica Scribe job.
    
    To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
    
    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 MedicalScribeJob 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.

AWS SDK for Java 1.x API Reference - 1.12.772

Class MedicalScribeJob

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MedicalScribeJob

Method Detail

setMedicalScribeJobName

getMedicalScribeJobName

withMedicalScribeJobName

setMedicalScribeJobStatus

getMedicalScribeJobStatus

withMedicalScribeJobStatus

withMedicalScribeJobStatus

setLanguageCode

getLanguageCode

withLanguageCode

withLanguageCode

setMedia

getMedia

withMedia

setMedicalScribeOutput

getMedicalScribeOutput

withMedicalScribeOutput

setStartTime

getStartTime

withStartTime

setCreationTime

getCreationTime

withCreationTime

setCompletionTime

getCompletionTime

withCompletionTime

setFailureReason

getFailureReason

withFailureReason

setSettings

getSettings

withSettings

setDataAccessRoleArn

getDataAccessRoleArn

withDataAccessRoleArn

getChannelDefinitions

setChannelDefinitions

withChannelDefinitions

withChannelDefinitions

getTags

setTags

withTags

withTags

toString

equals

hashCode

clone

marshall