pub struct SendEventFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to SendEvent
.
Sends an event to a room. Use this within your application’s business logic to send events to clients of a room; e.g., to notify clients to change the way the chat UI is rendered.
Implementations§
source§impl SendEventFluentBuilder
impl SendEventFluentBuilder
sourcepub fn as_input(&self) -> &SendEventInputBuilder
pub fn as_input(&self) -> &SendEventInputBuilder
Access the SendEvent as a reference.
sourcepub async fn send(
self
) -> Result<SendEventOutput, SdkError<SendEventError, HttpResponse>>
pub async fn send( self ) -> Result<SendEventOutput, SdkError<SendEventError, 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<SendEventOutput, SendEventError, Self>
pub fn customize( self ) -> CustomizableOperation<SendEventOutput, SendEventError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn room_identifier(self, input: impl Into<String>) -> Self
pub fn room_identifier(self, input: impl Into<String>) -> Self
Identifier of the room to which the event will be sent. Currently this must be an ARN.
sourcepub fn set_room_identifier(self, input: Option<String>) -> Self
pub fn set_room_identifier(self, input: Option<String>) -> Self
Identifier of the room to which the event will be sent. Currently this must be an ARN.
sourcepub fn get_room_identifier(&self) -> &Option<String>
pub fn get_room_identifier(&self) -> &Option<String>
Identifier of the room to which the event will be sent. Currently this must be an ARN.
sourcepub fn event_name(self, input: impl Into<String>) -> Self
pub fn event_name(self, input: impl Into<String>) -> Self
Application-defined name of the event to send to clients.
sourcepub fn set_event_name(self, input: Option<String>) -> Self
pub fn set_event_name(self, input: Option<String>) -> Self
Application-defined name of the event to send to clients.
sourcepub fn get_event_name(&self) -> &Option<String>
pub fn get_event_name(&self) -> &Option<String>
Application-defined name of the event to send to clients.
sourcepub fn attributes(self, k: impl Into<String>, v: impl Into<String>) -> Self
pub fn attributes(self, k: impl Into<String>, v: impl Into<String>) -> Self
Adds a key-value pair to attributes
.
To override the contents of this collection use set_attributes
.
Application-defined metadata to attach to the event sent to clients. The maximum length of the metadata is 1 KB total.
Trait Implementations§
source§impl Clone for SendEventFluentBuilder
impl Clone for SendEventFluentBuilder
source§fn clone(&self) -> SendEventFluentBuilder
fn clone(&self) -> SendEventFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for SendEventFluentBuilder
impl !RefUnwindSafe for SendEventFluentBuilder
impl Send for SendEventFluentBuilder
impl Sync for SendEventFluentBuilder
impl Unpin for SendEventFluentBuilder
impl !UnwindSafe for SendEventFluentBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more