Class SpeakerEnrollmentJobSummary

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

Contains a summary of information about a speaker enrollment job.

See Also:

  • Method Details

    • createdAt

      public final Instant createdAt()

      A timestamp of when of the speaker enrollment job was created.

      Returns:
      A timestamp of when of the speaker enrollment job was created.

    • domainId

      public final String domainId()

      The identifier of the domain that contains the speaker enrollment job.

      Returns:
      The identifier of the domain that contains the speaker enrollment job.

    • endedAt

      public final Instant endedAt()

      A timestamp of when the speaker enrollment job ended.

      Returns:
      A timestamp of when the speaker enrollment job ended.

    • failureDetails

      public final FailureDetails failureDetails()

      Contains details that are populated when an entire batch job fails. In cases of individual registration job failures, the batch job as a whole doesn't fail; it is completed with a JobStatus of COMPLETED_WITH_ERRORS. You can use the job output file to identify the individual registration requests that failed.

      Returns:
      Contains details that are populated when an entire batch job fails. In cases of individual registration job failures, the batch job as a whole doesn't fail; it is completed with a JobStatus of COMPLETED_WITH_ERRORS. You can use the job output file to identify the individual registration requests that failed.

    • jobId

      public final String jobId()

      The service-generated identifier for the speaker enrollment job.

      Returns:
      The service-generated identifier for the speaker enrollment job.

    • jobName

      public final String jobName()

      The client-provided name for the speaker enrollment job.

      Returns:
      The client-provided name for the speaker enrollment job.

    • jobProgress

      public final JobProgress jobProgress()

      Provides details regarding job progress. This field shows the completed percentage of enrollment requests listed in the input file.

      Returns:
      Provides details regarding job progress. This field shows the completed percentage of enrollment requests listed in the input file.

    • jobStatus

      public final SpeakerEnrollmentJobStatus jobStatus()

      The current status of the speaker enrollment job.

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

      Returns:
      The current status of the speaker enrollment job.
      See Also:

    • jobStatusAsString

      public final String jobStatusAsString()

      The current status of the speaker enrollment job.

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

      Returns:
      The current status of the speaker enrollment job.
      See Also:

    • toBuilder

      public SpeakerEnrollmentJobSummary.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<SpeakerEnrollmentJobSummary.Builder,SpeakerEnrollmentJobSummary>
      Returns:
      a builder for type T

    • builder

      public static SpeakerEnrollmentJobSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SpeakerEnrollmentJobSummary.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.