Class SpeakerSummary

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

Contains a summary of information about a speaker.

See Also:

  • Method Details

    • createdAt

      public final Instant createdAt()

      A timestamp showing the speaker's creation time.

      Returns:
      A timestamp showing the speaker's creation time.

    • customerSpeakerId

      public final String customerSpeakerId()

      The client-provided identifier for the speaker.

      Returns:
      The client-provided identifier for the speaker.

    • domainId

      public final String domainId()

      The identifier of the domain that contains the speaker.

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

    • generatedSpeakerId

      public final String generatedSpeakerId()

      The service-generated identifier for the speaker.

      Returns:
      The service-generated identifier for the speaker.

    • lastAccessedAt

      public final Instant lastAccessedAt()

      The timestamp when the speaker was last accessed for enrollment, re-enrollment or a successful authentication. This timestamp is accurate to one hour.

      Returns:
      The timestamp when the speaker was last accessed for enrollment, re-enrollment or a successful authentication. This timestamp is accurate to one hour.

    • status

      public final SpeakerStatus status()

      The current status of the speaker.

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

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

    • statusAsString

      public final String statusAsString()

      The current status of the speaker.

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

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

    • updatedAt

      public final Instant updatedAt()

      A timestamp showing the speaker's last update.

      Returns:
      A timestamp showing the speaker's last update.

    • toBuilder

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

    • builder

      public static SpeakerSummary.Builder builder()

    • serializableBuilderClass

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