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

#include <Build.h>

Public Member Functions

 Build ()
 
 Build (Aws::Utils::Json::JsonView jsonValue)
 
Buildoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetBuildId () const
 
bool BuildIdHasBeenSet () const
 
void SetBuildId (const Aws::String &value)
 
void SetBuildId (Aws::String &&value)
 
void SetBuildId (const char *value)
 
BuildWithBuildId (const Aws::String &value)
 
BuildWithBuildId (Aws::String &&value)
 
BuildWithBuildId (const char *value)
 
const Aws::StringGetBuildArn () const
 
bool BuildArnHasBeenSet () const
 
void SetBuildArn (const Aws::String &value)
 
void SetBuildArn (Aws::String &&value)
 
void SetBuildArn (const char *value)
 
BuildWithBuildArn (const Aws::String &value)
 
BuildWithBuildArn (Aws::String &&value)
 
BuildWithBuildArn (const char *value)
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
BuildWithName (const Aws::String &value)
 
BuildWithName (Aws::String &&value)
 
BuildWithName (const char *value)
 
const Aws::StringGetVersion () const
 
bool VersionHasBeenSet () const
 
void SetVersion (const Aws::String &value)
 
void SetVersion (Aws::String &&value)
 
void SetVersion (const char *value)
 
BuildWithVersion (const Aws::String &value)
 
BuildWithVersion (Aws::String &&value)
 
BuildWithVersion (const char *value)
 
const BuildStatusGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const BuildStatus &value)
 
void SetStatus (BuildStatus &&value)
 
BuildWithStatus (const BuildStatus &value)
 
BuildWithStatus (BuildStatus &&value)
 
long long GetSizeOnDisk () const
 
bool SizeOnDiskHasBeenSet () const
 
void SetSizeOnDisk (long long value)
 
BuildWithSizeOnDisk (long long value)
 
const OperatingSystemGetOperatingSystem () const
 
bool OperatingSystemHasBeenSet () const
 
void SetOperatingSystem (const OperatingSystem &value)
 
void SetOperatingSystem (OperatingSystem &&value)
 
BuildWithOperatingSystem (const OperatingSystem &value)
 
BuildWithOperatingSystem (OperatingSystem &&value)
 
const Aws::Utils::DateTimeGetCreationTime () const
 
bool CreationTimeHasBeenSet () const
 
void SetCreationTime (const Aws::Utils::DateTime &value)
 
void SetCreationTime (Aws::Utils::DateTime &&value)
 
BuildWithCreationTime (const Aws::Utils::DateTime &value)
 
BuildWithCreationTime (Aws::Utils::DateTime &&value)
 

Detailed Description

Properties describing a custom game build.

Related actions

CreateBuild | ListBuilds | DescribeBuild | UpdateBuild | DeleteBuild | All APIs by task

See Also:

AWS API Reference

Definition at line 38 of file Build.h.

Constructor & Destructor Documentation

◆ Build() [1/2]

Aws::GameLift::Model::Build::Build ( )

◆ Build() [2/2]

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

Member Function Documentation

◆ BuildArnHasBeenSet()

bool Aws::GameLift::Model::Build::BuildArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) that is assigned to a GameLift build resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::build/build-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. In a GameLift build ARN, the resource ID matches the BuildId value.

Definition at line 106 of file Build.h.

◆ BuildIdHasBeenSet()

bool Aws::GameLift::Model::Build::BuildIdHasBeenSet ( ) const
inline

A unique identifier for the build.

Definition at line 55 of file Build.h.

◆ CreationTimeHasBeenSet()

bool Aws::GameLift::Model::Build::CreationTimeHasBeenSet ( ) const
inline

A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Definition at line 428 of file Build.h.

◆ GetBuildArn()

const Aws::String& Aws::GameLift::Model::Build::GetBuildArn ( ) const
inline

The Amazon Resource Name (ARN) that is assigned to a GameLift build resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::build/build-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. In a GameLift build ARN, the resource ID matches the BuildId value.

Definition at line 96 of file Build.h.

◆ GetBuildId()

const Aws::String& Aws::GameLift::Model::Build::GetBuildId ( ) const
inline

A unique identifier for the build.

Definition at line 50 of file Build.h.

◆ GetCreationTime()

const Aws::Utils::DateTime& Aws::GameLift::Model::Build::GetCreationTime ( ) const
inline

A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Definition at line 421 of file Build.h.

◆ GetName()

const Aws::String& Aws::GameLift::Model::Build::GetName ( ) const
inline

A descriptive label that is associated with a build. Build names do not need to be unique. It can be set using CreateBuild or UpdateBuild.

Definition at line 173 of file Build.h.

