Class ChannelDefinition

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

Makes it possible to specify which speaker is on which audio channel. For example, if your agent is the first participant to speak, you would set ChannelId to 0 (to indicate the first channel) and ParticipantRole to AGENT (to indicate that it's the agent speaking).

See Also:

  • Method Details

    • channelId

      public final Integer channelId()

      Specify the audio channel you want to define.

      Returns:
      Specify the audio channel you want to define.

    • participantRole

      public final ParticipantRole participantRole()

      Specify the speaker you want to define. Omitting this parameter is equivalent to specifying both participants.

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

      Returns:
      Specify the speaker you want to define. Omitting this parameter is equivalent to specifying both participants.
      See Also:

    • participantRoleAsString

      public final String participantRoleAsString()

      Specify the speaker you want to define. Omitting this parameter is equivalent to specifying both participants.

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

      Returns:
      Specify the speaker you want to define. Omitting this parameter is equivalent to specifying both participants.
      See Also:

    • toBuilder

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

    • builder

      public static ChannelDefinition.Builder builder()

    • serializableBuilderClass

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