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

Class SingleMasterChannelEndpointConfiguration

java.lang.Object

software.amazon.awssdk.services.kinesisvideo.model.SingleMasterChannelEndpointConfiguration

All Implemented Interfaces:

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

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

An object that contains the endpoint configuration for the SINGLE_MASTER channel type.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SingleMasterChannelEndpointConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static SingleMasterChannelEndpointConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasProtocols()	For responses, this returns true if the service returned a value for the Protocols property.
List<ChannelProtocol>	protocols()	This property is used to determine the nature of communication over this SINGLE_MASTER signaling channel.
List<String>	protocolsAsStrings()	This property is used to determine the nature of communication over this SINGLE_MASTER signaling channel.
ChannelRole	role()	This property is used to determine messaging permissions in this SINGLE_MASTER signaling channel.
String	roleAsString()	This property is used to determine messaging permissions in this SINGLE_MASTER signaling channel.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends SingleMasterChannelEndpointConfiguration.Builder>	serializableBuilderClass()
SingleMasterChannelEndpointConfiguration.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

protocols

public final List<ChannelProtocol> protocols()

This property is used to determine the nature of communication over this SINGLE_MASTER signaling channel. If WSS is specified, this API returns a websocket endpoint. If HTTPS is specified, this API returns an HTTPS endpoint.

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 hasProtocols() method.

Returns:

This property is used to determine the nature of communication over this SINGLE_MASTER signaling channel. If WSS is specified, this API returns a websocket endpoint. If HTTPS is specified, this API returns an HTTPS endpoint.

hasProtocols

public final boolean hasProtocols()

For responses, this returns true if the service returned a value for the Protocols 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.

protocolsAsStrings

public final List<String> protocolsAsStrings()

This property is used to determine the nature of communication over this SINGLE_MASTER signaling channel. If WSS is specified, this API returns a websocket endpoint. If HTTPS is specified, this API returns an HTTPS endpoint.

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 hasProtocols() method.

Returns:

This property is used to determine the nature of communication over this SINGLE_MASTER signaling channel. If WSS is specified, this API returns a websocket endpoint. If HTTPS is specified, this API returns an HTTPS endpoint.

role

public final ChannelRole role()

This property is used to determine messaging permissions in this SINGLE_MASTER signaling channel. If MASTER is specified, this API returns an endpoint that a client can use to receive offers from and send answers to any of the viewers on this signaling channel. If VIEWER is specified, this API returns an endpoint that a client can use only to send offers to another MASTER client on this signaling channel.

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

Returns:

This property is used to determine messaging permissions in this SINGLE_MASTER signaling channel. If MASTER is specified, this API returns an endpoint that a client can use to receive offers from and send answers to any of the viewers on this signaling channel. If VIEWER is specified, this API returns an endpoint that a client can use only to send offers to another MASTER client on this signaling channel.

See Also:

ChannelRole

roleAsString

public final String roleAsString()

This property is used to determine messaging permissions in this SINGLE_MASTER signaling channel. If MASTER is specified, this API returns an endpoint that a client can use to receive offers from and send answers to any of the viewers on this signaling channel. If VIEWER is specified, this API returns an endpoint that a client can use only to send offers to another MASTER client on this signaling channel.

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

Returns:

This property is used to determine messaging permissions in this SINGLE_MASTER signaling channel. If MASTER is specified, this API returns an endpoint that a client can use to receive offers from and send answers to any of the viewers on this signaling channel. If VIEWER is specified, this API returns an endpoint that a client can use only to send offers to another MASTER client on this signaling channel.

See Also:

ChannelRole

toBuilder

public SingleMasterChannelEndpointConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SingleMasterChannelEndpointConfiguration.Builder,SingleMasterChannelEndpointConfiguration>

builder

public static SingleMasterChannelEndpointConfiguration.Builder builder()

serializableBuilderClass

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