com.amazonaws.services.kinesisvideo.model

Class SingleMasterChannelEndpointConfiguration

java.lang.Object

com.amazonaws.services.kinesisvideo.model.SingleMasterChannelEndpointConfiguration

All Implemented Interfaces:

Serializable

public class SingleMasterChannelEndpointConfiguration
extends Object
implements Serializable

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SingleMasterChannelEndpointConfiguration()

Method Summary

Modifier and Type	Method and Description
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	setProtocols(Collection<String> protocols) This property is used to determine the nature of communication over this SINGLE_MASTER signaling channel.
void	setRole(ChannelRole role) This property is used to determine messaging permissions in 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; useful for testing and debugging.
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

clone, 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.

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.

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.

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

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:

A reference to this updated object so that method calls can be chained together.

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.

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

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:

A reference to this updated object so that method calls can be chained together.

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.

Constraints:
Allowed Values: MASTER, VIEWER

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

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.

Constraints:
Allowed Values: MASTER, VIEWER

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

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.

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

Constraints:
Allowed Values: MASTER, VIEWER

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:

A reference to this updated object so that method calls can be chained together.

See Also:

ChannelRole

setRole

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

Constraints:
Allowed Values: MASTER, VIEWER

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

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.

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

Constraints:
Allowed Values: MASTER, VIEWER

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:

A reference to this updated object so that method calls can be chained together.

See Also:

ChannelRole

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object