Class: Google::Cloud::Gaming::V1::GameServerDeploymentsService::Client

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

Overview

Client for the GameServerDeploymentsService service.

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

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#game_server_deployment_path, #game_server_deployment_rollout_path, #location_path

Constructor Details

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

Create a new GameServerDeploymentsService client object.

Examples:


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

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

Yields:

  • (config)

    Configure the GameServerDeploymentsService client.

Yield Parameters:



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
181
182
# File 'lib/google/cloud/gaming/v1/game_server_deployments_service/client.rb', line 143

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_deployments_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_deployments_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::Gaming::V1::GameServerDeploymentsService::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Instance Attribute Details

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

Get the associated client for long-running operations.



189
190
191
# File 'lib/google/cloud/gaming/v1/game_server_deployments_service/client.rb', line 189

def operations_client
  @operations_client
end

Class Method Details

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

Configure the GameServerDeploymentsService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all GameServerDeploymentsService clients
::Google::Cloud::Gaming::V1::GameServerDeploymentsService::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
104
105
# File 'lib/google/cloud/gaming/v1/game_server_deployments_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_deployments.timeout = 60.0
    default_config.rpcs.list_game_server_deployments.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

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

    default_config.rpcs.create_game_server_deployment.timeout = 60.0

    default_config.rpcs.delete_game_server_deployment.timeout = 60.0

    default_config.rpcs.update_game_server_deployment.timeout = 60.0

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

    default_config.rpcs.update_game_server_deployment_rollout.timeout = 60.0

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

    default_config.rpcs.fetch_deployment_state.timeout = 60.0
    default_config.rpcs.fetch_deployment_state.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 GameServerDeploymentsService 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:



122
123
124
125
# File 'lib/google/cloud/gaming/v1/game_server_deployments_service/client.rb', line 122

def configure
  yield @config if block_given?
  @config
end

#create_game_server_deployment(request, options = nil) ⇒ ::Gapic::Operation #create_game_server_deployment(parent: nil, deployment_id: nil, game_server_deployment: nil) ⇒ ::Gapic::Operation

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

Examples:

Basic example

require "google/cloud/gaming/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Gaming::V1::GameServerDeploymentsService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Gaming::V1::CreateGameServerDeploymentRequest.new

# Call the create_game_server_deployment method.
result = client.create_game_server_deployment request

# The returned object is of type Gapic::Operation. You can use this
# object to check the status of an operation, cancel it, or wait
# for results. Here is how to block until completion:
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "Error!"
end

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Gaming::V1::CreateGameServerDeploymentRequest, ::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_deployment(parent: nil, deployment_id: nil, game_server_deployment: nil) ⇒ ::Gapic::Operation

    Pass arguments to create_game_server_deployment 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}.

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

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

    • game_server_deployment (::Google::Cloud::Gaming::V1::GameServerDeployment, ::Hash) (defaults to: nil)

      Required. The game server delpoyment 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.



442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
# File 'lib/google/cloud/gaming/v1/game_server_deployments_service/client.rb', line 442

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

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

  # 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_deployment..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 = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  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_deployment.timeout,
                         metadata:     ,
                         retry_policy: @config.rpcs.create_game_server_deployment.retry_policy

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

  @game_server_deployments_service_stub.call_rpc :create_game_server_deployment, 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_deployment(request, options = nil) ⇒ ::Gapic::Operation #delete_game_server_deployment(name: nil) ⇒ ::Gapic::Operation

Deletes a single game server deployment.

Examples:

Basic example

require "google/cloud/gaming/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Gaming::V1::GameServerDeploymentsService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Gaming::V1::DeleteGameServerDeploymentRequest.new

# Call the delete_game_server_deployment method.
result = client.delete_game_server_deployment request

