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

Class CreateSignalingChannelRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.kinesisvideo.model.KinesisVideoRequest

software.amazon.awssdk.services.kinesisvideo.model.CreateSignalingChannelRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateSignalingChannelRequest.Builder,CreateSignalingChannelRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateSignalingChannelRequest
extends KinesisVideoRequest
implements ToCopyableBuilder<CreateSignalingChannelRequest.Builder,CreateSignalingChannelRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateSignalingChannelRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateSignalingChannelRequest.Builder	builder()
String	channelName()	A name for the signaling channel that you are creating.
ChannelType	channelType()	A type of the signaling channel that you are creating.
String	channelTypeAsString()	A type of the signaling channel that you are creating.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateSignalingChannelRequest.Builder>	serializableBuilderClass()
SingleMasterConfiguration	singleMasterConfiguration()	A structure containing the configuration for the SINGLE_MASTER channel type.
List<Tag>	tags()	A set of tags (key-value pairs) that you want to associate with this channel.
CreateSignalingChannelRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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()

A name for the signaling channel that you are creating. It must be unique for each Amazon Web Services account and Amazon Web Services Region.

Returns:

A name for the signaling channel that you are creating. It must be unique for each Amazon Web Services account and Amazon Web Services Region.

channelType

public final ChannelType channelType()

A type of the signaling channel that you are creating. Currently, SINGLE_MASTER is the only supported channel type.

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:

A type of the signaling channel that you are creating. Currently, SINGLE_MASTER is the only supported channel type.

See Also:

ChannelType

channelTypeAsString

public final String channelTypeAsString()

A type of the signaling channel that you are creating. Currently, SINGLE_MASTER is the only supported channel type.

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:

A type of the signaling channel that you are creating. Currently, SINGLE_MASTER is the only supported channel type.

See Also:

ChannelType

singleMasterConfiguration

public final SingleMasterConfiguration singleMasterConfiguration()

A structure containing the configuration for the SINGLE_MASTER channel type.

Returns:

A structure containing the configuration for the SINGLE_MASTER channel type.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final List<Tag> tags()

A set of tags (key-value pairs) that you want to associate with this channel.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

A set of tags (key-value pairs) that you want to associate with this channel.

toBuilder

public CreateSignalingChannelRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateSignalingChannelRequest.Builder,CreateSignalingChannelRequest>

Specified by:

toBuilder in class KinesisVideoRequest

builder

public static CreateSignalingChannelRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateSignalingChannelRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

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