Struct aws_sdk_gamelift::input::describe_game_sessions_input::Builder

#[non_exhaustive]
pub struct Builder { /* fields omitted */ }

A builder for DescribeGameSessionsInput

Implementations

impl Builder

pub fn fleet_id(self, input: impl Into<String>) -> Self

A unique identifier for the fleet to retrieve game sessions for. You can use either the fleet ID or ARN value.

pub fn set_fleet_id(self, input: Option<String>) -> Self

A unique identifier for the fleet to retrieve game sessions for. You can use either the fleet ID or ARN value.

pub fn game_session_id(self, input: impl Into<String>) -> Self

A unique identifier for the game session to retrieve.

pub fn set_game_session_id(self, input: Option<String>) -> Self

A unique identifier for the game session to retrieve.

pub fn alias_id(self, input: impl Into<String>) -> Self

A unique identifier for the alias associated with the fleet to retrieve game sessions for. You can use either the alias ID or ARN value.

pub fn set_alias_id(self, input: Option<String>) -> Self

A unique identifier for the alias associated with the fleet to retrieve game sessions for. You can use either the alias ID or ARN value.

pub fn location(self, input: impl Into<String>) -> Self

A fleet location to get game session details for. You can specify a fleet's home Region or a remote location. Use the AWS Region code format, such as us-west-2.

pub fn set_location(self, input: Option<String>) -> Self

A fleet location to get game session details for. You can specify a fleet's home Region or a remote location. Use the AWS Region code format, such as us-west-2.

pub fn status_filter(self, input: impl Into<String>) -> Self

Game session status to filter results on. You can filter on the following states: ACTIVE, TERMINATED, ACTIVATING, and TERMINATING. The last two are transitory and used for only very brief periods of time.

pub fn set_status_filter(self, input: Option<String>) -> Self

Game session status to filter results on. You can filter on the following states: ACTIVE, TERMINATED, ACTIVATING, and TERMINATING. The last two are transitory and used for only very brief periods of time.

pub fn limit(self, input: i32) -> Self

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

pub fn set_limit(self, input: Option<i32>) -> Self

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

pub fn next_token(self, input: impl Into<String>) -> Self

A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.

pub fn set_next_token(self, input: Option<String>) -> Self

A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.

pub fn build(self) -> Result<DescribeGameSessionsInput, BuildError>

Consumes the builder and constructs a DescribeGameSessionsInput

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Builder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

fn eq(&self, other: &Builder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Builder) -> bool

This method tests for !=.

impl StructuralPartialEq for Builder