Class: Google::Cloud::Gaming::V1::GameServerClustersService::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/gaming/v1/game_server_clusters_service/client.rb

Overview

Client for the GameServerClustersService service.

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

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#game_server_cluster_path, #realm_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new GameServerClustersService client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::Gaming::V1::GameServerClustersService::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Gaming::V1::GameServerClustersService::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config)

    Configure the GameServerClustersService client.

Yield Parameters:



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
# File 'lib/google/cloud/gaming/v1/game_server_clusters_service/client.rb', line 141

def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/cloud/gaming/v1/game_server_clusters_service_services_pb"

  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
                           !@config.endpoint.split(".").first.include?("-")
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @operations_client = Operations.new do |config|
    config.credentials = credentials
    config.endpoint = @config.endpoint
  end

  @game_server_clusters_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::Gaming::V1::GameServerClustersService::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Instance Attribute Details

#operations_client::Google::Cloud::Gaming::V1::GameServerClustersService::Operations (readonly)

Get the associated client for long-running operations.



187
188
189
# File 'lib/google/cloud/gaming/v1/game_server_clusters_service/client.rb', line 187

def operations_client
  @operations_client
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the GameServerClustersService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all GameServerClustersService clients
::Google::Cloud::Gaming::V1::GameServerClustersService::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config)

    Configure the Client client.

Yield Parameters:

Returns:



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
# File 'lib/google/cloud/gaming/v1/game_server_clusters_service/client.rb', line 57

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Gaming", "V1"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.rpcs.list_game_server_clusters.timeout = 60.0
    default_config.rpcs.list_game_server_clusters.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.get_game_server_cluster.timeout = 60.0
    default_config.rpcs.get_game_server_cluster.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.create_game_server_cluster.timeout = 120.0

    default_config.rpcs.preview_create_game_server_cluster.timeout = 60.0
    default_config.rpcs.preview_create_game_server_cluster.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.delete_game_server_cluster.timeout = 60.0

    default_config.rpcs.preview_delete_game_server_cluster.timeout = 60.0
    default_config.rpcs.preview_delete_game_server_cluster.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.update_game_server_cluster.timeout = 60.0

    default_config.rpcs.preview_update_game_server_cluster.timeout = 60.0
    default_config.rpcs.preview_update_game_server_cluster.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#configure {|config| ... } ⇒ Client::Configuration

Configure the GameServerClustersService Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config)

    Configure the Client client.

Yield Parameters:

Returns:



120
121
122
123
# File 'lib/google/cloud/gaming/v1/game_server_clusters_service/client.rb', line 120

def configure
  yield @config if block_given?
  @config
end

#create_game_server_cluster(request, options = nil) ⇒ ::Gapic::Operation #create_game_server_cluster(parent: nil, game_server_cluster_id: nil, game_server_cluster: nil) ⇒ ::Gapic::Operation

Creates a new game server cluster in a given project and location.

Overloads:

  • #create_game_server_cluster(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to create_game_server_cluster via a request object, either of type CreateGameServerClusterRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Gaming::V1::CreateGameServerClusterRequest, ::Hash)

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil)

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #create_game_server_cluster(parent: nil, game_server_cluster_id: nil, game_server_cluster: nil) ⇒ ::Gapic::Operation

    Pass arguments to create_game_server_cluster via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil)

      Required. The parent resource name, in the following form: projects/{project}/locations/{location}/realms/{realm-id}.

    • game_server_cluster_id (::String) (defaults to: nil)

      Required. The ID of the game server cluster resource to be created.

    • game_server_cluster (::Google::Cloud::Gaming::V1::GameServerCluster, ::Hash) (defaults to: nil)

      Required. The game server cluster resource to be created.

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error)

    if the RPC is aborted.



391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
# File 'lib/google/cloud/gaming/v1/game_server_clusters_service/client.rb', line 391

def create_game_server_cluster request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Gaming::V1::CreateGameServerClusterRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
   = @config.rpcs.create_game_server_cluster..to_h

  # Set x-goog-api-client and x-goog-user-project headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Gaming::V1::VERSION
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  [:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_game_server_cluster.timeout,
                         metadata:     ,
                         retry_policy: @config.rpcs.create_game_server_cluster.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.,
                         retry_policy: @config.retry_policy

  @game_server_clusters_service_stub.call_rpc :create_game_server_cluster, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_game_server_cluster(request, options = nil) ⇒ ::Gapic::Operation #delete_game_server_cluster(name: nil) ⇒ ::Gapic::Operation

Deletes a single game server cluster.

Overloads:

  • #delete_game_server_cluster(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_game_server_cluster via a request object, either of type DeleteGameServerClusterRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Gaming::V1::DeleteGameServerClusterRequest, ::Hash)

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil)

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #delete_game_server_cluster(name: nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_game_server_cluster via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil)

      Required. The name of the game server cluster to delete, in the following form: projects/{project}/locations/{location}/gameServerClusters/{cluster}.

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error)

    if the RPC is aborted.



540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
# File 'lib/google/cloud/gaming/v1/game_server_clusters_service/client.rb', line 540

def delete_game_server_cluster request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Gaming::V1::DeleteGameServerClusterRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
   = @config.rpcs.delete_game_server_cluster..to_h

  # Set x-goog-api-client and x-goog-user-project headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Gaming::V1::VERSION
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  [:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_game_server_cluster.timeout,
                         metadata:     ,
                         retry_policy: @config.rpcs.delete_game_server_cluster.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.,
                         retry_policy: @config.retry_policy

  @game_server_clusters_service_stub.call_rpc :delete_game_server_cluster, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_game_server_cluster(request, options = nil) ⇒ ::Google::Cloud::Gaming::V1::GameServerCluster #get_game_server_cluster(name: nil, view: nil) ⇒ ::Google::Cloud::Gaming::V1::GameServerCluster

Gets details of a single game server cluster.

Overloads:

  • #get_game_server_cluster(request, options = nil) ⇒ ::Google::Cloud::Gaming::V1::GameServerCluster

    Pass arguments to get_game_server_cluster via a request object, either of type Google::Cloud::Gaming::V1::GetGameServerClusterRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Gaming::V1::GetGameServerClusterRequest, ::Hash)

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil)

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_game_server_cluster(name: nil, view: nil) ⇒ ::Google::Cloud::Gaming::V1::GameServerCluster

    Pass arguments to get_game_server_cluster via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil)

      Required. The name of the game server cluster to retrieve, in the following form: projects/{project}/locations/{location}/realms/{realm-id}/gameServerClusters/{cluster}.

    • view (::Google::Cloud::Gaming::V1::GameServerClusterView) (defaults to: nil)

      Optional. View for the returned GameServerCluster objects. When FULL is specified, the cluster_state field is also returned in the GameServerCluster object, which includes the state of the referenced Kubernetes cluster such as versions and provider info. The default/unset value is GAME_SERVER_CLUSTER_VIEW_UNSPECIFIED, same as BASIC, which does not return the cluster_state field.

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error)

    if the RPC is aborted.



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
# File 'lib/google/cloud/gaming/v1/game_server_clusters_service/client.rb', line 318

def get_game_server_cluster request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Gaming::V1::GetGameServerClusterRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
   = @config.rpcs.get_game_server_cluster..to_h

  # Set x-goog-api-client and x-goog-user-project headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Gaming::V1::VERSION
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  [:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_game_server_cluster.timeout,
                         metadata:     ,
                         retry_policy: @config.rpcs.get_game_server_cluster.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.,
                         retry_policy: @config.retry_policy

  @game_server_clusters_service_stub.call_rpc :get_game_server_cluster, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_game_server_clusters(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Gaming::V1::GameServerCluster> #list_game_server_clusters(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil, view: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Gaming::V1::GameServerCluster>

Lists game server clusters in a given project and location.

Overloads:

  • #list_game_server_clusters(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Gaming::V1::GameServerCluster>

    Pass arguments to list_game_server_clusters via a request object, either of type ListGameServerClustersRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Gaming::V1::ListGameServerClustersRequest, ::Hash)

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil)

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_game_server_clusters(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil, view: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Gaming::V1::GameServerCluster>

    Pass arguments to list_game_server_clusters via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil)

      Required. The parent resource name, in the following form: "projects/{project}/locations/{location}/realms/{realm}".

    • page_size (::Integer) (defaults to: nil)

      Optional. The maximum number of items to return. If unspecified, the server will pick an appropriate default. The server may return fewer items than requested. A caller should only rely on response's next_page_token to determine if there are more GameServerClusters left to be queried.

    • page_token (::String) (defaults to: nil)

      Optional. The next_page_token value returned from a previous List request, if any.

    • filter (::String) (defaults to: nil)

      Optional. The filter to apply to list results.

    • order_by (::String) (defaults to: nil)

      Optional. Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order.

    • view (::Google::Cloud::Gaming::V1::GameServerClusterView) (defaults to: nil)

      Optional. View for the returned GameServerCluster objects. When FULL is specified, the cluster_state field is also returned in the GameServerCluster object, which includes the state of the referenced Kubernetes cluster such as versions and provider info. The default/unset value is GAME_SERVER_CLUSTER_VIEW_UNSPECIFIED, same as BASIC, which does not return the cluster_state field.

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error)

    if the RPC is aborted.



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
# File 'lib/google/cloud/gaming/v1/game_server_clusters_service/client.rb', line 241

def list_game_server_clusters request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Gaming::V1::ListGameServerClustersRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
   = @config.rpcs.list_game_server_clusters..to_h

  # Set x-goog-api-client and x-goog-user-project headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Gaming::V1::VERSION
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  [:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_game_server_clusters.timeout,
                         metadata:     ,
                         retry_policy: @config.rpcs.list_game_server_clusters.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.,
                         retry_policy: @config.retry_policy

  @game_server_clusters_service_stub.call_rpc :list_game_server_clusters, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @game_server_clusters_service_stub, :list_game_server_clusters, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#preview_create_game_server_cluster(request, options = nil) ⇒ ::Google::Cloud::Gaming::V1::PreviewCreateGameServerClusterResponse #preview_create_game_server_cluster(parent: nil, game_server_cluster_id: nil, game_server_cluster: nil, preview_time: nil, view: nil) ⇒ ::Google::Cloud::Gaming::V1::PreviewCreateGameServerClusterResponse

Previews creation of a new game server cluster in a given project and location.

Overloads:

  • #preview_create_game_server_cluster(request, options = nil) ⇒ ::Google::Cloud::Gaming::V1::PreviewCreateGameServerClusterResponse

    Pass arguments to preview_create_game_server_cluster via a request object, either of type PreviewCreateGameServerClusterRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Gaming::V1::PreviewCreateGameServerClusterRequest, ::Hash)

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil)

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #preview_create_game_server_cluster(parent: nil, game_server_cluster_id: nil, game_server_cluster: nil, preview_time: nil, view: nil) ⇒ ::Google::Cloud::Gaming::V1::PreviewCreateGameServerClusterResponse

    Pass arguments to preview_create_game_server_cluster via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil)

      Required. The parent resource name, in the following form: projects/{project}/locations/{location}/realms/{realm}.

    • game_server_cluster_id (::String) (defaults to: nil)

      Required. The ID of the game server cluster resource to be created.

    • game_server_cluster (::Google::Cloud::Gaming::V1::GameServerCluster, ::Hash) (defaults to: nil)

      Required. The game server cluster resource to be created.

    • preview_time (::Google::Protobuf::Timestamp, ::Hash) (defaults to: nil)

      Optional. The target timestamp to compute the preview.

    • view (::Google::Cloud::Gaming::V1::GameServerClusterView) (defaults to: nil)

      Optional. This field is deprecated, preview will always return KubernetesClusterState.

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error)

    if the RPC is aborted.



471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
# File 'lib/google/cloud/gaming/v1/game_server_clusters_service/client.rb', line 471

