Package software.amazon.awssdk.services.kinesisvideo.model

Class ChannelInfo

java.lang.Object

software.amazon.awssdk.services.kinesisvideo.model.ChannelInfo

All Implemented Interfaces:

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

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

A structure that encapsulates a signaling channel's metadata and properties.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ChannelInfo.Builder

Method Summary

Modifier and Type	Method	Description
static ChannelInfo.Builder	builder()
String	channelARN()	The Amazon Resource Name (ARN) of the signaling channel.
String	channelName()	The name of the signaling channel.
Status	channelStatus()	Current status of the signaling channel.
String	channelStatusAsString()	Current status of the signaling channel.
ChannelType	channelType()	The type of the signaling channel.
String	channelTypeAsString()	The type of the signaling channel.
Instant	creationTime()	The time at which the signaling channel was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ChannelInfo.Builder>	serializableBuilderClass()
SingleMasterConfiguration	singleMasterConfiguration()	A structure that contains the configuration for the SINGLE_MASTER channel type.
ChannelInfo.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	version()	The current version of the signaling channel.

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

channelName

public final String channelName()

The name of the signaling channel.

Returns:

The name of the signaling channel.

channelARN

public final String channelARN()

The Amazon Resource Name (ARN) of the signaling channel.

Returns:

The Amazon Resource Name (ARN) of the signaling channel.

channelType

public final ChannelType channelType()

The type of the signaling channel.

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

Returns:

The type of the signaling channel.

See Also:

ChannelType

channelTypeAsString

public final String channelTypeAsString()

The type of the signaling channel.

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

Returns:

The type of the signaling channel.

See Also:

ChannelType

channelStatus

public final Status channelStatus()

Current status of the signaling channel.

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

Returns:

Current status of the signaling channel.

See Also:

Status

channelStatusAsString

public final String channelStatusAsString()

Current status of the signaling channel.

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

Returns:

Current status of the signaling channel.

See Also:

Status

creationTime

public final Instant creationTime()

The time at which the signaling channel was created.

Returns:

The time at which the signaling channel was created.

singleMasterConfiguration

public final SingleMasterConfiguration singleMasterConfiguration()

A structure that contains the configuration for the SINGLE_MASTER channel type.

Returns:

A structure that contains the configuration for the SINGLE_MASTER channel type.

version

public final String version()

The current version of the signaling channel.

Returns:

The current version of the signaling channel.

toBuilder

public ChannelInfo.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ChannelInfo.Builder,ChannelInfo>

builder

public static ChannelInfo.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo