Package software.amazon.awssdk.services.transcribe.model

Class CallAnalyticsJobSummary

java.lang.Object
software.amazon.awssdk.services.transcribe.model.CallAnalyticsJobSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<CallAnalyticsJobSummary.Builder,CallAnalyticsJobSummary>
@Generated("software.amazon.awssdk:codegen") public final class CallAnalyticsJobSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CallAnalyticsJobSummary.Builder,CallAnalyticsJobSummary>

Provides detailed information about a specific Call Analytics job.

See Also:

  • Method Details

    • callAnalyticsJobName

      public final String callAnalyticsJobName()

      The name of the Call Analytics job. Job names are case sensitive and must be unique within an Amazon Web Services account.

      Returns:
      The name of the Call Analytics 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 Call Analytics 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 Call Analytics 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 Call Analytics 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 Call Analytics 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 Call Analytics 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 Call Analytics 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 Call Analytics 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 Call Analytics transcription.
      See Also:

    • languageCodeAsString

      public final String languageCodeAsString()

      The language code used to create your Call Analytics 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 Call Analytics transcription.
      See Also:

    • callAnalyticsJobStatus

      public final CallAnalyticsJobStatus callAnalyticsJobStatus()

      Provides the status of your Call Analytics 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, callAnalyticsJobStatus will return CallAnalyticsJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from callAnalyticsJobStatusAsString().

      Returns:
      Provides the status of your Call Analytics 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:

    • callAnalyticsJobStatusAsString

      public final String callAnalyticsJobStatusAsString()

      Provides the status of your Call Analytics 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, callAnalyticsJobStatus will return CallAnalyticsJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from callAnalyticsJobStatusAsString().

      Returns:
      Provides the status of your Call Analytics 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:

    • callAnalyticsJobDetails

      public final CallAnalyticsJobDetails callAnalyticsJobDetails()

      Provides detailed information about a call analytics job, including information about skipped analytics features.

      Returns:
      Provides detailed information about a call analytics job, including information about skipped analytics features.

    • failureReason

      public final String failureReason()

      If CallAnalyticsJobStatus is FAILED, FailureReason contains information about why the Call Analytics job failed. See also: Common Errors.

      Returns:
      If CallAnalyticsJobStatus is FAILED, FailureReason contains information about why the Call Analytics job failed. See also: Common Errors.

    • toBuilder

      public CallAnalyticsJobSummary.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CallAnalyticsJobSummary.Builder,CallAnalyticsJobSummary>
      Returns:
      a builder for type T

    • builder

      public static CallAnalyticsJobSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CallAnalyticsJobSummary.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.