com.amazonaws.services.transcribe.model

Class TranscriptionJobSummary

java.lang.Object

com.amazonaws.services.transcribe.model.TranscriptionJobSummary

All Implemented Interfaces:

Serializable

public class TranscriptionJobSummary
extends Object
implements Serializable

Provides a summary of information about a transcription job. .

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TranscriptionJobSummary()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Date	getCompletionTime() A timestamp that shows when the job was completed.
Date	getCreationTime() A timestamp that shows when the job was created.
String	getFailureReason() If the TranscriptionJobStatus field is FAILED, a description of the error.
String	getLanguageCode() The language code for the input speech.
String	getOutputLocationType() Indicates the location of the output of the transcription job.
String	getTranscriptionJobName() The name of the transcription job.
String	getTranscriptionJobStatus() The status of the transcription job.
int	hashCode()
void	setCompletionTime(Date completionTime) A timestamp that shows when the job was completed.
void	setCreationTime(Date creationTime) A timestamp that shows when the job was created.
void	setFailureReason(String failureReason) If the TranscriptionJobStatus field is FAILED, a description of the error.
void	setLanguageCode(LanguageCode languageCode) The language code for the input speech.
void	setLanguageCode(String languageCode) The language code for the input speech.
void	setOutputLocationType(OutputLocationType outputLocationType) Indicates the location of the output of the transcription job.
void	setOutputLocationType(String outputLocationType) Indicates the location of the output of the transcription job.
void	setTranscriptionJobName(String transcriptionJobName) The name of the transcription job.
void	setTranscriptionJobStatus(String transcriptionJobStatus) The status of the transcription job.
void	setTranscriptionJobStatus(TranscriptionJobStatus transcriptionJobStatus) The status of the transcription job.
String	toString() Returns a string representation of this object; useful for testing and debugging.
TranscriptionJobSummary	withCompletionTime(Date completionTime) A timestamp that shows when the job was completed.
TranscriptionJobSummary	withCreationTime(Date creationTime) A timestamp that shows when the job was created.
TranscriptionJobSummary	withFailureReason(String failureReason) If the TranscriptionJobStatus field is FAILED, a description of the error.
TranscriptionJobSummary	withLanguageCode(LanguageCode languageCode) The language code for the input speech.
TranscriptionJobSummary	withLanguageCode(String languageCode) The language code for the input speech.
TranscriptionJobSummary	withOutputLocationType(OutputLocationType outputLocationType) Indicates the location of the output of the transcription job.
TranscriptionJobSummary	withOutputLocationType(String outputLocationType) Indicates the location of the output of the transcription job.
TranscriptionJobSummary	withTranscriptionJobName(String transcriptionJobName) The name of the transcription job.
TranscriptionJobSummary	withTranscriptionJobStatus(String transcriptionJobStatus) The status of the transcription job.
TranscriptionJobSummary	withTranscriptionJobStatus(TranscriptionJobStatus transcriptionJobStatus) The status of the transcription job.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TranscriptionJobSummary

public TranscriptionJobSummary()

Method Detail

getTranscriptionJobName

public String getTranscriptionJobName()

The name of the transcription job.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

Returns:

The name of the transcription job.

setTranscriptionJobName

public void setTranscriptionJobName(String transcriptionJobName)

The name of the transcription job.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

Parameters:

transcriptionJobName -

The name of the transcription job.

withTranscriptionJobName

public TranscriptionJobSummary withTranscriptionJobName(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._-]+

Parameters:

transcriptionJobName -

The name of the transcription job.

Returns:

A reference to this updated object so that method calls can be chained together.

getCreationTime

public Date getCreationTime()

A timestamp that shows when the job was created.

Returns:

A timestamp that shows when the job was created.

setCreationTime

public void setCreationTime(Date creationTime)

A timestamp that shows when the job was created.

Parameters:

creationTime -

A timestamp that shows when the job was created.

withCreationTime

public TranscriptionJobSummary withCreationTime(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.

Parameters:

creationTime -

A timestamp that shows when the job was created.

Returns:

A reference to this updated object so that method calls can be chained together.

getCompletionTime

public Date getCompletionTime()

A timestamp that shows when the job was completed.

Returns:

A timestamp that shows when the job was completed.

setCompletionTime

public void setCompletionTime(Date completionTime)

A timestamp that shows when the job was completed.

Parameters:

completionTime -

A timestamp that shows when the job was completed.

withCompletionTime

public TranscriptionJobSummary withCompletionTime(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.

Parameters:

completionTime -

A timestamp that shows when the job was completed.

Returns:

A reference to this updated object so that method calls can be chained together.

getLanguageCode

public String getLanguageCode()

The language code for the input speech.

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 input speech.

See Also:

LanguageCode

setLanguageCode

public void setLanguageCode(String languageCode)

The language code for the input speech.

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 input speech.

See Also:

LanguageCode

withLanguageCode

public TranscriptionJobSummary withLanguageCode(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: 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 input speech.

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 input speech.

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 input speech.

See Also:

LanguageCode

withLanguageCode

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: 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 input speech.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

LanguageCode

getTranscriptionJobStatus

public 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: IN_PROGRESS, FAILED, COMPLETED

Returns:

The status of the transcription job. When the status is COMPLETED, use the GetTranscriptionJob operation to get the results of the transcription.

See Also:

TranscriptionJobStatus

setTranscriptionJobStatus

public void setTranscriptionJobStatus(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: IN_PROGRESS, FAILED, COMPLETED

Parameters:

transcriptionJobStatus -

The status of the transcription job. When the status is COMPLETED, use the GetTranscriptionJob operation to get the results of the transcription.

See Also:

TranscriptionJobStatus

withTranscriptionJobStatus

public TranscriptionJobSummary withTranscriptionJobStatus(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: IN_PROGRESS, FAILED, COMPLETED

Parameters:

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 updated object so that method calls can be chained together.

See Also:

TranscriptionJobStatus

setTranscriptionJobStatus

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: IN_PROGRESS, FAILED, COMPLETED

Parameters:

transcriptionJobStatus -

The status of the transcription job. When the status is COMPLETED, use the GetTranscriptionJob operation to get the results of the transcription.

See Also:

TranscriptionJobStatus

withTranscriptionJobStatus

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: IN_PROGRESS, FAILED, COMPLETED

Parameters:

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 updated object so that method calls can be chained together.

See Also:

TranscriptionJobStatus

getFailureReason

public String getFailureReason()

If the TranscriptionJobStatus field is FAILED, a description of the error.

Returns:

If the TranscriptionJobStatus field is FAILED, a description of the error.

setFailureReason

public void setFailureReason(String failureReason)

If the TranscriptionJobStatus field is FAILED, a description of the error.

Parameters:

failureReason -

If the TranscriptionJobStatus field is FAILED, a description of the error.

withFailureReason

public TranscriptionJobSummary withFailureReason(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.

Parameters:

failureReason -

If the TranscriptionJobStatus field is FAILED, a description of the error.

Returns:

A reference to this updated object so that method calls can be chained together.

getOutputLocationType

public 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

Returns:

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.

See Also:

OutputLocationType

setOutputLocationType

public void setOutputLocationType(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

Parameters:

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.

See Also:

OutputLocationType

withOutputLocationType

public TranscriptionJobSummary withOutputLocationType(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

Parameters:

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 updated object so that method calls can be chained together.

See Also:

OutputLocationType

setOutputLocationType

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

Parameters:

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.

See Also:

OutputLocationType

withOutputLocationType

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

Parameters:

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 updated object so that method calls can be chained together.

See Also:

OutputLocationType

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