com.amazonaws.services.kinesisvideosignaling.model

Class GetIceServerConfigRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kinesisvideosignaling.model.GetIceServerConfigRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class GetIceServerConfigRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Gets the Interactive Connectivity Establishment (ICE) server configuration information, including URIs, username, and password which can be used to configure the WebRTC connection. The ICE component uses this configuration information to setup the WebRTC connection, including authenticating with the Traversal Using Relays around NAT (TURN) relay server.

TURN is a protocol that is used to improve the connectivity of peer-to-peer applications. By providing a cloud-based relay service, TURN ensures that a connection can be established even when one or more peers are incapable of a direct peer-to-peer connection. For more information, see A REST API For Access To TURN Services.

You can invoke this API to establish a fallback mechanism in case either of the peers is unable to establish a direct peer-to-peer connection over a signaling channel. You must specify either a signaling channel ARN or the client ID in order to invoke this API.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GetIceServerConfigRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getChannelARN() The ARN of the signaling channel to be used for the peer-to-peer connection between configured peers.
java.lang.String	getClientId() Unique identifier for the viewer.
java.lang.String	getService() Specifies the desired service.
java.lang.String	getUsername() An optional user ID to be associated with the credentials.
int	hashCode()
void	setChannelARN(java.lang.String channelARN) The ARN of the signaling channel to be used for the peer-to-peer connection between configured peers.
void	setClientId(java.lang.String clientId) Unique identifier for the viewer.
void	setService(Service service) Specifies the desired service.
void	setService(java.lang.String service) Specifies the desired service.
void	setUsername(java.lang.String username) An optional user ID to be associated with the credentials.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
GetIceServerConfigRequest	withChannelARN(java.lang.String channelARN) The ARN of the signaling channel to be used for the peer-to-peer connection between configured peers.
GetIceServerConfigRequest	withClientId(java.lang.String clientId) Unique identifier for the viewer.
GetIceServerConfigRequest	withService(Service service) Specifies the desired service.
GetIceServerConfigRequest	withService(java.lang.String service) Specifies the desired service.
GetIceServerConfigRequest	withUsername(java.lang.String username) An optional user ID to be associated with the credentials.

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

GetIceServerConfigRequest

public GetIceServerConfigRequest()

Method Detail

getChannelARN

public java.lang.String getChannelARN()

The ARN of the signaling channel to be used for the peer-to-peer connection between configured peers.

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 signaling channel to be used for the peer-to-peer connection between configured peers.

setChannelARN

public void setChannelARN(java.lang.String channelARN)

The ARN of the signaling channel to be used for the peer-to-peer connection between configured peers.

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 signaling channel to be used for the peer-to-peer connection between configured peers.

withChannelARN

public GetIceServerConfigRequest withChannelARN(java.lang.String channelARN)

The ARN of the signaling channel to be used for the peer-to-peer connection between configured peers.

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 signaling channel to be used for the peer-to-peer connection between configured peers.

Returns:

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

getClientId

public java.lang.String getClientId()

Unique identifier for the viewer. Must be unique within the signaling channel.

Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+

Returns:

Unique identifier for the viewer. Must be unique within the signaling channel.

setClientId

public void setClientId(java.lang.String clientId)

Unique identifier for the viewer. Must be unique within the signaling channel.

Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+

Parameters:

clientId -

Unique identifier for the viewer. Must be unique within the signaling channel.

withClientId

public GetIceServerConfigRequest withClientId(java.lang.String clientId)

Unique identifier for the viewer. Must be unique within the signaling channel.

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

Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+

Parameters:

clientId -

Unique identifier for the viewer. Must be unique within the signaling channel.

Returns:

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

getService

public java.lang.String getService()

Specifies the desired service. Currently, TURN is the only valid value.

Constraints:
Allowed Values: TURN

Returns:

Specifies the desired service. Currently, TURN is the only valid value.

See Also:

Service

setService

public void setService(java.lang.String service)

Specifies the desired service. Currently, TURN is the only valid value.

Constraints:
Allowed Values: TURN

Parameters:

service -

Specifies the desired service. Currently, TURN is the only valid value.

See Also:

Service

withService

public GetIceServerConfigRequest withService(java.lang.String service)

Specifies the desired service. Currently, TURN is the only valid value.

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

Constraints:
Allowed Values: TURN

Parameters:

service -

Specifies the desired service. Currently, TURN is the only valid value.

Returns:

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

See Also:

Service

setService

public void setService(Service service)

Specifies the desired service. Currently, TURN is the only valid value.

Constraints:
Allowed Values: TURN

Parameters:

service -

Specifies the desired service. Currently, TURN is the only valid value.

See Also:

Service

withService

public GetIceServerConfigRequest withService(Service service)

Specifies the desired service. Currently, TURN is the only valid value.

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

Constraints:
Allowed Values: TURN

Parameters:

service -

Specifies the desired service. Currently, TURN is the only valid value.

Returns:

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

See Also:

Service

getUsername

public java.lang.String getUsername()

An optional user ID to be associated with the credentials.

Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+

Returns:

An optional user ID to be associated with the credentials.

setUsername

public void setUsername(java.lang.String username)

An optional user ID to be associated with the credentials.

Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+

Parameters:

username -

An optional user ID to be associated with the credentials.

withUsername

public GetIceServerConfigRequest withUsername(java.lang.String username)

An optional user ID to be associated with the credentials.

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

Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+

Parameters:

username -

An optional user ID to be associated with the credentials.

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