#[non_exhaustive]pub struct StreamSessionSummaryBuilder { /* private fields */ }
Expand description
A builder for StreamSessionSummary
.
Implementations§
Source§impl StreamSessionSummaryBuilder
impl StreamSessionSummaryBuilder
Sourcepub fn arn(self, input: impl Into<String>) -> Self
pub fn arn(self, input: impl Into<String>) -> Self
An Amazon Resource Name (ARN) that uniquely identifies the stream session resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamsession/sg-1AB2C3De4/ABC123def4567
.
Sourcepub fn set_arn(self, input: Option<String>) -> Self
pub fn set_arn(self, input: Option<String>) -> Self
An Amazon Resource Name (ARN) that uniquely identifies the stream session resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamsession/sg-1AB2C3De4/ABC123def4567
.
Sourcepub fn get_arn(&self) -> &Option<String>
pub fn get_arn(&self) -> &Option<String>
An Amazon Resource Name (ARN) that uniquely identifies the stream session resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamsession/sg-1AB2C3De4/ABC123def4567
.
Sourcepub fn user_id(self, input: impl Into<String>) -> Self
pub fn user_id(self, input: impl Into<String>) -> Self
An opaque, unique identifier for an end-user, defined by the developer.
Sourcepub fn set_user_id(self, input: Option<String>) -> Self
pub fn set_user_id(self, input: Option<String>) -> Self
An opaque, unique identifier for an end-user, defined by the developer.
Sourcepub fn get_user_id(&self) -> &Option<String>
pub fn get_user_id(&self) -> &Option<String>
An opaque, unique identifier for an end-user, defined by the developer.
Sourcepub fn status(self, input: StreamSessionStatus) -> Self
pub fn status(self, input: StreamSessionStatus) -> Self
The current status of the stream session resource.
-
ACTIVATING
: The stream session is starting and preparing to stream. -
ACTIVE
: The stream session is ready and waiting for a client connection. A client hasConnectionTimeoutSeconds
(specified inStartStreamSession
) from when the session reachesACTIVE
state to establish a connection. If no client connects within this timeframe, the session automatically terminates. -
CONNECTED
: The stream session has a connected client. A session will automatically terminate if there is no user input for 60 minutes, or if the maximum length of a session specified bySessionLengthSeconds
inStartStreamSession
is exceeded. -
ERROR
: The stream session failed to activate. -
PENDING_CLIENT_RECONNECTION
: A client has recently disconnected and the stream session is waiting for the client to reconnect. A client hasConnectionTimeoutSeconds
(specified inStartStreamSession
) from when the session reachesPENDING_CLIENT_RECONNECTION
state to re-establish a connection. If no client connects within this timeframe, the session automatically terminates. -
RECONNECTING
: A client has initiated a reconnect to a session that was inPENDING_CLIENT_RECONNECTION
state. -
TERMINATING
: The stream session is ending. -
TERMINATED
: The stream session has ended.
Sourcepub fn set_status(self, input: Option<StreamSessionStatus>) -> Self
pub fn set_status(self, input: Option<StreamSessionStatus>) -> Self
The current status of the stream session resource.
-
ACTIVATING
: The stream session is starting and preparing to stream. -
ACTIVE
: The stream session is ready and waiting for a client connection. A client hasConnectionTimeoutSeconds
(specified inStartStreamSession
) from when the session reachesACTIVE
state to establish a connection. If no client connects within this timeframe, the session automatically terminates. -
CONNECTED
: The stream session has a connected client. A session will automatically terminate if there is no user input for 60 minutes, or if the maximum length of a session specified bySessionLengthSeconds
inStartStreamSession
is exceeded. -
ERROR
: The stream session failed to activate. -
PENDING_CLIENT_RECONNECTION
: A client has recently disconnected and the stream session is waiting for the client to reconnect. A client hasConnectionTimeoutSeconds
(specified inStartStreamSession
) from when the session reachesPENDING_CLIENT_RECONNECTION
state to re-establish a connection. If no client connects within this timeframe, the session automatically terminates. -
RECONNECTING
: A client has initiated a reconnect to a session that was inPENDING_CLIENT_RECONNECTION
state. -
TERMINATING
: The stream session is ending. -
TERMINATED
: The stream session has ended.
Sourcepub fn get_status(&self) -> &Option<StreamSessionStatus>
pub fn get_status(&self) -> &Option<StreamSessionStatus>
The current status of the stream session resource.
-
ACTIVATING
: The stream session is starting and preparing to stream. -
ACTIVE
: The stream session is ready and waiting for a client connection. A client hasConnectionTimeoutSeconds
(specified inStartStreamSession
) from when the session reachesACTIVE
state to establish a connection. If no client connects within this timeframe, the session automatically terminates. -
CONNECTED
: The stream session has a connected client. A session will automatically terminate if there is no user input for 60 minutes, or if the maximum length of a session specified bySessionLengthSeconds
inStartStreamSession
is exceeded. -
ERROR
: The stream session failed to activate. -
PENDING_CLIENT_RECONNECTION
: A client has recently disconnected and the stream session is waiting for the client to reconnect. A client hasConnectionTimeoutSeconds
(specified inStartStreamSession
) from when the session reachesPENDING_CLIENT_RECONNECTION
state to re-establish a connection. If no client connects within this timeframe, the session automatically terminates. -
RECONNECTING
: A client has initiated a reconnect to a session that was inPENDING_CLIENT_RECONNECTION
state. -
TERMINATING
: The stream session is ending. -
TERMINATED
: The stream session has ended.
Sourcepub fn protocol(self, input: Protocol) -> Self
pub fn protocol(self, input: Protocol) -> Self
The data transfer protocol in use with the stream session.
Sourcepub fn set_protocol(self, input: Option<Protocol>) -> Self
pub fn set_protocol(self, input: Option<Protocol>) -> Self
The data transfer protocol in use with the stream session.
Sourcepub fn get_protocol(&self) -> &Option<Protocol>
pub fn get_protocol(&self) -> &Option<Protocol>
The data transfer protocol in use with the stream session.
Sourcepub fn last_updated_at(self, input: DateTime) -> Self
pub fn last_updated_at(self, input: DateTime) -> Self
A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00
(UTC).
Sourcepub fn set_last_updated_at(self, input: Option<DateTime>) -> Self
pub fn set_last_updated_at(self, input: Option<DateTime>) -> Self
A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00
(UTC).
Sourcepub fn get_last_updated_at(&self) -> &Option<DateTime>
pub fn get_last_updated_at(&self) -> &Option<DateTime>
A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00
(UTC).
Sourcepub fn created_at(self, input: DateTime) -> Self
pub fn created_at(self, input: DateTime) -> Self
A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00
(UTC).
Sourcepub fn set_created_at(self, input: Option<DateTime>) -> Self
pub fn set_created_at(self, input: Option<DateTime>) -> Self
A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00
(UTC).
Sourcepub fn get_created_at(&self) -> &Option<DateTime>
pub fn get_created_at(&self) -> &Option<DateTime>
A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00
(UTC).
Sourcepub fn application_arn(self, input: impl Into<String>) -> Self
pub fn application_arn(self, input: impl Into<String>) -> Self
An Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6
.
Sourcepub fn set_application_arn(self, input: Option<String>) -> Self
pub fn set_application_arn(self, input: Option<String>) -> Self
An Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6
.
Sourcepub fn get_application_arn(&self) -> &Option<String>
pub fn get_application_arn(&self) -> &Option<String>
An Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6
.
Sourcepub fn export_files_metadata(self, input: ExportFilesMetadata) -> Self
pub fn export_files_metadata(self, input: ExportFilesMetadata) -> Self
Provides details about the stream session's exported files.
Sourcepub fn set_export_files_metadata(
self,
input: Option<ExportFilesMetadata>,
) -> Self
pub fn set_export_files_metadata( self, input: Option<ExportFilesMetadata>, ) -> Self
Provides details about the stream session's exported files.
Sourcepub fn get_export_files_metadata(&self) -> &Option<ExportFilesMetadata>
pub fn get_export_files_metadata(&self) -> &Option<ExportFilesMetadata>
Provides details about the stream session's exported files.
Sourcepub fn location(self, input: impl Into<String>) -> Self
pub fn location(self, input: impl Into<String>) -> Self
The location where Amazon GameLift Streams hosts and streams your application. For example, us-east-1
. For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide.
Sourcepub fn set_location(self, input: Option<String>) -> Self
pub fn set_location(self, input: Option<String>) -> Self
The location where Amazon GameLift Streams hosts and streams your application. For example, us-east-1
. For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide.
Sourcepub fn get_location(&self) -> &Option<String>
pub fn get_location(&self) -> &Option<String>
The location where Amazon GameLift Streams hosts and streams your application. For example, us-east-1
. For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide.
Sourcepub fn build(self) -> StreamSessionSummary
pub fn build(self) -> StreamSessionSummary
Consumes the builder and constructs a StreamSessionSummary
.
Trait Implementations§
Source§impl Clone for StreamSessionSummaryBuilder
impl Clone for StreamSessionSummaryBuilder
Source§fn clone(&self) -> StreamSessionSummaryBuilder
fn clone(&self) -> StreamSessionSummaryBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for StreamSessionSummaryBuilder
impl Debug for StreamSessionSummaryBuilder
Source§impl Default for StreamSessionSummaryBuilder
impl Default for StreamSessionSummaryBuilder
Source§fn default() -> StreamSessionSummaryBuilder
fn default() -> StreamSessionSummaryBuilder
impl StructuralPartialEq for StreamSessionSummaryBuilder
Auto Trait Implementations§
impl Freeze for StreamSessionSummaryBuilder
impl RefUnwindSafe for StreamSessionSummaryBuilder
impl Send for StreamSessionSummaryBuilder
impl Sync for StreamSessionSummaryBuilder
impl Unpin for StreamSessionSummaryBuilder
impl UnwindSafe for StreamSessionSummaryBuilder
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> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
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 moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);