AWS SDK for C++  1.9.108
AWS SDK for C++
Public Member Functions | List of all members
Aws::GameLift::Model::LocationState Class Reference

#include <LocationState.h>

Public Member Functions

 LocationState ()
 
 LocationState (Aws::Utils::Json::JsonView jsonValue)
 
LocationStateoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetLocation () const
 
bool LocationHasBeenSet () const
 
void SetLocation (const Aws::String &value)
 
void SetLocation (Aws::String &&value)
 
void SetLocation (const char *value)
 
LocationStateWithLocation (const Aws::String &value)
 
LocationStateWithLocation (Aws::String &&value)
 
LocationStateWithLocation (const char *value)
 
const FleetStatusGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const FleetStatus &value)
 
void SetStatus (FleetStatus &&value)
 
LocationStateWithStatus (const FleetStatus &value)
 
LocationStateWithStatus (FleetStatus &&value)
 

Detailed Description

A fleet location and its life-cycle state. A location state object might be used to describe a fleet's remote location or home Region. Life-cycle state tracks the progress of launching the first instance in a new location and preparing it for game hosting, and then removing all instances and deleting the location from the fleet.

Related actions

CreateFleet | CreateFleetLocations | DeleteFleetLocations

See Also:

AWS API Reference

Definition at line 38 of file LocationState.h.

Constructor & Destructor Documentation

◆ LocationState() [1/2]

Aws::GameLift::Model::LocationState::LocationState ( )

◆ LocationState() [2/2]

Aws::GameLift::Model::LocationState::LocationState ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ GetLocation()

const Aws::String& Aws::GameLift::Model::LocationState::GetLocation ( ) const
inline

The fleet location, expressed as an AWS Region code such as us-west-2.

Definition at line 51 of file LocationState.h.

◆ GetStatus()

const FleetStatus& Aws::GameLift::Model::LocationState::GetStatus ( ) const
inline

The life-cycle status of a fleet location.

Definition at line 99 of file LocationState.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::GameLift::Model::LocationState::Jsonize ( ) const

◆ LocationHasBeenSet()

bool Aws::GameLift::Model::LocationState::LocationHasBeenSet ( ) const
inline

The fleet location, expressed as an AWS Region code such as us-west-2.

Definition at line 57 of file LocationState.h.

◆ operator=()

LocationState& Aws::GameLift::Model::LocationState::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetLocation() [1/3]

void Aws::GameLift::Model::LocationState::SetLocation ( Aws::String &&  value)
inline

The fleet location, expressed as an AWS Region code such as us-west-2.

Definition at line 69 of file LocationState.h.

◆ SetLocation() [2/3]

void Aws::GameLift::Model::LocationState::SetLocation ( const Aws::String value)
inline

The fleet location, expressed as an AWS Region code such as us-west-2.

Definition at line 63 of file LocationState.h.

◆ SetLocation() [3/3]

void Aws::GameLift::Model::LocationState::SetLocation ( const char *  value)
inline

The fleet location, expressed as an AWS Region code such as us-west-2.

Definition at line 75 of file LocationState.h.

◆ SetStatus() [1/2]

void Aws::GameLift::Model::LocationState::SetStatus ( const FleetStatus value)
inline

The life-cycle status of a fleet location.

Definition at line 109 of file LocationState.h.

◆ SetStatus() [2/2]

void Aws::GameLift::Model::LocationState::SetStatus ( FleetStatus &&  value)
inline

The life-cycle status of a fleet location.

Definition at line 114 of file LocationState.h.

◆ StatusHasBeenSet()

bool Aws::GameLift::Model::LocationState::StatusHasBeenSet ( ) const
inline

The life-cycle status of a fleet location.

Definition at line 104 of file LocationState.h.

◆ WithLocation() [1/3]

LocationState& Aws::GameLift::Model::LocationState::WithLocation ( Aws::String &&  value)
inline

The fleet location, expressed as an AWS Region code such as us-west-2.

Definition at line 87 of file LocationState.h.

◆ WithLocation() [2/3]

LocationState& Aws::GameLift::Model::LocationState::WithLocation ( const Aws::String value)
inline

The fleet location, expressed as an AWS Region code such as us-west-2.

Definition at line 81 of file LocationState.h.

◆ WithLocation() [3/3]

LocationState& Aws::GameLift::Model::LocationState::WithLocation ( const char *  value)
inline

The fleet location, expressed as an AWS Region code such as us-west-2.

Definition at line 93 of file LocationState.h.

◆ WithStatus() [1/2]

LocationState& Aws::GameLift::Model::LocationState::WithStatus ( const FleetStatus value)
inline

The life-cycle status of a fleet location.

Definition at line 119 of file LocationState.h.

◆ WithStatus() [2/2]

LocationState& Aws::GameLift::Model::LocationState::WithStatus ( FleetStatus &&  value)
inline

The life-cycle status of a fleet location.

Definition at line 124 of file LocationState.h.


The documentation for this class was generated from the following file: