/AWS1/CL_GMSSTAGEDETAILS¶
Properties that provide details of a stage.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
IV_NAME TYPE /AWS1/GMSSTAGENAME /AWS1/GMSSTAGENAME¶
The name of the stage.
IV_GAMEKEY TYPE /AWS1/GMSGAMEKEY /AWS1/GMSGAMEKEY¶
The game key associated with the stage.
The game key is a unique identifier that the game client uses to connect to the GameSparks backend.
IV_ARN TYPE /AWS1/GMSARN /AWS1/GMSARN¶
The Amazon Resource Name (ARN) of the stage.
IV_ROLE TYPE /AWS1/GMSROLEARN /AWS1/GMSROLEARN¶
The Amazon Resource Name (ARN) of the role used to run the game runtimes deployed to the stage.
IV_DESCRIPTION TYPE /AWS1/GMSSTAGEDESCRIPTION /AWS1/GMSSTAGEDESCRIPTION¶
The description of the stage.
IV_CREATED TYPE /AWS1/GMSDATETIME /AWS1/GMSDATETIME¶
The timestamp of when the stage was created.
IV_LASTUPDATED TYPE /AWS1/GMSDATETIME /AWS1/GMSDATETIME¶
The timestamp of when the stage was last updated.
IV_STATE TYPE /AWS1/GMSSTAGESTATE /AWS1/GMSSTAGESTATE¶
The state of the stage.
IT_TAGS TYPE /AWS1/CL_GMSTAGMAP_W=>TT_TAGMAP TT_TAGMAP¶
The tags associated with the stage.
IV_LOGGROUP TYPE /AWS1/GMSLOGGROUPNAME /AWS1/GMSLOGGROUPNAME¶
The Amazon CloudWatch log group for game runtimes deployed to the stage.
Queryable Attributes¶
Name¶
The name of the stage.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NAME() |
Getter for NAME, with configurable default |
ASK_NAME() |
Getter for NAME w/ exceptions if field has no value |
HAS_NAME() |
Determine if NAME has a value |
GameKey¶
The game key associated with the stage.
The game key is a unique identifier that the game client uses to connect to the GameSparks backend.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_GAMEKEY() |
Getter for GAMEKEY, with configurable default |
ASK_GAMEKEY() |
Getter for GAMEKEY w/ exceptions if field has no value |
HAS_GAMEKEY() |
Determine if GAMEKEY has a value |
Arn¶
The Amazon Resource Name (ARN) of the stage.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ARN() |
Getter for ARN, with configurable default |
ASK_ARN() |
Getter for ARN w/ exceptions if field has no value |
HAS_ARN() |
Determine if ARN has a value |
Role¶
The Amazon Resource Name (ARN) of the role used to run the game runtimes deployed to the stage.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ROLE() |
Getter for ROLE, with configurable default |
ASK_ROLE() |
Getter for ROLE w/ exceptions if field has no value |
HAS_ROLE() |
Determine if ROLE has a value |
Description¶
The description of the stage.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DESCRIPTION() |
Getter for DESCRIPTION, with configurable default |
ASK_DESCRIPTION() |
Getter for DESCRIPTION w/ exceptions if field has no value |
HAS_DESCRIPTION() |
Determine if DESCRIPTION has a value |
Created¶
The timestamp of when the stage was created.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATED() |
Getter for CREATED, with configurable default |
ASK_CREATED() |
Getter for CREATED w/ exceptions if field has no value |
HAS_CREATED() |
Determine if CREATED has a value |
LastUpdated¶
The timestamp of when the stage was last updated.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LASTUPDATED() |
Getter for LASTUPDATED, with configurable default |
ASK_LASTUPDATED() |
Getter for LASTUPDATED w/ exceptions if field has no value |
HAS_LASTUPDATED() |
Determine if LASTUPDATED has a value |
State¶
The state of the stage.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATE() |
Getter for STATE, with configurable default |
ASK_STATE() |
Getter for STATE w/ exceptions if field has no value |
HAS_STATE() |
Determine if STATE has a value |
Tags¶
The tags associated with the stage.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TAGS() |
Getter for TAGS, with configurable default |
ASK_TAGS() |
Getter for TAGS w/ exceptions if field has no value |
HAS_TAGS() |
Determine if TAGS has a value |
LogGroup¶
The Amazon CloudWatch log group for game runtimes deployed to the stage.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LOGGROUP() |
Getter for LOGGROUP, with configurable default |
ASK_LOGGROUP() |
Getter for LOGGROUP w/ exceptions if field has no value |
HAS_LOGGROUP() |
Determine if LOGGROUP has a value |