Reference documentation and code samples for the Cloud Gaming API module Google::Cloud::Gaming.
Methods
.configure
defself.configure()->::Google::Cloud::Config
Configure the google-cloud-gaming library.
The following configuration parameters are supported:
credentials(type:String, Hash, Google::Auth::Credentials) -
The path to the keyfile as a String, the contents of the keyfile as a
Hash, or a Google::Auth::Credentials object.
lib_name(type:String) -
The library name as recorded in instrumentation and logging.
lib_version(type:String) -
The library version as recorded in instrumentation and logging.
interceptors(type:Array<GRPC::ClientInterceptor>) -
An array of interceptors that are run before calls are executed.
timeout(type:Numeric) -
Default timeout in seconds.
metadata(type:Hash{Symbol=>String}) -
Additional headers to be sent with the call.
retry_policy(type:Hash) -
The retry policy. The value is a hash with the following keys:
:initial_delay(type:Numeric) - The initial delay in seconds.
:max_delay(type:Numeric) - The max delay in seconds.
:multiplier(type:Numeric) - The incremental backoff multiplier.
:retry_codes(type:Array<String>) -
The error codes that should trigger a retry.
Yields
(::Google::Cloud.configure.gaming)
Returns
(::Google::Cloud::Config) — The default configuration used by this library
Create a new client object for GameServerClustersService.
By default, this returns an instance ofGoogle::Cloud::Gaming::V1::GameServerClustersService::Clientfor a gRPC client for version V1 of the API.
However, you can specify a different API version by passing it in theversionparameter. If the GameServerClustersService service is
supported by that API version, and the corresponding gem is available, the
appropriate versioned client will be returned.
You can also specify a different transport by passing:restor:grpcin
thetransportparameter.
About GameServerClustersService
The game server cluster maps to Kubernetes clusters running Agones and is
used to manage fleets within clusters.
Parameters
version(::String, ::Symbol)(defaults to: :v1)— The API version to connect to. Optional.
Defaults to:v1.
transport(:grpc, :rest)(defaults to: :grpc)— The transport to use. Defaults to:grpc.
Returns
(::Object) — A client object for the specified version.
Create a new client object for GameServerConfigsService.
By default, this returns an instance ofGoogle::Cloud::Gaming::V1::GameServerConfigsService::Clientfor a gRPC client for version V1 of the API.
However, you can specify a different API version by passing it in theversionparameter. If the GameServerConfigsService service is
supported by that API version, and the corresponding gem is available, the
appropriate versioned client will be returned.
You can also specify a different transport by passing:restor:grpcin
thetransportparameter.
About GameServerConfigsService
The game server config configures the game servers in an Agones fleet.
Parameters
version(::String, ::Symbol)(defaults to: :v1)— The API version to connect to. Optional.
Defaults to:v1.
transport(:grpc, :rest)(defaults to: :grpc)— The transport to use. Defaults to:grpc.
Returns
(::Object) — A client object for the specified version.
Create a new client object for GameServerDeploymentsService.
By default, this returns an instance ofGoogle::Cloud::Gaming::V1::GameServerDeploymentsService::Clientfor a gRPC client for version V1 of the API.
However, you can specify a different API version by passing it in theversionparameter. If the GameServerDeploymentsService service is
supported by that API version, and the corresponding gem is available, the
appropriate versioned client will be returned.
You can also specify a different transport by passing:restor:grpcin
thetransportparameter.
About GameServerDeploymentsService
The game server deployment is used to control the deployment of Agones
fleets.
Parameters
version(::String, ::Symbol)(defaults to: :v1)— The API version to connect to. Optional.
Defaults to:v1.
transport(:grpc, :rest)(defaults to: :grpc)— The transport to use. Defaults to:grpc.
Returns
(::Object) — A client object for the specified version.
By default, this returns an instance ofGoogle::Cloud::Gaming::V1::RealmsService::Clientfor a gRPC client for version V1 of the API.
However, you can specify a different API version by passing it in theversionparameter. If the RealmsService service is
supported by that API version, and the corresponding gem is available, the
appropriate versioned client will be returned.
You can also specify a different transport by passing:restor:grpcin
thetransportparameter.
About RealmsService
A realm is a grouping of game server clusters that are considered
interchangeable.
Parameters
version(::String, ::Symbol)(defaults to: :v1)— The API version to connect to. Optional.
Defaults to:v1.
transport(:grpc, :rest)(defaults to: :grpc)— The transport to use. Defaults to:grpc.
Returns
(::Object) — A client object for the specified version.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Cloud Gaming API - Module Google::Cloud::Gaming (v1.3.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.3.0 (latest)](/ruby/docs/reference/google-cloud-gaming/latest/Google-Cloud-Gaming)\n- [1.2.0](/ruby/docs/reference/google-cloud-gaming/1.2.0/Google-Cloud-Gaming)\n- [1.1.3](/ruby/docs/reference/google-cloud-gaming/1.1.3/Google-Cloud-Gaming) \nReference documentation and code samples for the Cloud Gaming API module Google::Cloud::Gaming.\n\nMethods\n-------\n\n### .configure\n\n def self.configure() -\u003e ::Google::Cloud::Config\n\nConfigure the google-cloud-gaming library.\n\nThe following configuration parameters are supported:\n\n- `credentials` (*type:* `String, Hash, Google::Auth::Credentials`) - The path to the keyfile as a String, the contents of the keyfile as a Hash, or a Google::Auth::Credentials object.\n- `lib_name` (*type:* `String`) - The library name as recorded in instrumentation and logging.\n- `lib_version` (*type:* `String`) - The library version as recorded in instrumentation and logging.\n- `interceptors` (*type:* `Array\u003cGRPC::ClientInterceptor\u003e`) - An array of interceptors that are run before calls are executed.\n- `timeout` (*type:* `Numeric`) - Default timeout in seconds.\n- `metadata` (*type:* `Hash{Symbol=\u003eString}`) - Additional headers to be sent with the call.\n- `retry_policy` (*type:* `Hash`) - The retry policy. The value is a hash with the following keys:\n - `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.\n - `:max_delay` (*type:* `Numeric`) - The max delay in seconds.\n - `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.\n- `:retry_codes` (*type:* `Array\u003cString\u003e`) - The error codes that should trigger a retry. \n**Yields**\n\n- (::Google::Cloud.configure.gaming) \n**Returns**\n\n- (::Google::Cloud::Config) --- The default configuration used by this library\n\n### .game_server_clusters_service\n\n def self.game_server_clusters_service(version: :v1, transport: :grpc, &block) -\u003e ::Object\n\nCreate a new client object for GameServerClustersService.\n\n\n\u003cbr /\u003e\n\nBy default, this returns an instance of\n[Google::Cloud::Gaming::V1::GameServerClustersService::Client](https://googleapis.dev/ruby/google-cloud-gaming-v1/latest/Google/Cloud/Gaming/V1/GameServerClustersService/Client.html)\nfor a gRPC client for version V1 of the API.\nHowever, you can specify a different API version by passing it in the\n`version` parameter. If the GameServerClustersService service is\nsupported by that API version, and the corresponding gem is available, the\nappropriate versioned client will be returned.\nYou can also specify a different transport by passing `:rest` or `:grpc` in\nthe `transport` parameter.\n\n#### About GameServerClustersService\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\nThe game server cluster maps to Kubernetes clusters running Agones and is\nused to manage fleets within clusters. \n**Parameters**\n\n- **version** (::String, ::Symbol) *(defaults to: :v1)* --- The API version to connect to. Optional. Defaults to `:v1`.\n- **transport** (:grpc, :rest) *(defaults to: :grpc)* --- The transport to use. Defaults to `:grpc`. \n**Returns**\n\n- (::Object) --- A client object for the specified version.\n\n### .game_server_configs_service\n\n def self.game_server_configs_service(version: :v1, transport: :grpc, &block) -\u003e ::Object\n\nCreate a new client object for GameServerConfigsService.\n\n\n\u003cbr /\u003e\n\nBy default, this returns an instance of\n[Google::Cloud::Gaming::V1::GameServerConfigsService::Client](https://googleapis.dev/ruby/google-cloud-gaming-v1/latest/Google/Cloud/Gaming/V1/GameServerConfigsService/Client.html)\nfor a gRPC client for version V1 of the API.\nHowever, you can specify a different API version by passing it in the\n`version` parameter. If the GameServerConfigsService service is\nsupported by that API version, and the corresponding gem is available, the\nappropriate versioned client will be returned.\nYou can also specify a different transport by passing `:rest` or `:grpc` in\nthe `transport` parameter.\n\n#### About GameServerConfigsService\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\nThe game server config configures the game servers in an Agones fleet. \n**Parameters**\n\n- **version** (::String, ::Symbol) *(defaults to: :v1)* --- The API version to connect to. Optional. Defaults to `:v1`.\n- **transport** (:grpc, :rest) *(defaults to: :grpc)* --- The transport to use. Defaults to `:grpc`. \n**Returns**\n\n- (::Object) --- A client object for the specified version.\n\n### .game_server_deployments_service\n\n def self.game_server_deployments_service(version: :v1, transport: :grpc, &block) -\u003e ::Object\n\nCreate a new client object for GameServerDeploymentsService.\n\n\n\u003cbr /\u003e\n\nBy default, this returns an instance of\n[Google::Cloud::Gaming::V1::GameServerDeploymentsService::Client](https://googleapis.dev/ruby/google-cloud-gaming-v1/latest/Google/Cloud/Gaming/V1/GameServerDeploymentsService/Client.html)\nfor a gRPC client for version V1 of the API.\nHowever, you can specify a different API version by passing it in the\n`version` parameter. If the GameServerDeploymentsService service is\nsupported by that API version, and the corresponding gem is available, the\nappropriate versioned client will be returned.\nYou can also specify a different transport by passing `:rest` or `:grpc` in\nthe `transport` parameter.\n\n#### About GameServerDeploymentsService\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\nThe game server deployment is used to control the deployment of Agones\nfleets. \n**Parameters**\n\n- **version** (::String, ::Symbol) *(defaults to: :v1)* --- The API version to connect to. Optional. Defaults to `:v1`.\n- **transport** (:grpc, :rest) *(defaults to: :grpc)* --- The transport to use. Defaults to `:grpc`. \n**Returns**\n\n- (::Object) --- A client object for the specified version.\n\n### .realms_service\n\n def self.realms_service(version: :v1, transport: :grpc, &block) -\u003e ::Object\n\nCreate a new client object for RealmsService.\n\n\n\u003cbr /\u003e\n\nBy default, this returns an instance of\n[Google::Cloud::Gaming::V1::RealmsService::Client](https://googleapis.dev/ruby/google-cloud-gaming-v1/latest/Google/Cloud/Gaming/V1/RealmsService/Client.html)\nfor a gRPC client for version V1 of the API.\nHowever, you can specify a different API version by passing it in the\n`version` parameter. If the RealmsService service is\nsupported by that API version, and the corresponding gem is available, the\nappropriate versioned client will be returned.\nYou can also specify a different transport by passing `:rest` or `:grpc` in\nthe `transport` parameter.\n\n#### About RealmsService\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\nA realm is a grouping of game server clusters that are considered\ninterchangeable. \n**Parameters**\n\n- **version** (::String, ::Symbol) *(defaults to: :v1)* --- The API version to connect to. Optional. Defaults to `:v1`.\n- **transport** (:grpc, :rest) *(defaults to: :grpc)* --- The transport to use. Defaults to `:grpc`. \n**Returns**\n\n- (::Object) --- A client object for the specified version.\n\nConstants\n---------\n\n### VERSION\n\n**value:**\"1.3.0\""]]