Struct aws_sdk_kinesisvideosignaling::operation::get_ice_server_config::builders::GetIceServerConfigFluentBuilder
source · pub struct GetIceServerConfigFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to GetIceServerConfig
.
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.
Implementations§
source§impl GetIceServerConfigFluentBuilder
impl GetIceServerConfigFluentBuilder
sourcepub fn as_input(&self) -> &GetIceServerConfigInputBuilder
pub fn as_input(&self) -> &GetIceServerConfigInputBuilder
Access the GetIceServerConfig as a reference.
sourcepub async fn send(
self
) -> Result<GetIceServerConfigOutput, SdkError<GetIceServerConfigError, HttpResponse>>
pub async fn send( self ) -> Result<GetIceServerConfigOutput, SdkError<GetIceServerConfigError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub fn customize(
self
) -> CustomizableOperation<GetIceServerConfigOutput, GetIceServerConfigError, Self>
pub fn customize( self ) -> CustomizableOperation<GetIceServerConfigOutput, GetIceServerConfigError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn channel_arn(self, input: impl Into<String>) -> Self
pub fn channel_arn(self, input: impl Into<String>) -> Self
The ARN of the signaling channel to be used for the peer-to-peer connection between configured peers.
sourcepub fn set_channel_arn(self, input: Option<String>) -> Self
pub fn set_channel_arn(self, input: Option<String>) -> Self
The ARN of the signaling channel to be used for the peer-to-peer connection between configured peers.
sourcepub fn get_channel_arn(&self) -> &Option<String>
pub fn get_channel_arn(&self) -> &Option<String>
The ARN of the signaling channel to be used for the peer-to-peer connection between configured peers.
sourcepub fn client_id(self, input: impl Into<String>) -> Self
pub fn client_id(self, input: impl Into<String>) -> Self
Unique identifier for the viewer. Must be unique within the signaling channel.
sourcepub fn set_client_id(self, input: Option<String>) -> Self
pub fn set_client_id(self, input: Option<String>) -> Self
Unique identifier for the viewer. Must be unique within the signaling channel.
sourcepub fn get_client_id(&self) -> &Option<String>
pub fn get_client_id(&self) -> &Option<String>
Unique identifier for the viewer. Must be unique within the signaling channel.
sourcepub fn service(self, input: Service) -> Self
pub fn service(self, input: Service) -> Self
Specifies the desired service. Currently, TURN
is the only valid value.
sourcepub fn set_service(self, input: Option<Service>) -> Self
pub fn set_service(self, input: Option<Service>) -> Self
Specifies the desired service. Currently, TURN
is the only valid value.
sourcepub fn get_service(&self) -> &Option<Service>
pub fn get_service(&self) -> &Option<Service>
Specifies the desired service. Currently, TURN
is the only valid value.
sourcepub fn username(self, input: impl Into<String>) -> Self
pub fn username(self, input: impl Into<String>) -> Self
An optional user ID to be associated with the credentials.
sourcepub fn set_username(self, input: Option<String>) -> Self
pub fn set_username(self, input: Option<String>) -> Self
An optional user ID to be associated with the credentials.
sourcepub fn get_username(&self) -> &Option<String>
pub fn get_username(&self) -> &Option<String>
An optional user ID to be associated with the credentials.
Trait Implementations§
source§impl Clone for GetIceServerConfigFluentBuilder
impl Clone for GetIceServerConfigFluentBuilder
source§fn clone(&self) -> GetIceServerConfigFluentBuilder
fn clone(&self) -> GetIceServerConfigFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more