software.amazon.awssdk.services.transcribe.model

Class TranscriptionJobSummary

java.lang.Object

software.amazon.awssdk.services.transcribe.model.TranscriptionJobSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<TranscriptionJobSummary.Builder,TranscriptionJobSummary>

@Generated(value="software.amazon.awssdk:codegen")
public final class TranscriptionJobSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<TranscriptionJobSummary.Builder,TranscriptionJobSummary>

Provides a summary of information about a transcription job.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TranscriptionJobSummary.Builder

Method Summary

Modifier and Type	Method and Description
static TranscriptionJobSummary.Builder	builder()
Instant	completionTime() A timestamp that shows when the job was completed.
ContentRedaction	contentRedaction() The content redaction settings of the transcription job.
Instant	creationTime() A timestamp that shows when the job was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	failureReason() If the TranscriptionJobStatus field is FAILED, a description of the error.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Float	identifiedLanguageScore() A value between zero and one that Amazon Transcribe assigned to the language it identified in the source audio.
Boolean	identifyLanguage() Whether automatic language identification was enabled for a transcription job.
LanguageCode	languageCode() The language code for the input speech.
String	languageCodeAsString() The language code for the input speech.
ModelSettings	modelSettings() Returns the value of the ModelSettings property for this object.
OutputLocationType	outputLocationType() Indicates the location of the output of the transcription job.
String	outputLocationTypeAsString() Indicates the location of the output of the transcription job.
List<SdkField<?>>	sdkFields()
static Class<? extends TranscriptionJobSummary.Builder>	serializableBuilderClass()
Instant	startTime() A timestamp that shows when the job started processing.
TranscriptionJobSummary.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	transcriptionJobName() The name of the transcription job.
TranscriptionJobStatus	transcriptionJobStatus() The status of the transcription job.
String	transcriptionJobStatusAsString() The status of the transcription job.

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 transcription job.

Returns:

The name of the transcription job.

creationTime

public Instant creationTime()

A timestamp that shows when the job was created.

Returns:

A timestamp that shows when the job was created.

startTime

public Instant startTime()

A timestamp that shows when the job started processing.

Returns:

A timestamp that shows when the job started processing.

completionTime

public Instant completionTime()

A timestamp that shows when the job was completed.

Returns:

A timestamp that shows when the job was completed.

languageCode

public 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().

Returns:

The language code for the input speech.

See Also:

LanguageCode

languageCodeAsString

public 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().

Returns:

The language code for the input speech.

See Also:

LanguageCode

transcriptionJobStatus

public TranscriptionJobStatus transcriptionJobStatus()

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

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().

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

transcriptionJobStatusAsString

public String transcriptionJobStatusAsString()

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

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().

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

failureReason

public String failureReason()

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

Returns:

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

outputLocationType

public 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.

If the service returns an enum value that is not available in the current SDK version, outputLocationType will return OutputLocationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from outputLocationTypeAsString().

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

outputLocationTypeAsString

public String outputLocationTypeAsString()

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.

If the service returns an enum value that is not available in the current SDK version, outputLocationType will return OutputLocationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from outputLocationTypeAsString().

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

contentRedaction

public ContentRedaction contentRedaction()

The content redaction settings of the transcription job.

Returns:

The content redaction settings of the transcription job.

modelSettings

public ModelSettings modelSettings()

Returns the value of the ModelSettings property for this object.

Returns:

The value of the ModelSettings property for this object.

identifyLanguage

public Boolean identifyLanguage()

Whether automatic language identification was enabled for a transcription job.

Returns:

Whether automatic language identification was enabled for a transcription job.

identifiedLanguageScore

public 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 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.

toBuilder

public TranscriptionJobSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TranscriptionJobSummary.Builder,TranscriptionJobSummary>

builder

public static TranscriptionJobSummary.Builder builder()

serializableBuilderClass

public static Class<? extends TranscriptionJobSummary.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo