com.amazonaws.services.kinesisvideo.model

Class GetSignalingChannelEndpointRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kinesisvideo.model.GetSignalingChannelEndpointRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class GetSignalingChannelEndpointRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Provides an endpoint for the specified signaling channel to send and receive messages. This API uses the SingleMasterChannelEndpointConfiguration input parameter, which consists of the Protocols and Role properties.

Protocols is used to determine the communication mechanism. For example, specifying WSS as the protocol, results in this API producing a secure websocket endpoint, and specifying HTTPS as the protocol, results in this API generating an HTTPS endpoint.

Role determines the messaging permissions. A MASTER role results in this API generating an endpoint that a client can use to communicate with any of the viewers on the channel. A VIEWER role results in this API generating an endpoint that a client can use to communicate only with a MASTER.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GetSignalingChannelEndpointRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getChannelARN() The ARN of the signalling channel for which you want to get an endpoint.
SingleMasterChannelEndpointConfiguration	getSingleMasterChannelEndpointConfiguration() A structure containing the endpoint configuration for the SINGLE_MASTER channel type.
int	hashCode()
void	setChannelARN(java.lang.String channelARN) The ARN of the signalling channel for which you want to get an endpoint.
void	setSingleMasterChannelEndpointConfiguration(SingleMasterChannelEndpointConfiguration singleMasterChannelEndpointConfiguration) A structure containing the endpoint configuration for the SINGLE_MASTER channel type.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
GetSignalingChannelEndpointRequest	withChannelARN(java.lang.String channelARN) The ARN of the signalling channel for which you want to get an endpoint.
GetSignalingChannelEndpointRequest	withSingleMasterChannelEndpointConfiguration(SingleMasterChannelEndpointConfiguration singleMasterChannelEndpointConfiguration) A structure containing the endpoint configuration for the SINGLE_MASTER channel type.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetSignalingChannelEndpointRequest

public GetSignalingChannelEndpointRequest()

Method Detail

getChannelARN

public java.lang.String getChannelARN()

The ARN of the signalling channel for which you want to get an endpoint.

Constraints:
Length: 1 - 1024
Pattern: arn:aws:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+

Returns:

The ARN of the signalling channel for which you want to get an endpoint.

setChannelARN

public void setChannelARN(java.lang.String channelARN)

The ARN of the signalling channel for which you want to get an endpoint.

Constraints:
Length: 1 - 1024
Pattern: arn:aws:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+

Parameters:

channelARN -

The ARN of the signalling channel for which you want to get an endpoint.

withChannelARN

public GetSignalingChannelEndpointRequest withChannelARN(java.lang.String channelARN)

The ARN of the signalling channel for which you want to get an endpoint.

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

Constraints:
Length: 1 - 1024
Pattern: arn:aws:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+

Parameters:

channelARN -

The ARN of the signalling channel for which you want to get an endpoint.

Returns:

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

getSingleMasterChannelEndpointConfiguration

public SingleMasterChannelEndpointConfiguration getSingleMasterChannelEndpointConfiguration()

A structure containing the endpoint configuration for the SINGLE_MASTER channel type.

Returns:

A structure containing the endpoint configuration for the SINGLE_MASTER channel type.

setSingleMasterChannelEndpointConfiguration

public void setSingleMasterChannelEndpointConfiguration(SingleMasterChannelEndpointConfiguration singleMasterChannelEndpointConfiguration)

A structure containing the endpoint configuration for the SINGLE_MASTER channel type.

Parameters:

singleMasterChannelEndpointConfiguration -

A structure containing the endpoint configuration for the SINGLE_MASTER channel type.

withSingleMasterChannelEndpointConfiguration

public GetSignalingChannelEndpointRequest withSingleMasterChannelEndpointConfiguration(SingleMasterChannelEndpointConfiguration singleMasterChannelEndpointConfiguration)

A structure containing the endpoint configuration for the SINGLE_MASTER channel type.

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

Parameters:

singleMasterChannelEndpointConfiguration -

A structure containing the endpoint configuration for the SINGLE_MASTER channel type.

Returns:

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

toString

public java.lang.String toString()

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

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object