com.amazonaws.services.kinesisvideo.model

Class SingleMasterChannelEndpointConfiguration

java.lang.Object

com.amazonaws.services.kinesisvideo.model.SingleMasterChannelEndpointConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SingleMasterChannelEndpointConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
SingleMasterChannelEndpointConfiguration()

Method Summary

Modifier and Type	Method and Description
SingleMasterChannelEndpointConfiguration	clone()
boolean	equals(Object obj)
List<String>	getProtocols() This property is used to determine the nature of communication over this SINGLE_MASTER signaling channel.
String	getRole() This property is used to determine messaging permissions in this SINGLE_MASTER signaling channel.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setProtocols(Collection<String> protocols) This property is used to determine the nature of communication over this SINGLE_MASTER signaling channel.
void	setRole(String role) This property is used to determine messaging permissions in this SINGLE_MASTER signaling channel.
String	toString() Returns a string representation of this object.
SingleMasterChannelEndpointConfiguration	withProtocols(ChannelProtocol... protocols) This property is used to determine the nature of communication over this SINGLE_MASTER signaling channel.
SingleMasterChannelEndpointConfiguration	withProtocols(Collection<String> protocols) This property is used to determine the nature of communication over this SINGLE_MASTER signaling channel.
SingleMasterChannelEndpointConfiguration	withProtocols(String... protocols) This property is used to determine the nature of communication over this SINGLE_MASTER signaling channel.
SingleMasterChannelEndpointConfiguration	withRole(ChannelRole role) This property is used to determine messaging permissions in this SINGLE_MASTER signaling channel.
SingleMasterChannelEndpointConfiguration	withRole(String role) This property is used to determine messaging permissions in this SINGLE_MASTER signaling channel.

Methods inherited from class java.lang.Object

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

Constructor Detail

SingleMasterChannelEndpointConfiguration

public SingleMasterChannelEndpointConfiguration()

Method Detail

getProtocols

public List<String> getProtocols()

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.

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.

See Also:

ChannelProtocol

setProtocols

public void setProtocols(Collection<String> 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.

Parameters:

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.

See Also:

ChannelProtocol

withProtocols

public SingleMasterChannelEndpointConfiguration withProtocols(String... 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.

NOTE: This method appends the values to the existing list (if any). Use setProtocols(java.util.Collection) or withProtocols(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ChannelProtocol

withProtocols

public SingleMasterChannelEndpointConfiguration withProtocols(Collection<String> 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ChannelProtocol

withProtocols

public SingleMasterChannelEndpointConfiguration withProtocols(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ChannelProtocol

setRole

public void setRole(String 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.

Parameters:

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.

See Also:

ChannelRole

getRole

public String getRole()

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.

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

withRole

public SingleMasterChannelEndpointConfiguration withRole(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ChannelRole

withRole

public SingleMasterChannelEndpointConfiguration withRole(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ChannelRole

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public SingleMasterChannelEndpointConfiguration clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo