@Generated(value="software.amazon.awssdk:codegen") public final class TranscriptionJob extends Object implements SdkPojo, Serializable, ToCopyableBuilder<TranscriptionJob.Builder,TranscriptionJob>
Describes an asynchronous transcription job that was created with the StartTranscriptionJob
operation.
Modifier and Type | Class and Description |
---|---|
static interface |
TranscriptionJob.Builder |
Modifier and Type | Method and Description |
---|---|
static TranscriptionJob.Builder |
builder() |
Instant |
completionTime()
A timestamp that shows when the job was completed.
|
ContentRedaction |
contentRedaction()
An object that describes content redaction settings for the transcription job.
|
Instant |
creationTime()
A timestamp that shows when the job was created.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
String |
failureReason()
If the
TranscriptionJobStatus field is FAILED , this field contains information about
why the job failed. |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasLanguageOptions()
Returns true if the LanguageOptions property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
Float |
identifiedLanguageScore()
A value between zero and one that Amazon Transcribe assigned to the language that it identified in the source
audio.
|
Boolean |
identifyLanguage()
A value that shows if automatic language identification was enabled for a transcription job.
|
JobExecutionSettings |
jobExecutionSettings()
Provides information about how a transcription job is executed.
|
LanguageCode |
languageCode()
The language code for the input speech.
|
String |
languageCodeAsString()
The language code for the input speech.
|
List<LanguageCode> |
languageOptions()
An object that shows the optional array of languages inputted for transcription jobs with automatic language
identification enabled.
|
List<String> |
languageOptionsAsStrings()
An object that shows the optional array of languages inputted for transcription jobs with automatic language
identification enabled.
|
Media |
media()
An object that describes the input media for the 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.
|
ModelSettings |
modelSettings()
An object containing the details of your custom language model.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends TranscriptionJob.Builder> |
serializableBuilderClass() |
Settings |
settings()
Optional settings for the transcription job.
|
Instant |
startTime()
A timestamp that shows with the job was started processing.
|
TranscriptionJob.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
Transcript |
transcript()
An object that describes the output of the transcription job.
|
String |
transcriptionJobName()
The name of the transcription job.
|
TranscriptionJobStatus |
transcriptionJobStatus()
The status of the transcription job.
|
String |
transcriptionJobStatusAsString()
The status of the transcription job.
|
copy
public final String transcriptionJobName()
The name of the transcription job.
public final TranscriptionJobStatus transcriptionJobStatus()
The status of the transcription job.
If the service returns an enum value that is not available in the current SDK version,
transcriptionJobStatus
will return TranscriptionJobStatus.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from transcriptionJobStatusAsString()
.
TranscriptionJobStatus
public final String transcriptionJobStatusAsString()
The status of the transcription job.
If the service returns an enum value that is not available in the current SDK version,
transcriptionJobStatus
will return TranscriptionJobStatus.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from transcriptionJobStatusAsString()
.
TranscriptionJobStatus
public final LanguageCode languageCode()
The language code for the input speech.
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()
.
LanguageCode
public final String languageCodeAsString()
The language code for the input speech.
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()
.
LanguageCode
public final Integer mediaSampleRateHertz()
The sample rate, in Hertz, of the audio track in the input media file.
public final 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()
.
MediaFormat
public final 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()
.
MediaFormat
public final Media media()
An object that describes the input media for the transcription job.
public final Transcript transcript()
An object that describes the output of the transcription job.
public final Instant startTime()
A timestamp that shows with the job was started processing.
public final Instant creationTime()
A timestamp that shows when the job was created.
public final Instant completionTime()
A timestamp that shows when the job was completed.
public final String failureReason()
If the TranscriptionJobStatus
field is FAILED
, this field contains information about
why the job failed.
The FailureReason
field can contain one of the following values:
Unsupported media format
- The media format specified in the MediaFormat
field of the
request isn't valid. See the description of the MediaFormat
field for a list of valid values.
The media format provided does not match the detected media format
- The media format of the audio
file doesn't match the format specified in the MediaFormat
field in the request. Check the media
format of your media file and make sure that the two values match.
Invalid sample rate for audio file
- The sample rate specified in the
MediaSampleRateHertz
of the request isn't valid. The sample rate must be between 8000 and 48000
Hertz.
The sample rate provided does not match the detected sample rate
- The sample rate in the audio file
doesn't match the sample rate specified in the MediaSampleRateHertz
field in the request. Check the
sample rate of your media file and make sure that the two values match.
Invalid file size: file size too large
- The size of your audio file is larger than Amazon
Transcribe can process. For more information, see Limits in the Amazon
Transcribe Developer Guide.
Invalid number of channels: number of channels too large
- Your audio contains more channels than
Amazon Transcribe is configured to process. To request additional channels, see Amazon
Transcribe Limits in the Amazon Web Services General Reference.
TranscriptionJobStatus
field is FAILED
, this field contains information
about why the job failed.
The FailureReason
field can contain one of the following values:
Unsupported media format
- The media format specified in the MediaFormat
field
of the request isn't valid. See the description of the MediaFormat
field for a list of valid
values.
The media format provided does not match the detected media format
- The media format of the
audio file doesn't match the format specified in the MediaFormat
field in the request. Check
the media format of your media file and make sure that the two values match.
Invalid sample rate for audio file
- The sample rate specified in the
MediaSampleRateHertz
of the request isn't valid. The sample rate must be between 8000 and
48000 Hertz.
The sample rate provided does not match the detected sample rate
- The sample rate in the
audio file doesn't match the sample rate specified in the MediaSampleRateHertz
field in the
request. Check the sample rate of your media file and make sure that the two values match.
Invalid file size: file size too large
- The size of your audio file is larger than Amazon
Transcribe can process. For more information, see Limits in the
Amazon Transcribe Developer Guide.
Invalid number of channels: number of channels too large
- Your audio contains more channels
than Amazon Transcribe is configured to process. To request additional channels, see Amazon Transcribe Limits in the Amazon Web Services General Reference.
public final Settings settings()
Optional settings for the transcription job. Use these settings to turn on speaker recognition, to set the maximum number of speakers that should be identified and to specify a custom vocabulary to use when processing the transcription job.
public final ModelSettings modelSettings()
An object containing the details of your custom language model.
public final JobExecutionSettings jobExecutionSettings()
Provides information about how a transcription job is executed.
public final ContentRedaction contentRedaction()
An object that describes content redaction settings for the transcription job.
public final Boolean identifyLanguage()
A value that shows if automatic language identification was enabled for a transcription job.
public final List<LanguageCode> languageOptions()
An object that shows the optional array of languages inputted for transcription jobs with automatic language identification enabled.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasLanguageOptions()
to see if a value was sent in this field.
public final boolean hasLanguageOptions()
public final List<String> languageOptionsAsStrings()
An object that shows the optional array of languages inputted for transcription jobs with automatic language identification enabled.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasLanguageOptions()
to see if a value was sent in this field.
public final Float identifiedLanguageScore()
A value between zero and one that Amazon Transcribe assigned to the language that it identified in the source audio. Larger values indicate that Amazon Transcribe has higher confidence in the language it identified.
public TranscriptionJob.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<TranscriptionJob.Builder,TranscriptionJob>
public static TranscriptionJob.Builder builder()
public static Class<? extends TranscriptionJob.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()