software.amazon.awssdk.services.chimesdkmediapipelines.model

Class ChannelDefinition

java.lang.Object

software.amazon.awssdk.services.chimesdkmediapipelines.model.ChannelDefinition

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ChannelDefinition.Builder,ChannelDefinition>

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

Defines an audio channel in a Kinesis video stream.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ChannelDefinition.Builder

Method Summary

Modifier and Type	Method and Description
static ChannelDefinition.Builder	builder()
Integer	channelId() The channel ID.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
ParticipantRole	participantRole() Specifies whether the audio in a channel belongs to the AGENT or CUSTOMER.
String	participantRoleAsString() Specifies whether the audio in a channel belongs to the AGENT or CUSTOMER.
List<SdkField<?>>	sdkFields()
static Class<? extends ChannelDefinition.Builder>	serializableBuilderClass()
ChannelDefinition.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

channelId

public final Integer channelId()

The channel ID.

Returns:

The channel ID.

participantRole

public final ParticipantRole participantRole()

Specifies whether the audio in a channel belongs to the AGENT or CUSTOMER.

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:

Specifies whether the audio in a channel belongs to the AGENT or CUSTOMER.

See Also:

ParticipantRole

participantRoleAsString

public final String participantRoleAsString()

Specifies whether the audio in a channel belongs to the AGENT or CUSTOMER.

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:

Specifies whether the audio in a channel belongs to the AGENT or CUSTOMER.

See Also:

ParticipantRole

toBuilder

public ChannelDefinition.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ChannelDefinition.Builder,ChannelDefinition>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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