TranscriptionJobSummary (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.transcribe.model.TranscriptionJobSummary

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class TranscriptionJobSummary
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Provides a summary of information about a transcription job.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

TranscriptionJobSummary()

Constructors
Constructor and Description
`TranscriptionJobSummary()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TranscriptionJobSummary`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getCompletionTime()` A timestamp that shows when the job was completed.
`ContentRedaction`	`getContentRedaction()` The content redaction settings of the transcription job.
`Date`	`getCreationTime()` A timestamp that shows when the job was created.
`String`	`getFailureReason()` If the `TranscriptionJobStatus` field is `FAILED`, a description of the error.
`Float`	`getIdentifiedLanguageScore()` A value between zero and one that Amazon Transcribe assigned to the language it identified in the source audio.
`Boolean`	`getIdentifyLanguage()` Whether automatic language identification was enabled for a transcription job.
`String`	`getLanguageCode()` The language code for the input speech.
`ModelSettings`	`getModelSettings()`
`String`	`getOutputLocationType()` Indicates the location of the output of the transcription job.
`Date`	`getStartTime()` A timestamp that shows when the job started processing.
`String`	`getTranscriptionJobName()` The name of the transcription job.
`String`	`getTranscriptionJobStatus()` The status of the transcription job.
`int`	`hashCode()`
`Boolean`	`isIdentifyLanguage()` Whether automatic language identification was enabled for a transcription job.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCompletionTime(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(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`	`setIdentifiedLanguageScore(Float identifiedLanguageScore)` A value between zero and one that Amazon Transcribe assigned to the language it identified in the source audio.
`void`	`setIdentifyLanguage(Boolean identifyLanguage)` Whether automatic language identification was enabled for a transcription job.
`void`	`setLanguageCode(String languageCode)` The language code for the input speech.
`void`	`setModelSettings(ModelSettings modelSettings)`
`void`	`setOutputLocationType(String outputLocationType)` Indicates the location of the output of the transcription job.
`void`	`setStartTime(Date startTime)` A timestamp that shows when the job started processing.
`void`	`setTranscriptionJobName(String transcriptionJobName)` The name of the transcription job.
`void`	`setTranscriptionJobStatus(String transcriptionJobStatus)` The status of the transcription job.
`String`	`toString()` Returns a string representation of this object.
`TranscriptionJobSummary`	`withCompletionTime(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(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`	`withIdentifiedLanguageScore(Float identifiedLanguageScore)` A value between zero and one that Amazon Transcribe assigned to the language it identified in the source audio.
`TranscriptionJobSummary`	`withIdentifyLanguage(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(String languageCode)` The language code for the input speech.
`TranscriptionJobSummary`	`withModelSettings(ModelSettings modelSettings)`
`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`	`withStartTime(Date startTime)` A timestamp that shows when the job started processing.
`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
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - TranscriptionJobSummary
```
public TranscriptionJobSummary()
```
- Method Detail
  - setTranscriptionJobName
```
public void setTranscriptionJobName(String transcriptionJobName)
```
    The name of the transcription job.
    
    Parameters:
    
    transcriptionJobName - The name of the transcription job.
  - getTranscriptionJobName
```
public String getTranscriptionJobName()
```
    The name of the transcription job.
    
    Returns:
    
    The name of the transcription job.
  - withTranscriptionJobName
```
public TranscriptionJobSummary withTranscriptionJobName(String transcriptionJobName)
```
    The name of the transcription job.
    
    Parameters:
    
    transcriptionJobName - The name of the transcription job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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.
  - getCreationTime
```
public Date getCreationTime()
```
    A timestamp that shows when the job was created.
    
    Returns:
    
    A timestamp that shows when the job was created.
  - withCreationTime
```
public TranscriptionJobSummary withCreationTime(Date creationTime)
```
    A timestamp that shows when the job was created.
    
    Parameters:
    
    creationTime - A timestamp that shows when the job was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStartTime
```
public void setStartTime(Date startTime)
```
    A timestamp that shows when the job started processing.
    
    Parameters:
    
    startTime - A timestamp that shows when the job started processing.
  - getStartTime
```
public Date getStartTime()
```
    A timestamp that shows when the job started processing.
    
    Returns:
    
    A timestamp that shows when the job started processing.
  - withStartTime
```
public TranscriptionJobSummary withStartTime(Date startTime)
```
    A timestamp that shows when the job started processing.
    
    Parameters:
    
    startTime - A timestamp that shows when the job started processing.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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.
  - getCompletionTime
```
public Date getCompletionTime()
```
    A timestamp that shows when the job was completed.
    
    Returns:
    
    A timestamp that shows when the job was completed.
  - withCompletionTime
```
public TranscriptionJobSummary withCompletionTime(Date completionTime)
```
    A timestamp that shows when the job was completed.
    
    Parameters:
    
    completionTime - A timestamp that shows when the job was completed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLanguageCode
```
public void setLanguageCode(String languageCode)
```
    The language code for the input speech.
    
    Parameters:
    
    languageCode - The language code for the input speech.
    
    See Also:
    
    LanguageCode
  - getLanguageCode
```
public String getLanguageCode()
```
    The language code for the input speech.
    
    Returns:
    
    The language code for the input speech.
    
    See Also:
    
    LanguageCode
  - withLanguageCode
```
public TranscriptionJobSummary withLanguageCode(String languageCode)
```
    The language code for the input speech.
    
    Parameters:
    
    languageCode - The language code for the input speech.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LanguageCode
  - withLanguageCode
```
public TranscriptionJobSummary withLanguageCode(LanguageCode languageCode)
```
    The language code for the input speech.
    
    Parameters:
    
    languageCode - The language code for the input speech.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LanguageCode
  - 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.
    
    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
  - 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.
    
    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
  - 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.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    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.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TranscriptionJobStatus
  - 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.
  - 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.
  - withFailureReason
```
public TranscriptionJobSummary withFailureReason(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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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.
    
    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
  - 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.
    
    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
  - 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.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    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.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OutputLocationType
  - setContentRedaction
```
public void setContentRedaction(ContentRedaction contentRedaction)
```
    The content redaction settings of the transcription job.
    
    Parameters:
    
    contentRedaction - The content redaction settings of the transcription job.
  - getContentRedaction
```
public ContentRedaction getContentRedaction()
```
    The content redaction settings of the transcription job.
    
    Returns:
    
    The content redaction settings of the transcription job.
  - withContentRedaction
```
public TranscriptionJobSummary withContentRedaction(ContentRedaction contentRedaction)
```
    The content redaction settings of the transcription job.
    
    Parameters:
    
    contentRedaction - The content redaction settings of the transcription job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setModelSettings
```
public void setModelSettings(ModelSettings modelSettings)
```
    Parameters:
    
    modelSettings -
  - getModelSettings
```
public ModelSettings getModelSettings()
```
    Returns:
  - withModelSettings
```
public TranscriptionJobSummary withModelSettings(ModelSettings modelSettings)
```
    Parameters:
    
    modelSettings -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIdentifyLanguage
```
public void setIdentifyLanguage(Boolean identifyLanguage)
```
    Whether automatic language identification was enabled for a transcription job.
    
    Parameters:
    
    identifyLanguage - Whether automatic language identification was enabled for a transcription job.
  - getIdentifyLanguage
```
public Boolean getIdentifyLanguage()
```
    Whether automatic language identification was enabled for a transcription job.
    
    Returns:
    
    Whether automatic language identification was enabled for a transcription job.
  - withIdentifyLanguage
```
public TranscriptionJobSummary withIdentifyLanguage(Boolean identifyLanguage)
```
    Whether automatic language identification was enabled for a transcription job.
    
    Parameters:
    
    identifyLanguage - Whether automatic language identification was enabled for a transcription job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isIdentifyLanguage
```
public Boolean isIdentifyLanguage()
```
    Whether automatic language identification was enabled for a transcription job.
    
    Returns:
    
    Whether automatic language identification was enabled for a transcription job.
  - setIdentifiedLanguageScore
```
public void setIdentifiedLanguageScore(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.
    
    Parameters:
    
    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.
  - getIdentifiedLanguageScore
```
public 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.
    
    Returns:
    
    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.
  - withIdentifiedLanguageScore
```
public TranscriptionJobSummary withIdentifiedLanguageScore(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public TranscriptionJobSummary clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class TranscriptionJobSummary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TranscriptionJobSummary

Method Detail

setTranscriptionJobName

getTranscriptionJobName

withTranscriptionJobName

setCreationTime

getCreationTime

withCreationTime

setStartTime

getStartTime

withStartTime

setCompletionTime

getCompletionTime

withCompletionTime

setLanguageCode

getLanguageCode

withLanguageCode

withLanguageCode

setTranscriptionJobStatus

getTranscriptionJobStatus

withTranscriptionJobStatus

withTranscriptionJobStatus

setFailureReason

getFailureReason

withFailureReason

setOutputLocationType

getOutputLocationType

withOutputLocationType

withOutputLocationType

setContentRedaction

getContentRedaction

withContentRedaction

setModelSettings

getModelSettings

withModelSettings

setIdentifyLanguage

getIdentifyLanguage

withIdentifyLanguage

isIdentifyLanguage

setIdentifiedLanguageScore

getIdentifiedLanguageScore

withIdentifiedLanguageScore

toString

equals

hashCode

clone

marshall