◆ GetOperatingSystem()

const OperatingSystem& Aws::GameLift::Model::Build::GetOperatingSystem ( ) const
inline

Operating system that the game server binaries are built to run on. This value determines the type of fleet resources that you can use for this build.

Definition at line 378 of file Build.h.

◆ GetSizeOnDisk()

long long Aws::GameLift::Model::Build::GetSizeOnDisk ( ) const
inline

File size of the uploaded game build, expressed in bytes. When the build status is INITIALIZED, this value is 0.

Definition at line 352 of file Build.h.

◆ GetStatus()

const BuildStatus& Aws::GameLift::Model::Build::GetStatus ( ) const
inline

Current status of the build.

Possible build statuses include the following:

  • INITIALIZED – A new build has been defined, but no files have been uploaded. You cannot create fleets for builds that are in this status. When a build is successfully created, the build status is set to this value.

  • READY – The game build has been successfully uploaded. You can now create new fleets for this build.

  • FAILED – The game build upload failed. You cannot create new fleets for this build.

Definition at line 285 of file Build.h.

◆ GetVersion()

const Aws::String& Aws::GameLift::Model::Build::GetVersion ( ) const
inline

Version information that is associated with a build or script. Version strings do not need to be unique. This value can be set using CreateBuild or UpdateBuild.

Definition at line 223 of file Build.h.

◆ Jsonize()

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

◆ NameHasBeenSet()

bool Aws::GameLift::Model::Build::NameHasBeenSet ( ) const
inline

A descriptive label that is associated with a build. Build names do not need to be unique. It can be set using CreateBuild or UpdateBuild.

Definition at line 179 of file Build.h.

◆ OperatingSystemHasBeenSet()

bool Aws::GameLift::Model::Build::OperatingSystemHasBeenSet ( ) const
inline

Operating system that the game server binaries are built to run on. This value determines the type of fleet resources that you can use for this build.

Definition at line 385 of file Build.h.

◆ operator=()

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

◆ SetBuildArn() [1/3]

void Aws::GameLift::Model::Build::SetBuildArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) that is assigned to a GameLift build resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::build/build-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. In a GameLift build ARN, the resource ID matches the BuildId value.

Definition at line 126 of file Build.h.

◆ SetBuildArn() [2/3]

void Aws::GameLift::Model::Build::SetBuildArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) that is assigned to a GameLift build resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::build/build-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. In a GameLift build ARN, the resource ID matches the BuildId value.

Definition at line 116 of file Build.h.

◆ SetBuildArn() [3/3]

void Aws::GameLift::Model::Build::SetBuildArn ( const char *  value)
inline

The Amazon Resource Name (ARN) that is assigned to a GameLift build resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::build/build-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. In a GameLift build ARN, the resource ID matches the BuildId value.

Definition at line 136 of file Build.h.

◆ SetBuildId() [1/3]

void Aws::GameLift::Model::Build::SetBuildId ( Aws::String &&  value)
inline

A unique identifier for the build.

Definition at line 65 of file Build.h.

◆ SetBuildId() [2/3]

void Aws::GameLift::Model::Build::SetBuildId ( const Aws::String value)
inline

A unique identifier for the build.

Definition at line 60 of file Build.h.

◆ SetBuildId() [3/3]

void Aws::GameLift::Model::Build::SetBuildId ( const char *  value)
inline

A unique identifier for the build.

Definition at line 70 of file Build.h.

◆ SetCreationTime() [1/2]

void Aws::GameLift::Model::Build::SetCreationTime ( Aws::Utils::DateTime &&  value)
inline

A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Definition at line 442 of file Build.h.

◆ SetCreationTime() [2/2]

void Aws::GameLift::Model::Build::SetCreationTime ( const Aws::Utils::DateTime value)
inline

A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Definition at line 435 of file Build.h.

◆ SetName() [1/3]

void Aws::GameLift::Model::Build::SetName ( Aws::String &&  value)
inline

A descriptive label that is associated with a build. Build names do not need to be unique. It can be set using CreateBuild or UpdateBuild.

Definition at line 191 of file Build.h.

◆ SetName() [2/3]

void Aws::GameLift::Model::Build::SetName ( const Aws::String value)
inline

A descriptive label that is associated with a build. Build names do not need to be unique. It can be set using CreateBuild or UpdateBuild.

Definition at line 185 of file Build.h.

◆ SetName() [3/3]

void Aws::GameLift::Model::Build::SetName ( const char *  value)
inline

A descriptive label that is associated with a build. Build names do not need to be unique. It can be set using CreateBuild or UpdateBuild.

Definition at line 197 of file Build.h.

