StartTranscriptionJobRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.transcribe.model.TranscribeRequest
    - - software.amazon.awssdk.services.transcribe.model.StartTranscriptionJobRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<StartTranscriptionJobRequest.Builder,StartTranscriptionJobRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class StartTranscriptionJobRequest
extends TranscribeRequest
implements ToCopyableBuilder<StartTranscriptionJobRequest.Builder,StartTranscriptionJobRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface StartTranscriptionJobRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`StartTranscriptionJobRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static StartTranscriptionJobRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`LanguageCode`	`languageCode()` The language code for the language used in the input media file.
`String`	`languageCodeAsString()` The language code for the language used in the input media file.
`Media`	`media()` An object that describes the input media for a transcription job.
`MediaFormat`	`mediaFormat()` The format of the input media file.
`String`	`mediaFormatAsString()` The format of the input media file.
`Integer`	`mediaSampleRateHertz()` The sample rate, in Hertz, of the audio track in the input media file.
`String`	`outputBucketName()` The location where the transcription is stored.
`String`	`outputEncryptionKMSKeyId()` The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to encrypt the output of the transcription job.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends StartTranscriptionJobRequest.Builder>`	`serializableBuilderClass()`
`Settings`	`settings()` A `Settings` object that provides optional settings for a transcription job.
`StartTranscriptionJobRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`transcriptionJobName()` The name of the job.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - transcriptionJobName
```
public 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:
    
    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.
  - languageCode
```
public LanguageCode languageCode()
```
    The language code for the language used in the input media file.
    
    If the service returns an enum value that is not available in the current SDK version, languageCode will return LanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().
    
    Returns:
    
    The language code for the language used in the input media file.
    
    See Also:
    
    LanguageCode
  - languageCodeAsString
```
public String languageCodeAsString()
```
    The language code for the language used in the input media file.
    
    If the service returns an enum value that is not available in the current SDK version, languageCode will return LanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().
    
    Returns:
    
    The language code for the language used in the input media file.
    
    See Also:
    
    LanguageCode
  - mediaSampleRateHertz
```
public Integer mediaSampleRateHertz()
```
    The sample rate, in Hertz, of the audio track in the input media file.
    
    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.
    
    Returns:
    
    The sample rate, in Hertz, of the audio track in the input media file.
    
    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.
  - mediaFormat
```
public MediaFormat mediaFormat()
```
    The format of the input media file.
    
    If the service returns an enum value that is not available in the current SDK version, mediaFormat will return MediaFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from mediaFormatAsString().
    
    Returns:
    
    The format of the input media file.
    
    See Also:
    
    MediaFormat
  - mediaFormatAsString
```
public String mediaFormatAsString()
```
    The format of the input media file.
    
    If the service returns an enum value that is not available in the current SDK version, mediaFormat will return MediaFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from mediaFormatAsString().
    
    Returns:
    
    The format of the input media file.
    
    See Also:
    
    MediaFormat
  - media
```
public Media media()
```
    An object that describes the input media for a transcription job.
    
    Returns:
    
    An object that describes the input media for a transcription job.
  - outputBucketName
```
public 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.
    
    You can specify an AWS Key Management Service (KMS) key to encrypt the output of your transcription using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.
    
    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:
    
    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.
    
    You can specify an AWS Key Management Service (KMS) key to encrypt the output of your transcription using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.
    
    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.
  - outputEncryptionKMSKeyId
```
public String outputEncryptionKMSKeyId()
```
    The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to encrypt the output of the transcription job. The user calling the StartTranscriptionJob operation must have permission to use the specified KMS key.
    
    You can use either of the following to identify a KMS key in the current account:
    - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
    - KMS Key Alias: "alias/ExampleAlias"
    You can use either of the following to identify a KMS key in the current account or another account:
    - Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    - ARN of a KMS Key Alias: "arn:aws:kms:region:account ID:alias/ExampleAlias"
    If you don't specify an encryption key, the output of the transcription job is encrypted with the default Amazon S3 key (SSE-S3).
    
    If you specify a KMS key to encrypt your output, you must also specify an output location in the OutputBucketName parameter.
    Returns:
    The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to encrypt the output of the transcription job. The user calling the StartTranscriptionJob operation must have permission to use the specified KMS key.
    
    You can use either of the following to identify a KMS key in the current account:
    
    KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
    
    KMS Key Alias: "alias/ExampleAlias"
    
    You can use either of the following to identify a KMS key in the current account or another account:
    
    Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    
    ARN of a KMS Key Alias: "arn:aws:kms:region:account ID:alias/ExampleAlias"
    
    If you don't specify an encryption key, the output of the transcription job is encrypted with the default Amazon S3 key (SSE-S3).
    
    If you specify a KMS key to encrypt your output, you must also specify an output location in the OutputBucketName parameter.
  - settings
```
public Settings settings()
```
    A Settings object that provides optional settings for a transcription job.
    
    Returns:
    
    A Settings object that provides optional settings for a transcription job.
  - toBuilder
```
public StartTranscriptionJobRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<StartTranscriptionJobRequest.Builder,StartTranscriptionJobRequest>
    
    Specified by:
    
    toBuilder in class TranscribeRequest
  - builder
```
public static StartTranscriptionJobRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends StartTranscriptionJobRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class StartTranscriptionJobRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

transcriptionJobName

languageCode

languageCodeAsString

mediaSampleRateHertz

mediaFormat

mediaFormatAsString

media

outputBucketName

outputEncryptionKMSKeyId

settings

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields