java.lang.Object
- software.amazon.awssdk.services.transcribe.model.TranscriptionJobSummary

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<TranscriptionJobSummary.Builder,TranscriptionJobSummary>

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

Provides detailed information about a specific transcription job.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface TranscriptionJobSummary.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static TranscriptionJobSummary.Builder`	`builder()`
`Instant`	`completionTime()`	The date and time the specified transcription job finished processing.
`ContentRedaction`	`contentRedaction()`	The content redaction settings of the transcription job.
`Instant`	`creationTime()`	The date and time the specified transcription job request was made.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`failureReason()`	If `TranscriptionJobStatus` is `FAILED`, `FailureReason` contains information about why the transcription job failed.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasLanguageCodes()`	For responses, this returns true if the service returned a value for the LanguageCodes property.
`boolean`	`hasToxicityDetection()`	For responses, this returns true if the service returned a value for the ToxicityDetection property.
`Float`	`identifiedLanguageScore()`	The confidence score associated with the language identified in your media file.
`Boolean`	`identifyLanguage()`	Indicates whether automatic language identification was enabled (`TRUE`) for the specified transcription job.
`Boolean`	`identifyMultipleLanguages()`	Indicates whether automatic multi-language identification was enabled (`TRUE`) for the specified transcription job.
`LanguageCode`	`languageCode()`	The language code used to create your transcription.
`String`	`languageCodeAsString()`	The language code used to create your transcription.
`List<LanguageCodeItem>`	`languageCodes()`	The language codes used to create your transcription job.
`ModelSettings`	`modelSettings()`	Returns the value of the ModelSettings property for this object.
`OutputLocationType`	`outputLocationType()`	Indicates where the specified transcription output is stored.
`String`	`outputLocationTypeAsString()`	Indicates where the specified transcription output is stored.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends TranscriptionJobSummary.Builder>`	`serializableBuilderClass()`
`Instant`	`startTime()`	The date and time your transcription job began processing.
`TranscriptionJobSummary.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`List<ToxicityDetectionSettings>`	`toxicityDetection()`	Indicates whether toxicity detection was enabled for the specified transcription job.
`String`	`transcriptionJobName()`	The name of the transcription job.
`TranscriptionJobStatus`	`transcriptionJobStatus()`	Provides the status of your transcription job.
`String`	`transcriptionJobStatusAsString()`	Provides the status of your 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 final String transcriptionJobName()
```
    The name of the transcription job. Job names are case sensitive and must be unique within an Amazon Web Services account.
    
    Returns:
    
    The name of the transcription job. Job names are case sensitive and must be unique within an Amazon Web Services account.
  - creationTime
```
public final Instant creationTime()
```
    The date and time the specified transcription job request was made.
    
    Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.
    
    Returns:
    
    The date and time the specified transcription job request was made.
    
    Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.
  - startTime
```
public final Instant startTime()
```
    The date and time your transcription job began processing.
    
    Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.
    
    Returns:
    
    The date and time your transcription job began processing.
    
    Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.
  - completionTime
```
public final Instant completionTime()
```
    The date and time the specified transcription job finished processing.
    
    Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started processing at 12:33 PM UTC-7 on May 4, 2022.
    
    Returns:
    
    The date and time the specified transcription job finished processing.
    
    Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started processing at 12:33 PM UTC-7 on May 4, 2022.
  - languageCode
```
public final LanguageCode languageCode()
```
    The language code used to create your transcription.
    
    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 used to create your transcription.
    
    See Also:
    
    LanguageCode
  - languageCodeAsString
```
public final String languageCodeAsString()
```
    The language code used to create your transcription.
    
    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 used to create your transcription.
    
    See Also:
    
    LanguageCode
  - transcriptionJobStatus
```
public final TranscriptionJobStatus transcriptionJobStatus()
```
    Provides the status of your transcription job.
    
    If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri (or RedactedTranscriptFileUri, if you requested transcript redaction). If the status is FAILED, FailureReason provides details on why your transcription job failed.
    
    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:
    
    Provides the status of your transcription job.
    
    If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri (or RedactedTranscriptFileUri, if you requested transcript redaction). If the status is FAILED, FailureReason provides details on why your transcription job failed.
    
    See Also:
    
    TranscriptionJobStatus
  - transcriptionJobStatusAsString
```
public final String transcriptionJobStatusAsString()
```
    Provides the status of your transcription job.
    
    If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri (or RedactedTranscriptFileUri, if you requested transcript redaction). If the status is FAILED, FailureReason provides details on why your transcription job failed.
    
    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:
    
    Provides the status of your transcription job.
    
    If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri (or RedactedTranscriptFileUri, if you requested transcript redaction). If the status is FAILED, FailureReason provides details on why your transcription job failed.
    
    See Also:
    
    TranscriptionJobStatus
  - failureReason
```
public final String failureReason()
```
    If TranscriptionJobStatus is FAILED, FailureReason contains information about why the transcription job failed. See also: Common Errors.
    
    Returns:
    
    If TranscriptionJobStatus is FAILED, FailureReason contains information about why the transcription job failed. See also: Common Errors.
  - outputLocationType
```
public final OutputLocationType outputLocationType()
```
    Indicates where the specified transcription output is stored.
    
    If the value is CUSTOMER_BUCKET, the location is the Amazon S3 bucket you specified using the OutputBucketName parameter in your request. If you also included OutputKey in your request, your output is located in the path you specified in your request.
    
    If the value is SERVICE_BUCKET, the location is a service-managed Amazon S3 bucket. To access a transcript stored in a service-managed bucket, use the URI shown in the TranscriptFileUri or RedactedTranscriptFileUri 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 where the specified transcription output is stored.
    
    If the value is CUSTOMER_BUCKET, the location is the Amazon S3 bucket you specified using the OutputBucketName parameter in your request. If you also included OutputKey in your request, your output is located in the path you specified in your request.
    
    If the value is SERVICE_BUCKET, the location is a service-managed Amazon S3 bucket. To access a transcript stored in a service-managed bucket, use the URI shown in the TranscriptFileUri or RedactedTranscriptFileUri field.
    
    See Also:
    
    OutputLocationType
  - outputLocationTypeAsString
```
public final String outputLocationTypeAsString()
```
    Indicates where the specified transcription output is stored.
    
    If the value is CUSTOMER_BUCKET, the location is the Amazon S3 bucket you specified using the OutputBucketName parameter in your request. If you also included OutputKey in your request, your output is located in the path you specified in your request.
    
    If the value is SERVICE_BUCKET, the location is a service-managed Amazon S3 bucket. To access a transcript stored in a service-managed bucket, use the URI shown in the TranscriptFileUri or RedactedTranscriptFileUri 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 where the specified transcription output is stored.
    
    If the value is CUSTOMER_BUCKET, the location is the Amazon S3 bucket you specified using the OutputBucketName parameter in your request. If you also included OutputKey in your request, your output is located in the path you specified in your request.
    
    If the value is SERVICE_BUCKET, the location is a service-managed Amazon S3 bucket. To access a transcript stored in a service-managed bucket, use the URI shown in the TranscriptFileUri or RedactedTranscriptFileUri field.
    
    See Also:
    
    OutputLocationType
  - contentRedaction
```
public final ContentRedaction contentRedaction()
```
    The content redaction settings of the transcription job.
    
    Returns:
    
    The content redaction settings of the transcription job.
  - modelSettings
```
public final ModelSettings modelSettings()
```
    Returns the value of the ModelSettings property for this object.
    
    Returns:
    
    The value of the ModelSettings property for this object.
  - identifyLanguage
```
public final Boolean identifyLanguage()
```
    Indicates whether automatic language identification was enabled (TRUE) for the specified transcription job.
    
    Returns:
    
    Indicates whether automatic language identification was enabled (TRUE) for the specified transcription job.
  - identifyMultipleLanguages
```
public final Boolean identifyMultipleLanguages()
```
    Indicates whether automatic multi-language identification was enabled (TRUE) for the specified transcription job.
    
    Returns:
    
    Indicates whether automatic multi-language identification was enabled (TRUE) for the specified transcription job.
  - identifiedLanguageScore
```
public final Float identifiedLanguageScore()
```
    The confidence score associated with the language identified in your media file.
    
    Confidence scores are values between 0 and 1; a larger value indicates a higher probability that the identified language correctly matches the language spoken in your media.
    
    Returns:
    
    The confidence score associated with the language identified in your media file.
    
    Confidence scores are values between 0 and 1; a larger value indicates a higher probability that the identified language correctly matches the language spoken in your media.
  - hasLanguageCodes
```
public final boolean hasLanguageCodes()
```
    For responses, this returns true if the service returned a value for the LanguageCodes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - languageCodes
```
public final List<LanguageCodeItem> languageCodes()
```
    The language codes used to create your transcription job. This parameter is used with multi-language identification. For single-language identification, the singular version of this parameter, LanguageCode, is present.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLanguageCodes() method.
    
    Returns:
    
    The language codes used to create your transcription job. This parameter is used with multi-language identification. For single-language identification, the singular version of this parameter, LanguageCode, is present.
  - hasToxicityDetection
```
public final boolean hasToxicityDetection()
```
    For responses, this returns true if the service returned a value for the ToxicityDetection property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - toxicityDetection
```
public final List<ToxicityDetectionSettings> toxicityDetection()
```
    Indicates whether toxicity detection was enabled for the specified transcription job.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasToxicityDetection() method.
    
    Returns:
    
    Indicates whether toxicity detection was enabled for the specified transcription job.
  - 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 final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class TranscriptionJobSummary

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

transcriptionJobName

creationTime

startTime

completionTime

languageCode

languageCodeAsString

transcriptionJobStatus

transcriptionJobStatusAsString

failureReason

outputLocationType

outputLocationTypeAsString

contentRedaction

modelSettings

identifyLanguage

identifyMultipleLanguages

identifiedLanguageScore

hasLanguageCodes

languageCodes

hasToxicityDetection

toxicityDetection

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields