public class TranscriptionJobSummary
extends java.lang.Object
implements java.io.Serializable
Provides a summary of information about a transcription job.
Constructor and Description |
---|
TranscriptionJobSummary() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
java.util.Date |
getCompletionTime()
A timestamp that shows when the job was completed.
|
ContentRedaction |
getContentRedaction()
The content redaction settings of the transcription job.
|
java.util.Date |
getCreationTime()
A timestamp that shows when the job was created.
|
java.lang.String |
getFailureReason()
If the
TranscriptionJobStatus field is FAILED ,
a description of the error. |
java.lang.Float |
getIdentifiedLanguageScore()
A value between zero and one that Amazon Transcribe assigned to the
language it identified in the source audio.
|
java.lang.Boolean |
getIdentifyLanguage()
Whether automatic language identification was enabled for a transcription
job.
|
java.lang.String |
getLanguageCode()
The language code for the input speech.
|
ModelSettings |
getModelSettings()
The object used to call your custom language model to your transcription
job.
|
java.lang.String |
getOutputLocationType()
Indicates the location of the output of the transcription job.
|
java.util.Date |
getStartTime()
A timestamp that shows when the job started processing.
|
java.lang.String |
getTranscriptionJobName()
The name of the transcription job.
|
java.lang.String |
getTranscriptionJobStatus()
The status of the transcription job.
|
int |
hashCode() |
java.lang.Boolean |
isIdentifyLanguage()
Whether automatic language identification was enabled for a transcription
job.
|
void |
setCompletionTime(java.util.Date completionTime)
A timestamp that shows when the job was completed.
|
void |
setContentRedaction(ContentRedaction contentRedaction)
The content redaction settings of the transcription job.
|
void |
setCreationTime(java.util.Date creationTime)
A timestamp that shows when the job was created.
|
void |
setFailureReason(java.lang.String failureReason)
If the
TranscriptionJobStatus field is FAILED ,
a description of the error. |
void |
setIdentifiedLanguageScore(java.lang.Float identifiedLanguageScore)
A value between zero and one that Amazon Transcribe assigned to the
language it identified in the source audio.
|
void |
setIdentifyLanguage(java.lang.Boolean identifyLanguage)
Whether automatic language identification was enabled for a transcription
job.
|
void |
setLanguageCode(LanguageCode languageCode)
The language code for the input speech.
|
void |
setLanguageCode(java.lang.String languageCode)
The language code for the input speech.
|
void |
setModelSettings(ModelSettings modelSettings)
The object used to call your custom language model to your transcription
job.
|
void |
setOutputLocationType(OutputLocationType outputLocationType)
Indicates the location of the output of the transcription job.
|
void |
setOutputLocationType(java.lang.String outputLocationType)
Indicates the location of the output of the transcription job.
|
void |
setStartTime(java.util.Date startTime)
A timestamp that shows when the job started processing.
|
void |
setTranscriptionJobName(java.lang.String transcriptionJobName)
The name of the transcription job.
|
void |
setTranscriptionJobStatus(java.lang.String transcriptionJobStatus)
The status of the transcription job.
|
void |
setTranscriptionJobStatus(TranscriptionJobStatus transcriptionJobStatus)
The status of the transcription job.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
TranscriptionJobSummary |
withCompletionTime(java.util.Date completionTime)
A timestamp that shows when the job was completed.
|
TranscriptionJobSummary |
withContentRedaction(ContentRedaction contentRedaction)
The content redaction settings of the transcription job.
|
TranscriptionJobSummary |
withCreationTime(java.util.Date creationTime)
A timestamp that shows when the job was created.
|
TranscriptionJobSummary |
withFailureReason(java.lang.String failureReason)
If the
TranscriptionJobStatus field is FAILED ,
a description of the error. |
TranscriptionJobSummary |
withIdentifiedLanguageScore(java.lang.Float identifiedLanguageScore)
A value between zero and one that Amazon Transcribe assigned to the
language it identified in the source audio.
|
TranscriptionJobSummary |
withIdentifyLanguage(java.lang.Boolean identifyLanguage)
Whether automatic language identification was enabled for a transcription
job.
|
TranscriptionJobSummary |
withLanguageCode(LanguageCode languageCode)
The language code for the input speech.
|
TranscriptionJobSummary |
withLanguageCode(java.lang.String languageCode)
The language code for the input speech.
|
TranscriptionJobSummary |
withModelSettings(ModelSettings modelSettings)
The object used to call your custom language model to your transcription
job.
|
TranscriptionJobSummary |
withOutputLocationType(OutputLocationType outputLocationType)
Indicates the location of the output of the transcription job.
|
TranscriptionJobSummary |
withOutputLocationType(java.lang.String outputLocationType)
Indicates the location of the output of the transcription job.
|
TranscriptionJobSummary |
withStartTime(java.util.Date startTime)
A timestamp that shows when the job started processing.
|
TranscriptionJobSummary |
withTranscriptionJobName(java.lang.String transcriptionJobName)
The name of the transcription job.
|
TranscriptionJobSummary |
withTranscriptionJobStatus(java.lang.String transcriptionJobStatus)
The status of the transcription job.
|
TranscriptionJobSummary |
withTranscriptionJobStatus(TranscriptionJobStatus transcriptionJobStatus)
The status of the transcription job.
|
public java.lang.String getTranscriptionJobName()
The name of the transcription job.
Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+
The name of the transcription job.
public void setTranscriptionJobName(java.lang.String transcriptionJobName)
The name of the transcription job.
Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+
transcriptionJobName
- The name of the transcription job.
public TranscriptionJobSummary withTranscriptionJobName(java.lang.String transcriptionJobName)
The name of the transcription job.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+
transcriptionJobName
- The name of the transcription job.
public java.util.Date getCreationTime()
A timestamp that shows when the job was created.
A timestamp that shows when the job was created.
public void setCreationTime(java.util.Date creationTime)
A timestamp that shows when the job was created.
creationTime
- A timestamp that shows when the job was created.
public TranscriptionJobSummary withCreationTime(java.util.Date creationTime)
A timestamp that shows when the job was created.
Returns a reference to this object so that method calls can be chained together.
creationTime
- A timestamp that shows when the job was created.
public java.util.Date getStartTime()
A timestamp that shows when the job started processing.
A timestamp that shows when the job started processing.
public void setStartTime(java.util.Date startTime)
A timestamp that shows when the job started processing.
startTime
- A timestamp that shows when the job started processing.
public TranscriptionJobSummary withStartTime(java.util.Date startTime)
A timestamp that shows when the job started processing.
Returns a reference to this object so that method calls can be chained together.
startTime
- A timestamp that shows when the job started processing.
public java.util.Date getCompletionTime()
A timestamp that shows when the job was completed.
A timestamp that shows when the job was completed.
public void setCompletionTime(java.util.Date completionTime)
A timestamp that shows when the job was completed.
completionTime
- A timestamp that shows when the job was completed.
public TranscriptionJobSummary withCompletionTime(java.util.Date completionTime)
A timestamp that shows when the job was completed.
Returns a reference to this object so that method calls can be chained together.
completionTime
- A timestamp that shows when the job was completed.
public java.lang.String getLanguageCode()
The language code for the input speech.
Constraints:
Allowed Values: af-ZA, ar-AE, ar-SA, cy-GB, da-DK, de-CH, de-DE,
en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR,
fr-CA, fr-FR, ga-IE, gd-GB, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR,
ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN
The language code for the input speech.
LanguageCode
public void setLanguageCode(java.lang.String languageCode)
The language code for the input speech.
Constraints:
Allowed Values: af-ZA, ar-AE, ar-SA, cy-GB, da-DK, de-CH, de-DE,
en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR,
fr-CA, fr-FR, ga-IE, gd-GB, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR,
ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN
languageCode
- The language code for the input speech.
LanguageCode
public TranscriptionJobSummary withLanguageCode(java.lang.String languageCode)
The language code for the input speech.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: af-ZA, ar-AE, ar-SA, cy-GB, da-DK, de-CH, de-DE,
en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR,
fr-CA, fr-FR, ga-IE, gd-GB, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR,
ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN
languageCode
- The language code for the input speech.
LanguageCode
public void setLanguageCode(LanguageCode languageCode)
The language code for the input speech.
Constraints:
Allowed Values: af-ZA, ar-AE, ar-SA, cy-GB, da-DK, de-CH, de-DE,
en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR,
fr-CA, fr-FR, ga-IE, gd-GB, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR,
ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN
languageCode
- The language code for the input speech.
LanguageCode
public TranscriptionJobSummary withLanguageCode(LanguageCode languageCode)
The language code for the input speech.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: af-ZA, ar-AE, ar-SA, cy-GB, da-DK, de-CH, de-DE,
en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR,
fr-CA, fr-FR, ga-IE, gd-GB, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR,
ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN
languageCode
- The language code for the input speech.
LanguageCode
public java.lang.String getTranscriptionJobStatus()
The status of the transcription job. When the status is
COMPLETED
, use the GetTranscriptionJob
operation to get the results of the transcription.
Constraints:
Allowed Values: QUEUED, IN_PROGRESS, FAILED, COMPLETED
The status of the transcription job. When the status is
COMPLETED
, use the GetTranscriptionJob
operation to get the results of the transcription.
TranscriptionJobStatus
public void setTranscriptionJobStatus(java.lang.String transcriptionJobStatus)
The status of the transcription job. When the status is
COMPLETED
, use the GetTranscriptionJob
operation to get the results of the transcription.
Constraints:
Allowed Values: QUEUED, IN_PROGRESS, FAILED, COMPLETED
transcriptionJobStatus
-
The status of the transcription job. When the status is
COMPLETED
, use the
GetTranscriptionJob
operation to get the results
of the transcription.
TranscriptionJobStatus
public TranscriptionJobSummary withTranscriptionJobStatus(java.lang.String transcriptionJobStatus)
The status of the transcription job. When the status is
COMPLETED
, use the GetTranscriptionJob
operation to get the results of the transcription.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: QUEUED, IN_PROGRESS, FAILED, COMPLETED
transcriptionJobStatus
-
The status of the transcription job. When the status is
COMPLETED
, use the
GetTranscriptionJob
operation to get the results
of the transcription.
TranscriptionJobStatus
public void setTranscriptionJobStatus(TranscriptionJobStatus transcriptionJobStatus)
The status of the transcription job. When the status is
COMPLETED
, use the GetTranscriptionJob
operation to get the results of the transcription.
Constraints:
Allowed Values: QUEUED, IN_PROGRESS, FAILED, COMPLETED
transcriptionJobStatus
-
The status of the transcription job. When the status is
COMPLETED
, use the
GetTranscriptionJob
operation to get the results
of the transcription.
TranscriptionJobStatus
public TranscriptionJobSummary withTranscriptionJobStatus(TranscriptionJobStatus transcriptionJobStatus)
The status of the transcription job. When the status is
COMPLETED
, use the GetTranscriptionJob
operation to get the results of the transcription.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: QUEUED, IN_PROGRESS, FAILED, COMPLETED
transcriptionJobStatus
-
The status of the transcription job. When the status is
COMPLETED
, use the
GetTranscriptionJob
operation to get the results
of the transcription.
TranscriptionJobStatus
public java.lang.String getFailureReason()
If the TranscriptionJobStatus
field is FAILED
,
a description of the error.
If the TranscriptionJobStatus
field is
FAILED
, a description of the error.
public void setFailureReason(java.lang.String failureReason)
If the TranscriptionJobStatus
field is FAILED
,
a description of the error.
failureReason
-
If the TranscriptionJobStatus
field is
FAILED
, a description of the error.
public TranscriptionJobSummary withFailureReason(java.lang.String failureReason)
If the TranscriptionJobStatus
field is FAILED
,
a description of the error.
Returns a reference to this object so that method calls can be chained together.
failureReason
-
If the TranscriptionJobStatus
field is
FAILED
, a description of the error.
public java.lang.String getOutputLocationType()
Indicates the location of the output of the transcription job.
If the value is CUSTOMER_BUCKET
then the location is the S3
bucket specified in the outputBucketName
field when the
transcription job was started with the StartTranscriptionJob
operation.
If the value is SERVICE_BUCKET
then the output is stored by
Amazon Transcribe and can be retrieved using the URI in the
GetTranscriptionJob
response's
TranscriptFileUri
field.
Constraints:
Allowed Values: CUSTOMER_BUCKET, SERVICE_BUCKET
Indicates the location of the output of the transcription job.
If the value is CUSTOMER_BUCKET
then the location is
the S3 bucket specified in the outputBucketName
field when the transcription job was started with the
StartTranscriptionJob
operation.
If the value is SERVICE_BUCKET
then the output is
stored by Amazon Transcribe and can be retrieved using the URI in
the GetTranscriptionJob
response's
TranscriptFileUri
field.
OutputLocationType
public void setOutputLocationType(java.lang.String outputLocationType)
Indicates the location of the output of the transcription job.
If the value is CUSTOMER_BUCKET
then the location is the S3
bucket specified in the outputBucketName
field when the
transcription job was started with the StartTranscriptionJob
operation.
If the value is SERVICE_BUCKET
then the output is stored by
Amazon Transcribe and can be retrieved using the URI in the
GetTranscriptionJob
response's
TranscriptFileUri
field.
Constraints:
Allowed Values: CUSTOMER_BUCKET, SERVICE_BUCKET
outputLocationType
- Indicates the location of the output of the transcription job.
If the value is CUSTOMER_BUCKET
then the location
is the S3 bucket specified in the
outputBucketName
field when the transcription job
was started with the StartTranscriptionJob
operation.
If the value is SERVICE_BUCKET
then the output is
stored by Amazon Transcribe and can be retrieved using the URI
in the GetTranscriptionJob
response's
TranscriptFileUri
field.
OutputLocationType
public TranscriptionJobSummary withOutputLocationType(java.lang.String outputLocationType)
Indicates the location of the output of the transcription job.
If the value is CUSTOMER_BUCKET
then the location is the S3
bucket specified in the outputBucketName
field when the
transcription job was started with the StartTranscriptionJob
operation.
If the value is SERVICE_BUCKET
then the output is stored by
Amazon Transcribe and can be retrieved using the URI in the
GetTranscriptionJob
response's
TranscriptFileUri
field.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: CUSTOMER_BUCKET, SERVICE_BUCKET
outputLocationType
- Indicates the location of the output of the transcription job.
If the value is CUSTOMER_BUCKET
then the location
is the S3 bucket specified in the
outputBucketName
field when the transcription job
was started with the StartTranscriptionJob
operation.
If the value is SERVICE_BUCKET
then the output is
stored by Amazon Transcribe and can be retrieved using the URI
in the GetTranscriptionJob
response's
TranscriptFileUri
field.
OutputLocationType
public void setOutputLocationType(OutputLocationType outputLocationType)
Indicates the location of the output of the transcription job.
If the value is CUSTOMER_BUCKET
then the location is the S3
bucket specified in the outputBucketName
field when the
transcription job was started with the StartTranscriptionJob
operation.
If the value is SERVICE_BUCKET
then the output is stored by
Amazon Transcribe and can be retrieved using the URI in the
GetTranscriptionJob
response's
TranscriptFileUri
field.
Constraints:
Allowed Values: CUSTOMER_BUCKET, SERVICE_BUCKET
outputLocationType
- Indicates the location of the output of the transcription job.
If the value is CUSTOMER_BUCKET
then the location
is the S3 bucket specified in the
outputBucketName
field when the transcription job
was started with the StartTranscriptionJob
operation.
If the value is SERVICE_BUCKET
then the output is
stored by Amazon Transcribe and can be retrieved using the URI
in the GetTranscriptionJob
response's
TranscriptFileUri
field.
OutputLocationType
public TranscriptionJobSummary withOutputLocationType(OutputLocationType outputLocationType)
Indicates the location of the output of the transcription job.
If the value is CUSTOMER_BUCKET
then the location is the S3
bucket specified in the outputBucketName
field when the
transcription job was started with the StartTranscriptionJob
operation.
If the value is SERVICE_BUCKET
then the output is stored by
Amazon Transcribe and can be retrieved using the URI in the
GetTranscriptionJob
response's
TranscriptFileUri
field.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: CUSTOMER_BUCKET, SERVICE_BUCKET
outputLocationType
- Indicates the location of the output of the transcription job.
If the value is CUSTOMER_BUCKET
then the location
is the S3 bucket specified in the
outputBucketName
field when the transcription job
was started with the StartTranscriptionJob
operation.
If the value is SERVICE_BUCKET
then the output is
stored by Amazon Transcribe and can be retrieved using the URI
in the GetTranscriptionJob
response's
TranscriptFileUri
field.
OutputLocationType
public ContentRedaction getContentRedaction()
The content redaction settings of the transcription job.
The content redaction settings of the transcription job.
public void setContentRedaction(ContentRedaction contentRedaction)
The content redaction settings of the transcription job.
contentRedaction
- The content redaction settings of the transcription job.
public TranscriptionJobSummary withContentRedaction(ContentRedaction contentRedaction)
The content redaction settings of the transcription job.
Returns a reference to this object so that method calls can be chained together.
contentRedaction
- The content redaction settings of the transcription job.
public ModelSettings getModelSettings()
The object used to call your custom language model to your transcription job.
The object used to call your custom language model to your transcription job.
public void setModelSettings(ModelSettings modelSettings)
The object used to call your custom language model to your transcription job.
modelSettings
- The object used to call your custom language model to your transcription job.
public TranscriptionJobSummary withModelSettings(ModelSettings modelSettings)
The object used to call your custom language model to your transcription job.
Returns a reference to this object so that method calls can be chained together.
modelSettings
- The object used to call your custom language model to your transcription job.
public java.lang.Boolean isIdentifyLanguage()
Whether automatic language identification was enabled for a transcription job.
Whether automatic language identification was enabled for a transcription job.
public java.lang.Boolean getIdentifyLanguage()
Whether automatic language identification was enabled for a transcription job.
Whether automatic language identification was enabled for a transcription job.
public void setIdentifyLanguage(java.lang.Boolean identifyLanguage)
Whether automatic language identification was enabled for a transcription job.
identifyLanguage
- Whether automatic language identification was enabled for a transcription job.
public TranscriptionJobSummary withIdentifyLanguage(java.lang.Boolean identifyLanguage)
Whether automatic language identification was enabled for a transcription job.
Returns a reference to this object so that method calls can be chained together.
identifyLanguage
- Whether automatic language identification was enabled for a transcription job.
public java.lang.Float getIdentifiedLanguageScore()
A value between zero and one that Amazon Transcribe assigned to the language it identified in the source audio. A higher score indicates that Amazon Transcribe is more confident in the language it identified.
A value between zero and one that Amazon Transcribe assigned to the language it identified in the source audio. A higher score indicates that Amazon Transcribe is more confident in the language it identified.
public void setIdentifiedLanguageScore(java.lang.Float identifiedLanguageScore)
A value between zero and one that Amazon Transcribe assigned to the language it identified in the source audio. A higher score indicates that Amazon Transcribe is more confident in the language it identified.
identifiedLanguageScore
- A value between zero and one that Amazon Transcribe assigned to the language it identified in the source audio. A higher score indicates that Amazon Transcribe is more confident in the language it identified.
public TranscriptionJobSummary withIdentifiedLanguageScore(java.lang.Float identifiedLanguageScore)
A value between zero and one that Amazon Transcribe assigned to the language it identified in the source audio. A higher score indicates that Amazon Transcribe is more confident in the language it identified.
Returns a reference to this object so that method calls can be chained together.
identifiedLanguageScore
- A value between zero and one that Amazon Transcribe assigned to the language it identified in the source audio. A higher score indicates that Amazon Transcribe is more confident in the language it identified.
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
Copyright © 2018 Amazon Web Services, Inc. All Rights Reserved.