module Google::Cloud::Gaming

Constants

VERSION

Public Class Methods

configure() { |configure.gaming| ... } click to toggle source

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.

@return [::Google::Cloud::Config] The default configuration used by this library

# File lib/google/cloud/gaming.rb, line 198
def self.configure
  yield ::Google::Cloud.configure.gaming if block_given?

  ::Google::Cloud.configure.gaming
end
game_server_clusters_service(version: :v1, &block) click to toggle source

Create a new client object for GameServerClustersService.

By default, this returns an instance of [Google::Cloud::Gaming::V1::GameServerClustersService::Client](googleapis.dev/ruby/google-cloud-gaming-v1/latest/Google/Cloud/Gaming/V1/GameServerClustersService/Client.html) 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.

@param version [::String, ::Symbol] The API version to connect to. Optional.

Defaults to `:v1`.

@return [GameServerClustersService::Client] A client object for the specified version.

# File lib/google/cloud/gaming.rb, line 67
def self.game_server_clusters_service version: :v1, &block
  require "google/cloud/gaming/#{version.to_s.downcase}"

  package_name = Google::Cloud::Gaming
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  package_module = Google::Cloud::Gaming.const_get package_name
  package_module.const_get(:GameServerClustersService).const_get(:Client).new(&block)
end
game_server_configs_service(version: :v1, &block) click to toggle source

Create a new client object for GameServerConfigsService.

By default, this returns an instance of [Google::Cloud::Gaming::V1::GameServerConfigsService::Client](googleapis.dev/ruby/google-cloud-gaming-v1/latest/Google/Cloud/Gaming/V1/GameServerConfigsService/Client.html) 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.

@param version [::String, ::Symbol] The API version to connect to. Optional.

Defaults to `:v1`.

@return [GameServerConfigsService::Client] A client object for the specified version.

# File lib/google/cloud/gaming.rb, line 97
def self.game_server_configs_service version: :v1, &block
  require "google/cloud/gaming/#{version.to_s.downcase}"

  package_name = Google::Cloud::Gaming
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  package_module = Google::Cloud::Gaming.const_get package_name
  package_module.const_get(:GameServerConfigsService).const_get(:Client).new(&block)
end
game_server_deployments_service(version: :v1, &block) click to toggle source

Create a new client object for GameServerDeploymentsService.

By default, this returns an instance of [Google::Cloud::Gaming::V1::GameServerDeploymentsService::Client](googleapis.dev/ruby/google-cloud-gaming-v1/latest/Google/Cloud/Gaming/V1/GameServerDeploymentsService/Client.html) 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.

@param version [::String, ::Symbol] The API version to connect to. Optional.

Defaults to `:v1`.

@return [GameServerDeploymentsService::Client] A client object for the specified version.

# File lib/google/cloud/gaming.rb, line 128
def self.game_server_deployments_service version: :v1, &block
  require "google/cloud/gaming/#{version.to_s.downcase}"

  package_name = Google::Cloud::Gaming
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  package_module = Google::Cloud::Gaming.const_get package_name
  package_module.const_get(:GameServerDeploymentsService).const_get(:Client).new(&block)
end
realms_service(version: :v1, &block) click to toggle source

Create a new client object for RealmsService.

By default, this returns an instance of [Google::Cloud::Gaming::V1::RealmsService::Client](googleapis.dev/ruby/google-cloud-gaming-v1/latest/Google/Cloud/Gaming/V1/RealmsService/Client.html) 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.

@param version [::String, ::Symbol] The API version to connect to. Optional.

Defaults to `:v1`.

@return [RealmsService::Client] A client object for the specified version.

# File lib/google/cloud/gaming.rb, line 159
def self.realms_service version: :v1, &block
  require "google/cloud/gaming/#{version.to_s.downcase}"

  package_name = Google::Cloud::Gaming
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  package_module = Google::Cloud::Gaming.const_get package_name
  package_module.const_get(:RealmsService).const_get(:Client).new(&block)
end