def preview_create_game_server_cluster request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Gaming::V1::PreviewCreateGameServerClusterRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
   = @config.rpcs.preview_create_game_server_cluster..to_h

  # Set x-goog-api-client and x-goog-user-project headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Gaming::V1::VERSION
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  [:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.preview_create_game_server_cluster.timeout,
                         metadata:     ,
                         retry_policy: @config.rpcs.preview_create_game_server_cluster.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.,
                         retry_policy: @config.retry_policy

  @game_server_clusters_service_stub.call_rpc :preview_create_game_server_cluster, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#preview_delete_game_server_cluster(request, options = nil) ⇒ ::Google::Cloud::Gaming::V1::PreviewDeleteGameServerClusterResponse #preview_delete_game_server_cluster(name: nil, preview_time: nil) ⇒ ::Google::Cloud::Gaming::V1::PreviewDeleteGameServerClusterResponse

Previews deletion of a single game server cluster.

Overloads:

  • #preview_delete_game_server_cluster(request, options = nil) ⇒ ::Google::Cloud::Gaming::V1::PreviewDeleteGameServerClusterResponse

    Pass arguments to preview_delete_game_server_cluster via a request object, either of type PreviewDeleteGameServerClusterRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Gaming::V1::PreviewDeleteGameServerClusterRequest, ::Hash)

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil)

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #preview_delete_game_server_cluster(name: nil, preview_time: nil) ⇒ ::Google::Cloud::Gaming::V1::PreviewDeleteGameServerClusterResponse

    Pass arguments to preview_delete_game_server_cluster via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil)

      Required. The name of the game server cluster to delete, in the following form: projects/{project}/locations/{location}/gameServerClusters/{cluster}.

    • preview_time (::Google::Protobuf::Timestamp, ::Hash) (defaults to: nil)

      Optional. The target timestamp to compute the preview.

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error)

    if the RPC is aborted.



612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
# File 'lib/google/cloud/gaming/v1/game_server_clusters_service/client.rb', line 612

def preview_delete_game_server_cluster request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Gaming::V1::PreviewDeleteGameServerClusterRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
   = @config.rpcs.preview_delete_game_server_cluster..to_h

  # Set x-goog-api-client and x-goog-user-project headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Gaming::V1::VERSION
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  [:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.preview_delete_game_server_cluster.timeout,
                         metadata:     ,
                         retry_policy: @config.rpcs.preview_delete_game_server_cluster.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.,
                         retry_policy: @config.retry_policy

  @game_server_clusters_service_stub.call_rpc :preview_delete_game_server_cluster, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#preview_update_game_server_cluster(request, options = nil) ⇒ ::Google::Cloud::Gaming::V1::PreviewUpdateGameServerClusterResponse #preview_update_game_server_cluster(game_server_cluster: nil, update_mask: nil, preview_time: nil) ⇒ ::Google::Cloud::Gaming::V1::PreviewUpdateGameServerClusterResponse

Previews updating a GameServerCluster.

Overloads:

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error)

    if the RPC is aborted.



761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
# File 'lib/google/cloud/gaming/v1/game_server_clusters_service/client.rb', line 761

def preview_update_game_server_cluster request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Gaming::V1::PreviewUpdateGameServerClusterRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
   = @config.rpcs.preview_update_game_server_cluster..to_h

  # Set x-goog-api-client and x-goog-user-project headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Gaming::V1::VERSION
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "game_server_cluster.name" => request.game_server_cluster.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  [:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.preview_update_game_server_cluster.timeout,
                         metadata:     ,
                         retry_policy: @config.rpcs.preview_update_game_server_cluster.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.,
                         retry_policy: @config.retry_policy

  @game_server_clusters_service_stub.call_rpc :preview_update_game_server_cluster, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_game_server_cluster(request, options = nil) ⇒ ::Gapic::Operation #update_game_server_cluster(game_server_cluster: nil, update_mask: nil) ⇒ ::Gapic::Operation

Patches a single game server cluster.

Overloads:

  • #update_game_server_cluster(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to update_game_server_cluster via a request object, either of type UpdateGameServerClusterRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Gaming::V1::UpdateGameServerClusterRequest, ::Hash)

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil)

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #update_game_server_cluster(game_server_cluster: nil, update_mask: nil) ⇒ ::Gapic::Operation

    Pass arguments to update_game_server_cluster via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error)

    if the RPC is aborted.



685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
# File 'lib/google/cloud/gaming/v1/game_server_clusters_service/client.rb', line 685

def update_game_server_cluster request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Gaming::V1::UpdateGameServerClusterRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
   = @config.rpcs.update_game_server_cluster..to_h

  # Set x-goog-api-client and x-goog-user-project headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Gaming::V1::VERSION
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "game_server_cluster.name" => request.game_server_cluster.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  [:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_game_server_cluster.timeout,
                         metadata:     ,
                         retry_policy: @config.rpcs.update_game_server_cluster.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.,
                         retry_policy: @config.retry_policy

  @game_server_clusters_service_stub.call_rpc :update_game_server_cluster, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end