Cloud Gaming API - Module Google::Cloud::Gaming (v1.1.3)

Reference documentation and code samples for the Cloud Gaming API module Google::Cloud::Gaming.

Methods

.configure

def self.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 gRPC 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

.game_server_clusters_service

def self.game_server_clusters_service(version: :v1, &block) -> GameServerClustersService::Client

Create a new client object for GameServerClustersService.

By default, this returns an instance of Google::Cloud::Gaming::V1::GameServerClustersService::Client for version V1 of the API. However, you can specify specify a different API version by passing it in the version parameter. If the GameServerClustersService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.

About GameServerClustersService

The game server cluster maps to Kubernetes clusters running Agones and is used to manage fleets within clusters.

Parameter
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
Returns
  • (GameServerClustersService::Client) — A client object for the specified version.

.game_server_configs_service

def self.game_server_configs_service(version: :v1, &block) -> GameServerConfigsService::Client

Create a new client object for GameServerConfigsService.

By default, this returns an instance of Google::Cloud::Gaming::V1::GameServerConfigsService::Client for version V1 of the API. However, you can specify specify a different API version by passing it in the version parameter. If the GameServerConfigsService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.

About GameServerConfigsService

The game server config configures the game servers in an Agones fleet.

Parameter
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
Returns
  • (GameServerConfigsService::Client) — A client object for the specified version.

.game_server_deployments_service

def self.game_server_deployments_service(version: :v1, &block) -> GameServerDeploymentsService::Client

Create a new client object for GameServerDeploymentsService.

By default, this returns an instance of Google::Cloud::Gaming::V1::GameServerDeploymentsService::Client for version V1 of the API. However, you can specify specify a different API version by passing it in the version parameter. If the GameServerDeploymentsService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.

About GameServerDeploymentsService

The game server deployment is used to control the deployment of Agones fleets.

Parameter
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
Returns
  • (GameServerDeploymentsService::Client) — A client object for the specified version.

.realms_service

def self.realms_service(version: :v1, &block) -> RealmsService::Client

Create a new client object for RealmsService.

By default, this returns an instance of Google::Cloud::Gaming::V1::RealmsService::Client for version V1 of the API. However, you can specify specify a different API version by passing it in the version parameter. If the RealmsService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.

About RealmsService

A realm is a grouping of game server clusters that are considered interchangeable.

Parameter
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
Returns
  • (RealmsService::Client) — A client object for the specified version.

Constants

VERSION

value: "1.1.3"