StartTranscriptionJobRequest (AWS SDK for Android

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.transcribe.model.StartTranscriptionJobRequest

All Implemented Interfaces:

Serializable, Cloneable
```
public class StartTranscriptionJobRequest
extends AmazonWebServiceRequest
implements Serializable
```
Starts an asynchronous job to transcribe speech to text.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

StartTranscriptionJobRequest()

Constructors
Constructor and Description
`StartTranscriptionJobRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`String`	`getLanguageCode()` The language code for the language used in the input media file.
`Media`	`getMedia()` An object that describes the input media for a transcription job.
`String`	`getMediaFormat()` The format of the input media file.
`Integer`	`getMediaSampleRateHertz()` The sample rate, in Hertz, of the audio track in the input media file.
`String`	`getOutputBucketName()` The location where the transcription is stored.
`Settings`	`getSettings()` A `Settings` object that provides optional settings for a transcription job.
`String`	`getTranscriptionJobName()` The name of the job.
`int`	`hashCode()`
`void`	`setLanguageCode(LanguageCode languageCode)` The language code for the language used in the input media file.
`void`	`setLanguageCode(String languageCode)` The language code for the language used in the input media file.
`void`	`setMedia(Media media)` An object that describes the input media for a transcription job.
`void`	`setMediaFormat(MediaFormat mediaFormat)` The format of the input media file.
`void`	`setMediaFormat(String mediaFormat)` The format of the input media file.
`void`	`setMediaSampleRateHertz(Integer mediaSampleRateHertz)` The sample rate, in Hertz, of the audio track in the input media file.
`void`	`setOutputBucketName(String outputBucketName)` The location where the transcription is stored.
`void`	`setSettings(Settings settings)` A `Settings` object that provides optional settings for a transcription job.
`void`	`setTranscriptionJobName(String transcriptionJobName)` The name of the job.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`StartTranscriptionJobRequest`	`withLanguageCode(LanguageCode languageCode)` The language code for the language used in the input media file.
`StartTranscriptionJobRequest`	`withLanguageCode(String languageCode)` The language code for the language used in the input media file.
`StartTranscriptionJobRequest`	`withMedia(Media media)` An object that describes the input media for a transcription job.
`StartTranscriptionJobRequest`	`withMediaFormat(MediaFormat mediaFormat)` The format of the input media file.
`StartTranscriptionJobRequest`	`withMediaFormat(String mediaFormat)` The format of the input media file.
`StartTranscriptionJobRequest`	`withMediaSampleRateHertz(Integer mediaSampleRateHertz)` The sample rate, in Hertz, of the audio track in the input media file.
`StartTranscriptionJobRequest`	`withOutputBucketName(String outputBucketName)` The location where the transcription is stored.
`StartTranscriptionJobRequest`	`withSettings(Settings settings)` A `Settings` object that provides optional settings for a transcription job.
`StartTranscriptionJobRequest`	`withTranscriptionJobName(String transcriptionJobName)` The name of the job.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

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

- Constructor Detail
  - StartTranscriptionJobRequest
```
public StartTranscriptionJobRequest()
```
- Method Detail
  - getTranscriptionJobName
```
public String getTranscriptionJobName()
```
    The name of the job. Note that you can't use the strings "." or ".." by themselves as the job name. The name must also be unique within an AWS account.
    
    Constraints:
    Length: 1 - 200
    Pattern: ^[0-9a-zA-Z._-]+
    
    Returns:
    
    The name of the job. Note that you can't use the strings "." or ".." by themselves as the job name. The name must also be unique within an AWS account.
  - setTranscriptionJobName
```
public void setTranscriptionJobName(String transcriptionJobName)
```
    The name of the job. Note that you can't use the strings "." or ".." by themselves as the job name. The name must also be unique within an AWS account.
    
    Constraints:
    Length: 1 - 200
    Pattern: ^[0-9a-zA-Z._-]+
    
    Parameters:
    
    transcriptionJobName -
    The name of the job. Note that you can't use the strings "." or ".." by themselves as the job name. The name must also be unique within an AWS account.
  - withTranscriptionJobName
```
public StartTranscriptionJobRequest withTranscriptionJobName(String transcriptionJobName)
```
    The name of the job. Note that you can't use the strings "." or ".." by themselves as the job name. The name must also be unique within an AWS account.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 200
    Pattern: ^[0-9a-zA-Z._-]+
    
    Parameters:
    
    transcriptionJobName -
    The name of the job. Note that you can't use the strings "." or ".." by themselves as the job name. The name must also be unique within an AWS account.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getLanguageCode
```
public String getLanguageCode()
```
    The language code for the language used in the input media file.
    
    Constraints:
    Allowed Values: en-US, es-US, en-AU, fr-CA, en-GB, de-DE, pt-BR, fr-FR, it-IT, ko-KR
    
    Returns:
    
    The language code for the language used in the input media file.
    
    See Also:
    
    LanguageCode
  - setLanguageCode
```
public void setLanguageCode(String languageCode)
```
    The language code for the language used in the input media file.
    
    Constraints:
    Allowed Values: en-US, es-US, en-AU, fr-CA, en-GB, de-DE, pt-BR, fr-FR, it-IT, ko-KR
    
    Parameters:
    
    languageCode -
    The language code for the language used in the input media file.
    
    See Also:
    
    LanguageCode
  - withLanguageCode
```
public StartTranscriptionJobRequest withLanguageCode(String languageCode)
```
    The language code for the language used in the input media file.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: en-US, es-US, en-AU, fr-CA, en-GB, de-DE, pt-BR, fr-FR, it-IT, ko-KR
    
    Parameters:
    
    languageCode -
    The language code for the language used in the input media file.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    LanguageCode
  - setLanguageCode
```
public void setLanguageCode(LanguageCode languageCode)
```
    The language code for the language used in the input media file.
    
    Constraints:
    Allowed Values: en-US, es-US, en-AU, fr-CA, en-GB, de-DE, pt-BR, fr-FR, it-IT, ko-KR
    
    Parameters:
    
    languageCode -
    The language code for the language used in the input media file.
    
    See Also:
    
    LanguageCode
  - withLanguageCode
```
public StartTranscriptionJobRequest withLanguageCode(LanguageCode languageCode)
```
    The language code for the language used in the input media file.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: en-US, es-US, en-AU, fr-CA, en-GB, de-DE, pt-BR, fr-FR, it-IT, ko-KR
    
    Parameters:
    
    languageCode -
    The language code for the language used in the input media file.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    LanguageCode
  - getMediaSampleRateHertz
```
public Integer getMediaSampleRateHertz()
```
    The sample rate, in Hertz, of the audio track in the input media file.
    
    Constraints:
    Range: 8000 - 48000
    
    Returns:
    
    The sample rate, in Hertz, of the audio track in the input media file.
  - setMediaSampleRateHertz
```
public void setMediaSampleRateHertz(Integer mediaSampleRateHertz)
```
    The sample rate, in Hertz, of the audio track in the input media file.
    
    Constraints:
    Range: 8000 - 48000
    
    Parameters:
    
    mediaSampleRateHertz -
    The sample rate, in Hertz, of the audio track in the input media file.
  - withMediaSampleRateHertz
```
public StartTranscriptionJobRequest withMediaSampleRateHertz(Integer mediaSampleRateHertz)
```
    The sample rate, in Hertz, of the audio track in the input media file.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Range: 8000 - 48000
    
    Parameters:
    
    mediaSampleRateHertz -
    The sample rate, in Hertz, of the audio track in the input media file.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getMediaFormat
```
public String getMediaFormat()
```
    The format of the input media file.
    
    Constraints:
    Allowed Values: mp3, mp4, wav, flac
    
    Returns:
    
    The format of the input media file.
    
    See Also:
    
    MediaFormat
  - setMediaFormat
```
public void setMediaFormat(String mediaFormat)
```
    The format of the input media file.
    
    Constraints:
    Allowed Values: mp3, mp4, wav, flac
    
    Parameters:
    
    mediaFormat -
    The format of the input media file.
    
    See Also:
    
    MediaFormat
  - withMediaFormat
```
public StartTranscriptionJobRequest withMediaFormat(String mediaFormat)
```
    The format of the input media file.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: mp3, mp4, wav, flac
    
    Parameters:
    
    mediaFormat -
    The format of the input media file.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    MediaFormat
  - setMediaFormat
```
public void setMediaFormat(MediaFormat mediaFormat)
```
    The format of the input media file.
    
    Constraints:
    Allowed Values: mp3, mp4, wav, flac
    
    Parameters:
    
    mediaFormat -
    The format of the input media file.
    
    See Also:
    
    MediaFormat
  - withMediaFormat
```
public StartTranscriptionJobRequest withMediaFormat(MediaFormat mediaFormat)
```
    The format of the input media file.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: mp3, mp4, wav, flac
    
    Parameters:
    
    mediaFormat -
    The format of the input media file.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    MediaFormat
  - getMedia
```
public Media getMedia()
```
    An object that describes the input media for a transcription job.
    
    Returns:
    
    An object that describes the input media for a transcription job.
  - setMedia
```
public void setMedia(Media media)
```
    An object that describes the input media for a transcription job.
    
    Parameters:
    
    media -
    An object that describes the input media for a transcription job.
  - withMedia
```
public StartTranscriptionJobRequest withMedia(Media media)
```
    An object that describes the input media for a transcription job.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    media -
    An object that describes the input media for a transcription job.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getOutputBucketName
```
public String getOutputBucketName()
```
    The location where the transcription is stored.
    
    If you set the OutputBucketName, Amazon Transcribe puts the transcription in the specified S3 bucket. When you call the GetTranscriptionJob operation, the operation returns this location in the TranscriptFileUri field. The S3 bucket must have permissions that allow Amazon Transcribe to put files in the bucket. For more information, see Permissions Required for IAM User Roles.
    
    Amazon Transcribe uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket. You can't specify your own encryption key.
    
    If you don't set the OutputBucketName, Amazon Transcribe generates a pre-signed URL, a shareable URL that provides secure access to your transcription, and returns it in the TranscriptFileUri field. Use this URL to download the transcription.
    
    Constraints:
    Pattern: [a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]
    
    Returns:
    
    The location where the transcription is stored.
    
    If you set the OutputBucketName, Amazon Transcribe puts the transcription in the specified S3 bucket. When you call the GetTranscriptionJob operation, the operation returns this location in the TranscriptFileUri field. The S3 bucket must have permissions that allow Amazon Transcribe to put files in the bucket. For more information, see Permissions Required for IAM User Roles.
    
    Amazon Transcribe uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket. You can't specify your own encryption key.
    
    If you don't set the OutputBucketName, Amazon Transcribe generates a pre-signed URL, a shareable URL that provides secure access to your transcription, and returns it in the TranscriptFileUri field. Use this URL to download the transcription.
  - setOutputBucketName
```
public void setOutputBucketName(String outputBucketName)
```
    The location where the transcription is stored.
    
    If you set the OutputBucketName, Amazon Transcribe puts the transcription in the specified S3 bucket. When you call the GetTranscriptionJob operation, the operation returns this location in the TranscriptFileUri field. The S3 bucket must have permissions that allow Amazon Transcribe to put files in the bucket. For more information, see Permissions Required for IAM User Roles.
    
    Amazon Transcribe uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket. You can't specify your own encryption key.
    
    If you don't set the OutputBucketName, Amazon Transcribe generates a pre-signed URL, a shareable URL that provides secure access to your transcription, and returns it in the TranscriptFileUri field. Use this URL to download the transcription.
    
    Constraints:
    Pattern: [a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]
    
    Parameters:
    
    outputBucketName -
    The location where the transcription is stored.
    
    If you set the OutputBucketName, Amazon Transcribe puts the transcription in the specified S3 bucket. When you call the GetTranscriptionJob operation, the operation returns this location in the TranscriptFileUri field. The S3 bucket must have permissions that allow Amazon Transcribe to put files in the bucket. For more information, see Permissions Required for IAM User Roles.
    
    Amazon Transcribe uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket. You can't specify your own encryption key.
    
    If you don't set the OutputBucketName, Amazon Transcribe generates a pre-signed URL, a shareable URL that provides secure access to your transcription, and returns it in the TranscriptFileUri field. Use this URL to download the transcription.
  - withOutputBucketName
```
public StartTranscriptionJobRequest withOutputBucketName(String outputBucketName)
```
    The location where the transcription is stored.
    
    If you set the OutputBucketName, Amazon Transcribe puts the transcription in the specified S3 bucket. When you call the GetTranscriptionJob operation, the operation returns this location in the TranscriptFileUri field. The S3 bucket must have permissions that allow Amazon Transcribe to put files in the bucket. For more information, see Permissions Required for IAM User Roles.
    
    Amazon Transcribe uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket. You can't specify your own encryption key.
    
    If you don't set the OutputBucketName, Amazon Transcribe generates a pre-signed URL, a shareable URL that provides secure access to your transcription, and returns it in the TranscriptFileUri field. Use this URL to download the transcription.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Pattern: [a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]
    
    Parameters:
    
    outputBucketName -
    The location where the transcription is stored.
    
    If you set the OutputBucketName, Amazon Transcribe puts the transcription in the specified S3 bucket. When you call the GetTranscriptionJob operation, the operation returns this location in the TranscriptFileUri field. The S3 bucket must have permissions that allow Amazon Transcribe to put files in the bucket. For more information, see Permissions Required for IAM User Roles.
    
    Amazon Transcribe uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket. You can't specify your own encryption key.
    
    If you don't set the OutputBucketName, Amazon Transcribe generates a pre-signed URL, a shareable URL that provides secure access to your transcription, and returns it in the TranscriptFileUri field. Use this URL to download the transcription.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSettings
```
public Settings getSettings()
```
    A Settings object that provides optional settings for a transcription job.
    
    Returns:
    
    A Settings object that provides optional settings for a transcription job.
  - setSettings
```
public void setSettings(Settings settings)
```
    A Settings object that provides optional settings for a transcription job.
    
    Parameters:
    
    settings -
    A Settings object that provides optional settings for a transcription job.
  - withSettings
```
public StartTranscriptionJobRequest withSettings(Settings settings)
```
    A Settings object that provides optional settings for a transcription job.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    settings -
    A Settings object that provides optional settings for a transcription job.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class StartTranscriptionJobRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

StartTranscriptionJobRequest

Method Detail

getTranscriptionJobName

setTranscriptionJobName

withTranscriptionJobName

getLanguageCode

setLanguageCode

withLanguageCode

setLanguageCode

withLanguageCode

getMediaSampleRateHertz

setMediaSampleRateHertz

withMediaSampleRateHertz

getMediaFormat

setMediaFormat

withMediaFormat

setMediaFormat

withMediaFormat

getMedia

setMedia

withMedia

getOutputBucketName

setOutputBucketName

withOutputBucketName

getSettings

setSettings

withSettings

toString

hashCode

equals