Class Recording

java.lang.Object
software.amazon.awssdk.services.polly.model.Recording
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Recording.Builder,Recording>

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

A recording of the speaker whose voice you want to create. The recording specifies its audio format and its audio source.

See Also:
  • Method Details

    • format

      public final AudioFormat format()

      The audio format of the recording: wav, flac, ogg_vorbis, or mp3. The format must match the audio data.

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

      Returns:
      The audio format of the recording: wav, flac, ogg_vorbis, or mp3. The format must match the audio data.
      See Also:
    • formatAsString

      public final String formatAsString()

      The audio format of the recording: wav, flac, ogg_vorbis, or mp3. The format must match the audio data.

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

      Returns:
      The audio format of the recording: wav, flac, ogg_vorbis, or mp3. The format must match the audio data.
      See Also:
    • data

      public final RecordingData data()

      The audio source of the recording. Specify either an Amazon S3 object or the audio data.

      Returns:
      The audio source of the recording. Specify either an Amazon S3 object or the audio data.
    • toBuilder

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

      public static Recording.Builder builder()
    • serializableBuilderClass

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