@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class StartTranscriptionJobRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP| Constructor and Description |
|---|
StartTranscriptionJobRequest() |
| Modifier and Type | Method and Description |
|---|---|
StartTranscriptionJobRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
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 of the audio track in the input media file in Hertz.
|
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(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(String mediaFormat)
The format of the input media file.
|
void |
setMediaSampleRateHertz(Integer mediaSampleRateHertz)
The sample rate of the audio track in the input media file in Hertz.
|
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.
|
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 of the audio track in the input media file in Hertz.
|
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.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeoutpublic 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.
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.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.
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.
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.public void setLanguageCode(String languageCode)
The language code for the language used in the input media file.
languageCode - The language code for the language used in the input media file.LanguageCodepublic String getLanguageCode()
The language code for the language used in the input media file.
LanguageCodepublic StartTranscriptionJobRequest withLanguageCode(String languageCode)
The language code for the language used in the input media file.
languageCode - The language code for the language used in the input media file.LanguageCodepublic StartTranscriptionJobRequest withLanguageCode(LanguageCode languageCode)
The language code for the language used in the input media file.
languageCode - The language code for the language used in the input media file.LanguageCodepublic void setMediaSampleRateHertz(Integer mediaSampleRateHertz)
The sample rate of the audio track in the input media file in Hertz.
If you do not specify the media sample rate, Amazon Transcribe determines the sample rate. If you specify the
sample rate, it must match the sample rate detected by Amazon Transcribe. In most cases, you should leave the
MediaSampleRateHertz field blank and let Amazon Transcribe determine the sample rate.
mediaSampleRateHertz - The sample rate of the audio track in the input media file in Hertz.
If you do not specify the media sample rate, Amazon Transcribe determines the sample rate. If you specify
the sample rate, it must match the sample rate detected by Amazon Transcribe. In most cases, you should
leave the MediaSampleRateHertz field blank and let Amazon Transcribe determine the sample
rate.
public Integer getMediaSampleRateHertz()
The sample rate of the audio track in the input media file in Hertz.
If you do not specify the media sample rate, Amazon Transcribe determines the sample rate. If you specify the
sample rate, it must match the sample rate detected by Amazon Transcribe. In most cases, you should leave the
MediaSampleRateHertz field blank and let Amazon Transcribe determine the sample rate.
If you do not specify the media sample rate, Amazon Transcribe determines the sample rate. If you specify
the sample rate, it must match the sample rate detected by Amazon Transcribe. In most cases, you should
leave the MediaSampleRateHertz field blank and let Amazon Transcribe determine the sample
rate.
public StartTranscriptionJobRequest withMediaSampleRateHertz(Integer mediaSampleRateHertz)
The sample rate of the audio track in the input media file in Hertz.
If you do not specify the media sample rate, Amazon Transcribe determines the sample rate. If you specify the
sample rate, it must match the sample rate detected by Amazon Transcribe. In most cases, you should leave the
MediaSampleRateHertz field blank and let Amazon Transcribe determine the sample rate.
mediaSampleRateHertz - The sample rate of the audio track in the input media file in Hertz.
If you do not specify the media sample rate, Amazon Transcribe determines the sample rate. If you specify
the sample rate, it must match the sample rate detected by Amazon Transcribe. In most cases, you should
leave the MediaSampleRateHertz field blank and let Amazon Transcribe determine the sample
rate.
public void setMediaFormat(String mediaFormat)
The format of the input media file.
If you do not specify the format of the media file, Amazon Transcribe determines the format. If the format is not
recognized, Amazon Transcribe returns an InternalFailureException exception. If you specify the
format, it must match the format detected by Amazon Transcribe, otherwise you get an
InternalFailureException exception.
mediaFormat - The format of the input media file.
If you do not specify the format of the media file, Amazon Transcribe determines the format. If the format
is not recognized, Amazon Transcribe returns an InternalFailureException exception. If you
specify the format, it must match the format detected by Amazon Transcribe, otherwise you get an
InternalFailureException exception.
MediaFormatpublic String getMediaFormat()
The format of the input media file.
If you do not specify the format of the media file, Amazon Transcribe determines the format. If the format is not
recognized, Amazon Transcribe returns an InternalFailureException exception. If you specify the
format, it must match the format detected by Amazon Transcribe, otherwise you get an
InternalFailureException exception.
If you do not specify the format of the media file, Amazon Transcribe determines the format. If the
format is not recognized, Amazon Transcribe returns an InternalFailureException exception.
If you specify the format, it must match the format detected by Amazon Transcribe, otherwise you get an
InternalFailureException exception.
MediaFormatpublic StartTranscriptionJobRequest withMediaFormat(String mediaFormat)
The format of the input media file.
If you do not specify the format of the media file, Amazon Transcribe determines the format. If the format is not
recognized, Amazon Transcribe returns an InternalFailureException exception. If you specify the
format, it must match the format detected by Amazon Transcribe, otherwise you get an
InternalFailureException exception.
mediaFormat - The format of the input media file.
If you do not specify the format of the media file, Amazon Transcribe determines the format. If the format
is not recognized, Amazon Transcribe returns an InternalFailureException exception. If you
specify the format, it must match the format detected by Amazon Transcribe, otherwise you get an
InternalFailureException exception.
MediaFormatpublic StartTranscriptionJobRequest withMediaFormat(MediaFormat mediaFormat)
The format of the input media file.
If you do not specify the format of the media file, Amazon Transcribe determines the format. If the format is not
recognized, Amazon Transcribe returns an InternalFailureException exception. If you specify the
format, it must match the format detected by Amazon Transcribe, otherwise you get an
InternalFailureException exception.
mediaFormat - The format of the input media file.
If you do not specify the format of the media file, Amazon Transcribe determines the format. If the format
is not recognized, Amazon Transcribe returns an InternalFailureException exception. If you
specify the format, it must match the format detected by Amazon Transcribe, otherwise you get an
InternalFailureException exception.
MediaFormatpublic void setMedia(Media media)
An object that describes the input media for a transcription job.
media - An object that describes the input media for a transcription job.public Media getMedia()
An object that describes the input media for a transcription job.
public StartTranscriptionJobRequest withMedia(Media media)
An object that describes the input media for a transcription job.
media - An object that describes the input media for a transcription job.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.
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.
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.
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.
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.
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.
public void setSettings(Settings settings)
A Settings object that provides optional settings for a transcription job.
settings - A Settings object that provides optional settings for a transcription job.public Settings getSettings()
A Settings object that provides optional settings for a transcription job.
Settings object that provides optional settings for a transcription job.public StartTranscriptionJobRequest withSettings(Settings settings)
A Settings object that provides optional settings for a transcription job.
settings - A Settings object that provides optional settings for a transcription job.public String toString()
toString in class ObjectObject.toString()public StartTranscriptionJobRequest clone()
AmazonWebServiceRequestclone in class AmazonWebServiceRequestObject.clone()Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.