# The returned object is of type Gapic::Operation. You can use this
# object to check the status of an operation, cancel it, or wait
# for results. Here is how to block until completion:
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "Error!"
end

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Gaming::V1::DeleteGameServerDeploymentRequest, ::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_deployment(name: nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_game_server_deployment 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 delpoyment to delete, in the following form: projects/{project}/locations/{location}/gameServerDeployments/{deployment}.

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.



536
537
538
539
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
# File 'lib/google/cloud/gaming/v1/game_server_deployments_service/client.rb', line 536

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

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

  # 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_deployment..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 = {}
  if request.name
    header_params["name"] = request.name
  end

  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_deployment.timeout,
                         metadata:     ,
                         retry_policy: @config.rpcs.delete_game_server_deployment.retry_policy

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

  @game_server_deployments_service_stub.call_rpc :delete_game_server_deployment, 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

#fetch_deployment_state(request, options = nil) ⇒ ::Google::Cloud::Gaming::V1::FetchDeploymentStateResponse #fetch_deployment_state(name: nil) ⇒ ::Google::Cloud::Gaming::V1::FetchDeploymentStateResponse

Retrieves information about the current state of the game server deployment. Gathers all the Agones fleets and Agones autoscalers, including fleets running an older version of the game server deployment.

Examples:

Basic example

require "google/cloud/gaming/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Gaming::V1::GameServerDeploymentsService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Gaming::V1::FetchDeploymentStateRequest.new

# Call the fetch_deployment_state method.
result = client.fetch_deployment_state request

# The returned object is of type Google::Cloud::Gaming::V1::FetchDeploymentStateResponse.
p result

Overloads:

  • #fetch_deployment_state(request, options = nil) ⇒ ::Google::Cloud::Gaming::V1::FetchDeploymentStateResponse

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

    Parameters:

    • request (::Google::Cloud::Gaming::V1::FetchDeploymentStateRequest, ::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.

  • #fetch_deployment_state(name: nil) ⇒ ::Google::Cloud::Gaming::V1::FetchDeploymentStateResponse

    Pass arguments to fetch_deployment_state 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 delpoyment, in the following form: projects/{project}/locations/{location}/gameServerDeployments/{deployment}.

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
# File 'lib/google/cloud/gaming/v1/game_server_deployments_service/client.rb', line 1006

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

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

  # 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.fetch_deployment_state..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 = {}
  if request.name
    header_params["name"] = request.name
  end

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

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

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

  @game_server_deployments_service_stub.call_rpc :fetch_deployment_state, 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

#get_game_server_deployment(request, options = nil) ⇒ ::Google::Cloud::Gaming::V1::GameServerDeployment #get_game_server_deployment(name: nil) ⇒ ::Google::Cloud::Gaming::V1::GameServerDeployment

Gets details of a single game server deployment.

Examples:

Basic example

require "google/cloud/gaming/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Gaming::V1::GameServerDeploymentsService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Gaming::V1::GetGameServerDeploymentRequest.new

# Call the get_game_server_deployment method.
result = client.get_game_server_deployment request

# The returned object is of type Google::Cloud::Gaming::V1::GameServerDeployment.
p result

Overloads:

  • #get_game_server_deployment(request, options = nil) ⇒ ::Google::Cloud::Gaming::V1::GameServerDeployment

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

    Parameters:

    • request (::Google::Cloud::Gaming::V1::GetGameServerDeploymentRequest, ::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_deployment(name: nil) ⇒ ::Google::Cloud::Gaming::V1::GameServerDeployment

    Pass arguments to get_game_server_deployment 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 delpoyment to retrieve, in the following form: projects/{project}/locations/{location}/gameServerDeployments/{deployment}.

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
# File 'lib/google/cloud/gaming/v1/game_server_deployments_service/client.rb', line 345

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

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

  # 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_deployment..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 = {}
  if request.name
    header_params["name"] = request.name
  end

  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_deployment.timeout,
                         metadata:     ,
                         retry_policy: @config.rpcs.get_game_server_deployment.retry_policy

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

  @game_server_deployments_service_stub.call_rpc :get_game_server_deployment, 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

#get_game_server_deployment_rollout(request, options = nil) ⇒ ::Google::Cloud::Gaming::V1::GameServerDeploymentRollout #get_game_server_deployment_rollout(name: nil) ⇒ ::Google::Cloud::Gaming::V1::GameServerDeploymentRollout

Gets details a single game server deployment rollout.

Examples:

Basic example

require "google/cloud/gaming/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Gaming::V1::GameServerDeploymentsService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Gaming::V1::GetGameServerDeploymentRolloutRequest.new

# Call the get_game_server_deployment_rollout method.
result = client.get_game_server_deployment_rollout request

# The returned object is of type Google::Cloud::Gaming::V1::GameServerDeploymentRollout.
p result

Overloads:

  • #get_game_server_deployment_rollout(request, options = nil) ⇒ ::Google::Cloud::Gaming::V1::GameServerDeploymentRollout

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

    Parameters:

    • request (::Google::Cloud::Gaming::V1::GetGameServerDeploymentRolloutRequest, ::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_deployment_rollout(name: nil) ⇒ ::Google::Cloud::Gaming::V1::GameServerDeploymentRollout

    Pass arguments to get_game_server_deployment_rollout 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 delpoyment to retrieve, in the following form: projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout.

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
# File 'lib/google/cloud/gaming/v1/game_server_deployments_service/client.rb', line 721

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

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

  # 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_deployment_rollout..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 = {}
  if request.name
    header_params["name"] = request.name
  end

  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_deployment_rollout.timeout,
                         metadata:     ,
                         retry_policy: @config.rpcs.get_game_server_deployment_rollout.retry_policy

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

  @game_server_deployments_service_stub.call_rpc :get_game_server_deployment_rollout, 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_deployments(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Gaming::V1::GameServerDeployment> #list_game_server_deployments(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Gaming::V1::GameServerDeployment>

Lists game server deployments in a given project and location.

Examples:

Basic example

require "google/cloud/gaming/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Gaming::V1::GameServerDeploymentsService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Gaming::V1::ListGameServerDeploymentsRequest.new

# Call the list_game_server_deployments method.
result = client.list_game_server_deployments request

# The returned object is of type Gapic::PagedEnumerable. You can
# iterate over all elements by calling #each, and the enumerable
# will lazily make API calls to fetch subsequent pages. Other
# methods are also available for managing paging directly.
result.each do |response|
  # Each element is of type ::Google::Cloud::Gaming::V1::GameServerDeployment.
  p response
end

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Gaming::V1::ListGameServerDeploymentsRequest, ::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_deployments(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Gaming::V1::GameServerDeployment>

    Pass arguments to list_game_server_deployments 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}.

    • 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 GameServerDeployments 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.

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
# File 'lib/google/cloud/gaming/v1/game_server_deployments_service/client.rb', line 258

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

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

  # 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_deployments..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 = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  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_deployments.timeout,
                         metadata:     ,
                         retry_policy: @config.rpcs.list_game_server_deployments.retry_policy

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

  @game_server_deployments_service_stub.call_rpc :list_game_server_deployments, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @game_server_deployments_service_stub, :list_game_server_deployments, 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_game_server_deployment_rollout(request, options = nil) ⇒ ::Google::Cloud::Gaming::V1::PreviewGameServerDeploymentRolloutResponse #preview_game_server_deployment_rollout(rollout: nil, update_mask: nil, preview_time: nil) ⇒ ::Google::Cloud::Gaming::V1::PreviewGameServerDeploymentRolloutResponse

Previews the game server deployment rollout. This API does not mutate the rollout resource.

Examples:

Basic example

require "google/cloud/gaming/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Gaming::V1::GameServerDeploymentsService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Gaming::V1::PreviewGameServerDeploymentRolloutRequest.new

# Call the preview_game_server_deployment_rollout method.
result = client.preview_game_server_deployment_rollout request

# The returned object is of type Google::Cloud::Gaming::V1::PreviewGameServerDeploymentRolloutResponse.
p result

Overloads:

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
# File 'lib/google/cloud/gaming/v1/game_server_deployments_service/client.rb', line 918

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

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

  # 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_game_server_deployment_rollout..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 = {}
  if request.rollout&.name
    header_params["rollout.name"] = request.rollout.name
  end

  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_game_server_deployment_rollout.timeout,
                         metadata:     ,
                         retry_policy: @config.rpcs.preview_game_server_deployment_rollout.retry_policy

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

  @game_server_deployments_service_stub.call_rpc :preview_game_server_deployment_rollout, 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_deployment(request, options = nil) ⇒ ::Gapic::Operation #update_game_server_deployment(game_server_deployment: nil, update_mask: nil) ⇒ ::Gapic::Operation

Patches a game server deployment.

Examples:

Basic example

require "google/cloud/gaming/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Gaming::V1::GameServerDeploymentsService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Gaming::V1::UpdateGameServerDeploymentRequest.new

# Call the update_game_server_deployment method.
result = client.update_game_server_deployment request

# The returned object is of type Gapic::Operation. You can use this
# object to check the status of an operation, cancel it, or wait
# for results. Here is how to block until completion:
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "Error!"
end

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Gaming::V1::UpdateGameServerDeploymentRequest, ::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_deployment(game_server_deployment: nil, update_mask: nil) ⇒ ::Gapic::Operation

    Pass arguments to update_game_server_deployment 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.



634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
# File 'lib/google/cloud/gaming/v1/game_server_deployments_service/client.rb', line 634

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

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

  # 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_deployment..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 = {}
  if request.game_server_deployment&.name
    header_params["game_server_deployment.name"] = request.game_server_deployment.name
  end

  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_deployment.timeout,
                         metadata:     ,
                         retry_policy: @config.rpcs.update_game_server_deployment.retry_policy

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

  @game_server_deployments_service_stub.call_rpc :update_game_server_deployment, 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

#update_game_server_deployment_rollout(request, options = nil) ⇒ ::Gapic::Operation #update_game_server_deployment_rollout(rollout: nil, update_mask: nil) ⇒ ::Gapic::Operation

Patches a single game server deployment rollout. The method will not return an error if the update does not affect any existing realms. For example - if the default_game_server_config is changed but all existing realms use the override, that is valid. Similarly, if a non existing realm is explicitly called out in game_server_config_overrides field, that will also not result in an error.

Examples:

Basic example

require "google/cloud/gaming/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Gaming::V1::GameServerDeploymentsService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Gaming::V1::UpdateGameServerDeploymentRolloutRequest.new

# Call the update_game_server_deployment_rollout method.
result = client.update_game_server_deployment_rollout request

# The returned object is of type Gapic::Operation. You can use this
# object to check the status of an operation, cancel it, or wait
# for results. Here is how to block until completion:
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "Error!"
end

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Gaming::V1::UpdateGameServerDeploymentRolloutRequest, ::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_deployment_rollout(rollout: nil, update_mask: nil) ⇒ ::Gapic::Operation

    Pass arguments to update_game_server_deployment_rollout 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.



823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
# File 'lib/google/cloud/gaming/v1/game_server_deployments_service/client.rb', line 823

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

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

  # 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_deployment_rollout..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 = {}
  if request.rollout&.name
    header_params["rollout.name"] = request.rollout.name
  end

  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_deployment_rollout.timeout,
                         metadata:     ,
                         retry_policy: @config.rpcs.update_game_server_deployment_rollout.retry_policy

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

  @game_server_deployments_service_stub.call_rpc :update_game_server_deployment_rollout, 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