◆ SetOperatingSystem() [1/2]

void Aws::GameLift::Model::Build::SetOperatingSystem ( const OperatingSystem value)
inline

Operating system that the game server binaries are built to run on. This value determines the type of fleet resources that you can use for this build.

Definition at line 392 of file Build.h.

◆ SetOperatingSystem() [2/2]

void Aws::GameLift::Model::Build::SetOperatingSystem ( OperatingSystem &&  value)
inline

Operating system that the game server binaries are built to run on. This value determines the type of fleet resources that you can use for this build.

Definition at line 399 of file Build.h.

◆ SetSizeOnDisk()

void Aws::GameLift::Model::Build::SetSizeOnDisk ( long long  value)
inline

File size of the uploaded game build, expressed in bytes. When the build status is INITIALIZED, this value is 0.

Definition at line 364 of file Build.h.

◆ SetStatus() [1/2]

void Aws::GameLift::Model::Build::SetStatus ( BuildStatus &&  value)
inline

Current status of the build.

Possible build statuses include the following:

  • INITIALIZED – A new build has been defined, but no files have been uploaded. You cannot create fleets for builds that are in this status. When a build is successfully created, the build status is set to this value.

  • READY – The game build has been successfully uploaded. You can now create new fleets for this build.

  • FAILED – The game build upload failed. You cannot create new fleets for this build.

Definition at line 321 of file Build.h.

◆ SetStatus() [2/2]

void Aws::GameLift::Model::Build::SetStatus ( const BuildStatus value)
inline

Current status of the build.

Possible build statuses include the following:

  • INITIALIZED – A new build has been defined, but no files have been uploaded. You cannot create fleets for builds that are in this status. When a build is successfully created, the build status is set to this value.

  • READY – The game build has been successfully uploaded. You can now create new fleets for this build.

  • FAILED – The game build upload failed. You cannot create new fleets for this build.

Definition at line 309 of file Build.h.

◆ SetVersion() [1/3]

void Aws::GameLift::Model::Build::SetVersion ( Aws::String &&  value)
inline

Version information that is associated with a build or script. Version strings do not need to be unique. This value can be set using CreateBuild or UpdateBuild.

Definition at line 244 of file Build.h.

◆ SetVersion() [2/3]

void Aws::GameLift::Model::Build::SetVersion ( const Aws::String value)
inline

Version information that is associated with a build or script. Version strings do not need to be unique. This value can be set using CreateBuild or UpdateBuild.

Definition at line 237 of file Build.h.

◆ SetVersion() [3/3]

void Aws::GameLift::Model::Build::SetVersion ( const char *  value)
inline

Version information that is associated with a build or script. Version strings do not need to be unique. This value can be set using CreateBuild or UpdateBuild.

Definition at line 251 of file Build.h.

◆ SizeOnDiskHasBeenSet()

bool Aws::GameLift::Model::Build::SizeOnDiskHasBeenSet ( ) const
inline

File size of the uploaded game build, expressed in bytes. When the build status is INITIALIZED, this value is 0.

Definition at line 358 of file Build.h.

◆ StatusHasBeenSet()

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

Current status of the build.

Possible build statuses include the following:

  • INITIALIZED – A new build has been defined, but no files have been uploaded. You cannot create fleets for builds that are in this status. When a build is successfully created, the build status is set to this value.

  • READY – The game build has been successfully uploaded. You can now create new fleets for this build.

  • FAILED – The game build upload failed. You cannot create new fleets for this build.

Definition at line 297 of file Build.h.

◆ VersionHasBeenSet()

bool Aws::GameLift::Model::Build::VersionHasBeenSet ( ) const
inline

Version information that is associated with a build or script. Version strings do not need to be unique. This value can be set using CreateBuild or UpdateBuild.

Definition at line 230 of file Build.h.

◆ WithBuildArn() [1/3]

Build& Aws::GameLift::Model::Build::WithBuildArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) that is assigned to a GameLift build resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::build/build-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. In a GameLift build ARN, the resource ID matches the BuildId value.

Definition at line 156 of file Build.h.

◆ WithBuildArn() [2/3]

Build& Aws::GameLift::Model::Build::WithBuildArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) that is assigned to a GameLift build resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::build/build-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. In a GameLift build ARN, the resource ID matches the BuildId value.

Definition at line 146 of file Build.h.

◆ WithBuildArn() [3/3]

Build& Aws::GameLift::Model::Build::WithBuildArn ( const char *  value)
inline

The Amazon Resource Name (ARN) that is assigned to a GameLift build resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::build/build-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. In a GameLift build ARN, the resource ID matches the BuildId value.

Definition at line 166 of file Build.h.

