Module: Google::Cloud::Gaming

Defined in:
lib/google/cloud/gaming.rb,
lib/google/cloud/gaming/version.rb

Constant Summary collapse

VERSION = 
"1.3.0"

Class Method Summary collapse

Class Method Details

.configure {|::Google::Cloud.configure.gaming| ... } ⇒ ::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:

Returns:

  • (::Google::Cloud::Config) —

    The default configuration used by this library



214
215
216
217
218
 
# File 'lib/google/cloud/gaming.rb', line 214

def self.configure
  yield ::Google::Cloud.configure.gaming if block_given?

  ::Google::Cloud.configure.gaming
end

.game_server_clusters_service(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for GameServerClustersService.

By default, this returns an instance of Google::Cloud::Gaming::V1::GameServerClustersService::Client for a gRPC client for version V1 of the API. However, you can 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. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

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.



70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/google/cloud/gaming.rb', line 70

def self.game_server_clusters_service version: :v1, transport: :grpc, &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
  service_module = Google::Cloud::Gaming.const_get(package_name).const_get(:GameServerClustersService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.game_server_configs_service(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for GameServerConfigsService.

By default, this returns an instance of Google::Cloud::Gaming::V1::GameServerConfigsService::Client for a gRPC client for version V1 of the API. However, you can 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. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

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.



104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/google/cloud/gaming.rb', line 104

def self.game_server_configs_service version: :v1, transport: :grpc, &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
  service_module = Google::Cloud::Gaming.const_get(package_name).const_get(:GameServerConfigsService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.game_server_deployments_service(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for GameServerDeploymentsService.

By default, this returns an instance of Google::Cloud::Gaming::V1::GameServerDeploymentsService::Client for a gRPC client for version V1 of the API. However, you can 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. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

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.



139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/google/cloud/gaming.rb', line 139

def self.game_server_deployments_service version: :v1, transport: :grpc, &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
  service_module = Google::Cloud::Gaming.const_get(package_name).const_get(:GameServerDeploymentsService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.realms_service(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for RealmsService.

By default, this returns an instance of Google::Cloud::Gaming::V1::RealmsService::Client for a gRPC client for version V1 of the API. However, you can 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. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

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.



174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/google/cloud/gaming.rb', line 174

def self.realms_service version: :v1, transport: :grpc, &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
  service_module = Google::Cloud::Gaming.const_get(package_name).const_get(:RealmsService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end