◆ WithBuildId() [1/3]

Build& Aws::GameLift::Model::Build::WithBuildId ( Aws::String &&  value)
inline

A unique identifier for the build.

Definition at line 80 of file Build.h.

◆ WithBuildId() [2/3]

Build& Aws::GameLift::Model::Build::WithBuildId ( const Aws::String value)
inline

A unique identifier for the build.

Definition at line 75 of file Build.h.

◆ WithBuildId() [3/3]

Build& Aws::GameLift::Model::Build::WithBuildId ( const char *  value)
inline

A unique identifier for the build.

Definition at line 85 of file Build.h.

◆ WithCreationTime() [1/2]

Build& Aws::GameLift::Model::Build::WithCreationTime ( Aws::Utils::DateTime &&  value)
inline

A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Definition at line 456 of file Build.h.

◆ WithCreationTime() [2/2]

Build& Aws::GameLift::Model::Build::WithCreationTime ( const Aws::Utils::DateTime value)
inline

A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Definition at line 449 of file Build.h.

◆ WithName() [1/3]

Build& Aws::GameLift::Model::Build::WithName ( Aws::String &&  value)
inline

A descriptive label that is associated with a build. Build names do not need to be unique. It can be set using CreateBuild or UpdateBuild.

Definition at line 209 of file Build.h.

◆ WithName() [2/3]

Build& Aws::GameLift::Model::Build::WithName ( const Aws::String value)
inline

A descriptive label that is associated with a build. Build names do not need to be unique. It can be set using CreateBuild or UpdateBuild.

Definition at line 203 of file Build.h.

◆ WithName() [3/3]

Build& Aws::GameLift::Model::Build::WithName ( const char *  value)
inline

A descriptive label that is associated with a build. Build names do not need to be unique. It can be set using CreateBuild or UpdateBuild.

Definition at line 215 of file Build.h.

◆ WithOperatingSystem() [1/2]

Build& Aws::GameLift::Model::Build::WithOperatingSystem ( const OperatingSystem value)
inline

Operating system that the game server binaries are built to run on. This value determines the type of fleet resources that you can use for this build.

Definition at line 406 of file Build.h.

◆ WithOperatingSystem() [2/2]

Build& Aws::GameLift::Model::Build::WithOperatingSystem ( OperatingSystem &&  value)
inline

Operating system that the game server binaries are built to run on. This value determines the type of fleet resources that you can use for this build.

Definition at line 413 of file Build.h.

◆ WithSizeOnDisk()

Build& Aws::GameLift::Model::Build::WithSizeOnDisk ( long long  value)
inline

File size of the uploaded game build, expressed in bytes. When the build status is INITIALIZED, this value is 0.

Definition at line 370 of file Build.h.

◆ WithStatus() [1/2]

Build& Aws::GameLift::Model::Build::WithStatus ( BuildStatus &&  value)
inline

Current status of the build.

Possible build statuses include the following:

  • INITIALIZED – A new build has been defined, but no files have been uploaded. You cannot create fleets for builds that are in this status. When a build is successfully created, the build status is set to this value.

  • READY – The game build has been successfully uploaded. You can now create new fleets for this build.

  • FAILED – The game build upload failed. You cannot create new fleets for this build.

Definition at line 345 of file Build.h.

◆ WithStatus() [2/2]

Build& Aws::GameLift::Model::Build::WithStatus ( const BuildStatus value)
inline

Current status of the build.

Possible build statuses include the following:

  • INITIALIZED – A new build has been defined, but no files have been uploaded. You cannot create fleets for builds that are in this status. When a build is successfully created, the build status is set to this value.

  • READY – The game build has been successfully uploaded. You can now create new fleets for this build.

  • FAILED – The game build upload failed. You cannot create new fleets for this build.

Definition at line 333 of file Build.h.

◆ WithVersion() [1/3]

Build& Aws::GameLift::Model::Build::WithVersion ( Aws::String &&  value)
inline

Version information that is associated with a build or script. Version strings do not need to be unique. This value can be set using CreateBuild or UpdateBuild.

Definition at line 265 of file Build.h.

◆ WithVersion() [2/3]

Build& Aws::GameLift::Model::Build::WithVersion ( const Aws::String value)
inline

Version information that is associated with a build or script. Version strings do not need to be unique. This value can be set using CreateBuild or UpdateBuild.

Definition at line 258 of file Build.h.

◆ WithVersion() [3/3]

Build& Aws::GameLift::Model::Build::WithVersion ( const char *  value)
inline

Version information that is associated with a build or script. Version strings do not need to be unique. This value can be set using CreateBuild or UpdateBuild.

Definition at line 272 of file Build.h.


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