google-cloud-gaming-v1 0.3.0 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -82,7 +82,7 @@ module Google
82
82
  # Create credentials
83
83
  credentials = @config.credentials
84
84
  credentials ||= Credentials.default scope: @config.scope
85
- if credentials.is_a?(String) || credentials.is_a?(Hash)
85
+ if credentials.is_a?(::String) || credentials.is_a?(::Hash)
86
86
  credentials = Credentials.new credentials, scope: @config.scope
87
87
  end
88
88
  @quota_project_id = @config.quota_project
@@ -169,7 +169,9 @@ module Google
169
169
  options.apply_defaults timeout: @config.rpcs.list_operations.timeout,
170
170
  metadata: metadata,
171
171
  retry_policy: @config.rpcs.list_operations.retry_policy
172
- options.apply_defaults metadata: @config.metadata,
172
+
173
+ options.apply_defaults timeout: @config.timeout,
174
+ metadata: @config.metadata,
173
175
  retry_policy: @config.retry_policy
174
176
 
175
177
  @operations_stub.call_rpc :list_operations, request, options: options do |response, operation|
@@ -239,7 +241,9 @@ module Google
239
241
  options.apply_defaults timeout: @config.rpcs.get_operation.timeout,
240
242
  metadata: metadata,
241
243
  retry_policy: @config.rpcs.get_operation.retry_policy
242
- options.apply_defaults metadata: @config.metadata,
244
+
245
+ options.apply_defaults timeout: @config.timeout,
246
+ metadata: @config.metadata,
243
247
  retry_policy: @config.retry_policy
244
248
 
245
249
  @operations_stub.call_rpc :get_operation, request, options: options do |response, operation|
@@ -309,7 +313,9 @@ module Google
309
313
  options.apply_defaults timeout: @config.rpcs.delete_operation.timeout,
310
314
  metadata: metadata,
311
315
  retry_policy: @config.rpcs.delete_operation.retry_policy
312
- options.apply_defaults metadata: @config.metadata,
316
+
317
+ options.apply_defaults timeout: @config.timeout,
318
+ metadata: @config.metadata,
313
319
  retry_policy: @config.retry_policy
314
320
 
315
321
  @operations_stub.call_rpc :delete_operation, request, options: options do |response, operation|
@@ -384,7 +390,9 @@ module Google
384
390
  options.apply_defaults timeout: @config.rpcs.cancel_operation.timeout,
385
391
  metadata: metadata,
386
392
  retry_policy: @config.rpcs.cancel_operation.retry_policy
387
- options.apply_defaults metadata: @config.metadata,
393
+
394
+ options.apply_defaults timeout: @config.timeout,
395
+ metadata: @config.metadata,
388
396
  retry_policy: @config.retry_policy
389
397
 
390
398
  @operations_stub.call_rpc :cancel_operation, request, options: options do |response, operation|
@@ -396,9 +404,9 @@ module Google
396
404
  end
397
405
 
398
406
  ##
399
- # Waits for the specified long-running operation until it is done or reaches
400
- # at most a specified timeout, returning the latest state. If the operation
401
- # is already done, the latest state is immediately returned. If the timeout
407
+ # Waits until the specified long-running operation is done or reaches at most
408
+ # a specified timeout, returning the latest state. If the operation is
409
+ # already done, the latest state is immediately returned. If the timeout
402
410
  # specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
403
411
  # timeout is used. If the server does not support this method, it returns
404
412
  # `google.rpc.Code.UNIMPLEMENTED`.
@@ -456,7 +464,9 @@ module Google
456
464
  options.apply_defaults timeout: @config.rpcs.wait_operation.timeout,
457
465
  metadata: metadata,
458
466
  retry_policy: @config.rpcs.wait_operation.retry_policy
459
- options.apply_defaults metadata: @config.metadata,
467
+
468
+ options.apply_defaults timeout: @config.timeout,
469
+ metadata: @config.metadata,
460
470
  retry_policy: @config.retry_policy
461
471
 
462
472
  @operations_stub.call_rpc :wait_operation, request, options: options do |response, operation|
@@ -481,22 +491,21 @@ module Google
481
491
  # Configuration can be applied globally to all clients, or to a single client
482
492
  # on construction.
483
493
  #
484
- # # Examples
485
- #
486
- # To modify the global config, setting the timeout for list_operations
487
- # to 20 seconds, and all remaining timeouts to 10 seconds:
488
- #
489
- # ::Google::Longrunning::Operations::Client.configure do |config|
490
- # config.timeout = 10.0
491
- # config.rpcs.list_operations.timeout = 20.0
492
- # end
493
- #
494
- # To apply the above configuration only to a new client:
495
- #
496
- # client = ::Google::Longrunning::Operations::Client.new do |config|
497
- # config.timeout = 10.0
498
- # config.rpcs.list_operations.timeout = 20.0
499
- # end
494
+ # @example
495
+ #
496
+ # # Modify the global config, setting the timeout for
497
+ # # list_operations to 20 seconds,
498
+ # # and all remaining timeouts to 10 seconds.
499
+ # ::Google::Longrunning::Operations::Client.configure do |config|
500
+ # config.timeout = 10.0
501
+ # config.rpcs.list_operations.timeout = 20.0
502
+ # end
503
+ #
504
+ # # Apply the above configuration only to a new client.
505
+ # client = ::Google::Longrunning::Operations::Client.new do |config|
506
+ # config.timeout = 10.0
507
+ # config.rpcs.list_operations.timeout = 20.0
508
+ # end
500
509
  #
501
510
  # @!attribute [rw] endpoint
502
511
  # The hostname or hostname:port of the service endpoint.
@@ -41,13 +41,12 @@ module Google
41
41
  # See {::Google::Cloud::Gaming::V1::GameServerConfigsService::Client::Configuration}
42
42
  # for a description of the configuration fields.
43
43
  #
44
- # ## Example
44
+ # @example
45
45
  #
46
- # To modify the configuration for all GameServerConfigsService clients:
47
- #
48
- # ::Google::Cloud::Gaming::V1::GameServerConfigsService::Client.configure do |config|
49
- # config.timeout = 10.0
50
- # end
46
+ # # Modify the configuration for all GameServerConfigsService clients
47
+ # ::Google::Cloud::Gaming::V1::GameServerConfigsService::Client.configure do |config|
48
+ # config.timeout = 10.0
49
+ # end
51
50
  #
52
51
  # @yield [config] Configure the Client client.
53
52
  # @yieldparam config [Client::Configuration]
@@ -67,18 +66,12 @@ module Google
67
66
 
68
67
  default_config.rpcs.list_game_server_configs.timeout = 60.0
69
68
  default_config.rpcs.list_game_server_configs.retry_policy = {
70
- initial_delay: 1.0,
71
- max_delay: 10.0,
72
- multiplier: 1.3,
73
- retry_codes: [14]
69
+ initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
74
70
  }
75
71
 
76
72
  default_config.rpcs.get_game_server_config.timeout = 60.0
77
73
  default_config.rpcs.get_game_server_config.retry_policy = {
78
- initial_delay: 1.0,
79
- max_delay: 10.0,
80
- multiplier: 1.3,
81
- retry_codes: [14]
74
+ initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
82
75
  }
83
76
 
84
77
  default_config.rpcs.create_game_server_config.timeout = 60.0
@@ -114,19 +107,15 @@ module Google
114
107
  ##
115
108
  # Create a new GameServerConfigsService client object.
116
109
  #
117
- # ## Examples
118
- #
119
- # To create a new GameServerConfigsService client with the default
120
- # configuration:
110
+ # @example
121
111
  #
122
- # client = ::Google::Cloud::Gaming::V1::GameServerConfigsService::Client.new
112
+ # # Create a client using the default configuration
113
+ # client = ::Google::Cloud::Gaming::V1::GameServerConfigsService::Client.new
123
114
  #
124
- # To create a new GameServerConfigsService client with a custom
125
- # configuration:
126
- #
127
- # client = ::Google::Cloud::Gaming::V1::GameServerConfigsService::Client.new do |config|
128
- # config.timeout = 10.0
129
- # end
115
+ # # Create a client using a custom configuration
116
+ # client = ::Google::Cloud::Gaming::V1::GameServerConfigsService::Client.new do |config|
117
+ # config.timeout = 10.0
118
+ # end
130
119
  #
131
120
  # @yield [config] Configure the GameServerConfigsService client.
132
121
  # @yieldparam config [Client::Configuration]
@@ -146,14 +135,13 @@ module Google
146
135
 
147
136
  # Create credentials
148
137
  credentials = @config.credentials
149
- # Use self-signed JWT if the scope and endpoint are unchanged from default,
138
+ # Use self-signed JWT if the endpoint is unchanged from default,
150
139
  # but only if the default endpoint does not have a region prefix.
151
- enable_self_signed_jwt = @config.scope == Client.configure.scope &&
152
- @config.endpoint == Client.configure.endpoint &&
140
+ enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
153
141
  !@config.endpoint.split(".").first.include?("-")
154
142
  credentials ||= Credentials.default scope: @config.scope,
155
143
  enable_self_signed_jwt: enable_self_signed_jwt
156
- if credentials.is_a?(String) || credentials.is_a?(Hash)
144
+ if credentials.is_a?(::String) || credentials.is_a?(::Hash)
157
145
  credentials = Credentials.new credentials, scope: @config.scope
158
146
  end
159
147
  @quota_project_id = @config.quota_project
@@ -202,8 +190,7 @@ module Google
202
190
  # the default parameter values, pass an empty Hash as a request object (see above).
203
191
  #
204
192
  # @param parent [::String]
205
- # Required. The parent resource name. Uses the form:
206
- #
193
+ # Required. The parent resource name, in the following form:
207
194
  # `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/*`.
208
195
  # @param page_size [::Integer]
209
196
  # Optional. The maximum number of items to return. If unspecified, server
@@ -253,7 +240,9 @@ module Google
253
240
  options.apply_defaults timeout: @config.rpcs.list_game_server_configs.timeout,
254
241
  metadata: metadata,
255
242
  retry_policy: @config.rpcs.list_game_server_configs.retry_policy
256
- options.apply_defaults metadata: @config.metadata,
243
+
244
+ options.apply_defaults timeout: @config.timeout,
245
+ metadata: @config.metadata,
257
246
  retry_policy: @config.retry_policy
258
247
 
259
248
  @game_server_configs_service_stub.call_rpc :list_game_server_configs, request, options: options do |response, operation|
@@ -284,8 +273,7 @@ module Google
284
273
  # the default parameter values, pass an empty Hash as a request object (see above).
285
274
  #
286
275
  # @param name [::String]
287
- # Required. The name of the game server config to retrieve. Uses the form:
288
- #
276
+ # Required. The name of the game server config to retrieve, in the following form:
289
277
  # `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}`.
290
278
  #
291
279
  # @yield [response, operation] Access the result along with the RPC operation
@@ -322,7 +310,9 @@ module Google
322
310
  options.apply_defaults timeout: @config.rpcs.get_game_server_config.timeout,
323
311
  metadata: metadata,
324
312
  retry_policy: @config.rpcs.get_game_server_config.retry_policy
325
- options.apply_defaults metadata: @config.metadata,
313
+
314
+ options.apply_defaults timeout: @config.timeout,
315
+ metadata: @config.metadata,
326
316
  retry_policy: @config.retry_policy
327
317
 
328
318
  @game_server_configs_service_stub.call_rpc :get_game_server_config, request, options: options do |response, operation|
@@ -354,8 +344,7 @@ module Google
354
344
  # the default parameter values, pass an empty Hash as a request object (see above).
355
345
  #
356
346
  # @param parent [::String]
357
- # Required. The parent resource name. Uses the form:
358
- #
347
+ # Required. The parent resource name, in the following form:
359
348
  # `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/`.
360
349
  # @param config_id [::String]
361
350
  # Required. The ID of the game server config resource to be created.
@@ -396,7 +385,9 @@ module Google
396
385
  options.apply_defaults timeout: @config.rpcs.create_game_server_config.timeout,
397
386
  metadata: metadata,
398
387
  retry_policy: @config.rpcs.create_game_server_config.retry_policy
399
- options.apply_defaults metadata: @config.metadata,
388
+
389
+ options.apply_defaults timeout: @config.timeout,
390
+ metadata: @config.metadata,
400
391
  retry_policy: @config.retry_policy
401
392
 
402
393
  @game_server_configs_service_stub.call_rpc :create_game_server_config, request, options: options do |response, operation|
@@ -428,8 +419,7 @@ module Google
428
419
  # the default parameter values, pass an empty Hash as a request object (see above).
429
420
  #
430
421
  # @param name [::String]
431
- # Required. The name of the game server config to delete. Uses the form:
432
- #
422
+ # Required. The name of the game server config to delete, in the following form:
433
423
  # `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}`.
434
424
  #
435
425
  # @yield [response, operation] Access the result along with the RPC operation
@@ -466,7 +456,9 @@ module Google
466
456
  options.apply_defaults timeout: @config.rpcs.delete_game_server_config.timeout,
467
457
  metadata: metadata,
468
458
  retry_policy: @config.rpcs.delete_game_server_config.retry_policy
469
- options.apply_defaults metadata: @config.metadata,
459
+
460
+ options.apply_defaults timeout: @config.timeout,
461
+ metadata: @config.metadata,
470
462
  retry_policy: @config.retry_policy
471
463
 
472
464
  @game_server_configs_service_stub.call_rpc :delete_game_server_config, request, options: options do |response, operation|
@@ -491,22 +483,21 @@ module Google
491
483
  # Configuration can be applied globally to all clients, or to a single client
492
484
  # on construction.
493
485
  #
494
- # # Examples
495
- #
496
- # To modify the global config, setting the timeout for list_game_server_configs
497
- # to 20 seconds, and all remaining timeouts to 10 seconds:
498
- #
499
- # ::Google::Cloud::Gaming::V1::GameServerConfigsService::Client.configure do |config|
500
- # config.timeout = 10.0
501
- # config.rpcs.list_game_server_configs.timeout = 20.0
502
- # end
503
- #
504
- # To apply the above configuration only to a new client:
505
- #
506
- # client = ::Google::Cloud::Gaming::V1::GameServerConfigsService::Client.new do |config|
507
- # config.timeout = 10.0
508
- # config.rpcs.list_game_server_configs.timeout = 20.0
509
- # end
486
+ # @example
487
+ #
488
+ # # Modify the global config, setting the timeout for
489
+ # # list_game_server_configs to 20 seconds,
490
+ # # and all remaining timeouts to 10 seconds.
491
+ # ::Google::Cloud::Gaming::V1::GameServerConfigsService::Client.configure do |config|
492
+ # config.timeout = 10.0
493
+ # config.rpcs.list_game_server_configs.timeout = 20.0
494
+ # end
495
+ #
496
+ # # Apply the above configuration only to a new client.
497
+ # client = ::Google::Cloud::Gaming::V1::GameServerConfigsService::Client.new do |config|
498
+ # config.timeout = 10.0
499
+ # config.rpcs.list_game_server_configs.timeout = 20.0
500
+ # end
510
501
  #
511
502
  # @!attribute [rw] endpoint
512
503
  # The hostname or hostname:port of the service endpoint.
@@ -82,7 +82,7 @@ module Google
82
82
  # Create credentials
83
83
  credentials = @config.credentials
84
84
  credentials ||= Credentials.default scope: @config.scope
85
- if credentials.is_a?(String) || credentials.is_a?(Hash)
85
+ if credentials.is_a?(::String) || credentials.is_a?(::Hash)
86
86
  credentials = Credentials.new credentials, scope: @config.scope
87
87
  end
88
88
  @quota_project_id = @config.quota_project
@@ -169,7 +169,9 @@ module Google
169
169
  options.apply_defaults timeout: @config.rpcs.list_operations.timeout,
170
170
  metadata: metadata,
171
171
  retry_policy: @config.rpcs.list_operations.retry_policy
172
- options.apply_defaults metadata: @config.metadata,
172
+
173
+ options.apply_defaults timeout: @config.timeout,
174
+ metadata: @config.metadata,
173
175
  retry_policy: @config.retry_policy
174
176
 
175
177
  @operations_stub.call_rpc :list_operations, request, options: options do |response, operation|
@@ -239,7 +241,9 @@ module Google
239
241
  options.apply_defaults timeout: @config.rpcs.get_operation.timeout,
240
242
  metadata: metadata,
241
243
  retry_policy: @config.rpcs.get_operation.retry_policy
242
- options.apply_defaults metadata: @config.metadata,
244
+
245
+ options.apply_defaults timeout: @config.timeout,
246
+ metadata: @config.metadata,
243
247
  retry_policy: @config.retry_policy
244
248
 
245
249
  @operations_stub.call_rpc :get_operation, request, options: options do |response, operation|
@@ -309,7 +313,9 @@ module Google
309
313
  options.apply_defaults timeout: @config.rpcs.delete_operation.timeout,
310
314
  metadata: metadata,
311
315
  retry_policy: @config.rpcs.delete_operation.retry_policy
312
- options.apply_defaults metadata: @config.metadata,
316
+
317
+ options.apply_defaults timeout: @config.timeout,
318
+ metadata: @config.metadata,
313
319
  retry_policy: @config.retry_policy
314
320
 
315
321
  @operations_stub.call_rpc :delete_operation, request, options: options do |response, operation|
@@ -384,7 +390,9 @@ module Google
384
390
  options.apply_defaults timeout: @config.rpcs.cancel_operation.timeout,
385
391
  metadata: metadata,
386
392
  retry_policy: @config.rpcs.cancel_operation.retry_policy
387
- options.apply_defaults metadata: @config.metadata,
393
+
394
+ options.apply_defaults timeout: @config.timeout,
395
+ metadata: @config.metadata,
388
396
  retry_policy: @config.retry_policy
389
397
 
390
398
  @operations_stub.call_rpc :cancel_operation, request, options: options do |response, operation|
@@ -396,9 +404,9 @@ module Google
396
404
  end
397
405
 
398
406
  ##
399
- # Waits for the specified long-running operation until it is done or reaches
400
- # at most a specified timeout, returning the latest state. If the operation
401
- # is already done, the latest state is immediately returned. If the timeout
407
+ # Waits until the specified long-running operation is done or reaches at most
408
+ # a specified timeout, returning the latest state. If the operation is
409
+ # already done, the latest state is immediately returned. If the timeout
402
410
  # specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
403
411
  # timeout is used. If the server does not support this method, it returns
404
412
  # `google.rpc.Code.UNIMPLEMENTED`.
@@ -456,7 +464,9 @@ module Google
456
464
  options.apply_defaults timeout: @config.rpcs.wait_operation.timeout,
457
465
  metadata: metadata,
458
466
  retry_policy: @config.rpcs.wait_operation.retry_policy
459
- options.apply_defaults metadata: @config.metadata,
467
+
468
+ options.apply_defaults timeout: @config.timeout,
469
+ metadata: @config.metadata,
460
470
  retry_policy: @config.retry_policy
461
471
 
462
472
  @operations_stub.call_rpc :wait_operation, request, options: options do |response, operation|
@@ -481,22 +491,21 @@ module Google
481
491
  # Configuration can be applied globally to all clients, or to a single client
482
492
  # on construction.
483
493
  #
484
- # # Examples
485
- #
486
- # To modify the global config, setting the timeout for list_operations
487
- # to 20 seconds, and all remaining timeouts to 10 seconds:
488
- #
489
- # ::Google::Longrunning::Operations::Client.configure do |config|
490
- # config.timeout = 10.0
491
- # config.rpcs.list_operations.timeout = 20.0
492
- # end
493
- #
494
- # To apply the above configuration only to a new client:
495
- #
496
- # client = ::Google::Longrunning::Operations::Client.new do |config|
497
- # config.timeout = 10.0
498
- # config.rpcs.list_operations.timeout = 20.0
499
- # end
494
+ # @example
495
+ #
496
+ # # Modify the global config, setting the timeout for
497
+ # # list_operations to 20 seconds,
498
+ # # and all remaining timeouts to 10 seconds.
499
+ # ::Google::Longrunning::Operations::Client.configure do |config|
500
+ # config.timeout = 10.0
501
+ # config.rpcs.list_operations.timeout = 20.0
502
+ # end
503
+ #
504
+ # # Apply the above configuration only to a new client.
505
+ # client = ::Google::Longrunning::Operations::Client.new do |config|
506
+ # config.timeout = 10.0
507
+ # config.rpcs.list_operations.timeout = 20.0
508
+ # end
500
509
  #
501
510
  # @!attribute [rw] endpoint
502
511
  # The hostname or hostname:port of the service endpoint.
@@ -42,13 +42,12 @@ module Google
42
42
  # See {::Google::Cloud::Gaming::V1::GameServerDeploymentsService::Client::Configuration}
43
43
  # for a description of the configuration fields.
44
44
  #
45
- # ## Example
45
+ # @example
46
46
  #
47
- # To modify the configuration for all GameServerDeploymentsService clients:
48
- #
49
- # ::Google::Cloud::Gaming::V1::GameServerDeploymentsService::Client.configure do |config|
50
- # config.timeout = 10.0
51
- # end
47
+ # # Modify the configuration for all GameServerDeploymentsService clients
48
+ # ::Google::Cloud::Gaming::V1::GameServerDeploymentsService::Client.configure do |config|
49
+ # config.timeout = 10.0
50
+ # end
52
51
  #
53
52
  # @yield [config] Configure the Client client.
54
53
  # @yieldparam config [Client::Configuration]
@@ -68,18 +67,12 @@ module Google
68
67
 
69
68
  default_config.rpcs.list_game_server_deployments.timeout = 60.0
70
69
  default_config.rpcs.list_game_server_deployments.retry_policy = {
71
- initial_delay: 1.0,
72
- max_delay: 10.0,
73
- multiplier: 1.3,
74
- retry_codes: [14]
70
+ initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
75
71
  }
76
72
 
77
73
  default_config.rpcs.get_game_server_deployment.timeout = 60.0
78
74
  default_config.rpcs.get_game_server_deployment.retry_policy = {
79
- initial_delay: 1.0,
80
- max_delay: 10.0,
81
- multiplier: 1.3,
82
- retry_codes: [14]
75
+ initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
83
76
  }
84
77
 
85
78
  default_config.rpcs.create_game_server_deployment.timeout = 60.0
@@ -90,28 +83,19 @@ module Google
90
83
 
91
84
  default_config.rpcs.get_game_server_deployment_rollout.timeout = 60.0
92
85
  default_config.rpcs.get_game_server_deployment_rollout.retry_policy = {
93
- initial_delay: 1.0,
94
- max_delay: 10.0,
95
- multiplier: 1.3,
96
- retry_codes: [14]
86
+ initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
97
87
  }
98
88
 
99
89
  default_config.rpcs.update_game_server_deployment_rollout.timeout = 60.0
100
90
 
101
91
  default_config.rpcs.preview_game_server_deployment_rollout.timeout = 60.0
102
92
  default_config.rpcs.preview_game_server_deployment_rollout.retry_policy = {
103
- initial_delay: 1.0,
104
- max_delay: 10.0,
105
- multiplier: 1.3,
106
- retry_codes: [14]
93
+ initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
107
94
  }
108
95
 
109
- default_config.rpcs.fetch_deployment_state.timeout = 120.0
96
+ default_config.rpcs.fetch_deployment_state.timeout = 60.0
110
97
  default_config.rpcs.fetch_deployment_state.retry_policy = {
111
- initial_delay: 1.0,
112
- max_delay: 10.0,
113
- multiplier: 1.3,
114
- retry_codes: [14]
98
+ initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
115
99
  }
116
100
 
117
101
  default_config
@@ -143,19 +127,15 @@ module Google
143
127
  ##
144
128
  # Create a new GameServerDeploymentsService client object.
145
129
  #
146
- # ## Examples
147
- #
148
- # To create a new GameServerDeploymentsService client with the default
149
- # configuration:
150
- #
151
- # client = ::Google::Cloud::Gaming::V1::GameServerDeploymentsService::Client.new
130
+ # @example
152
131
  #
153
- # To create a new GameServerDeploymentsService client with a custom
154
- # configuration:
132
+ # # Create a client using the default configuration
133
+ # client = ::Google::Cloud::Gaming::V1::GameServerDeploymentsService::Client.new
155
134
  #
156
- # client = ::Google::Cloud::Gaming::V1::GameServerDeploymentsService::Client.new do |config|
157
- # config.timeout = 10.0
158
- # end
135
+ # # Create a client using a custom configuration
136
+ # client = ::Google::Cloud::Gaming::V1::GameServerDeploymentsService::Client.new do |config|
137
+ # config.timeout = 10.0
138
+ # end
159
139
  #
160
140
  # @yield [config] Configure the GameServerDeploymentsService client.
161
141
  # @yieldparam config [Client::Configuration]
@@ -175,14 +155,13 @@ module Google
175
155
 
176
156
  # Create credentials
177
157
  credentials = @config.credentials
178
- # Use self-signed JWT if the scope and endpoint are unchanged from default,
158
+ # Use self-signed JWT if the endpoint is unchanged from default,
179
159
  # but only if the default endpoint does not have a region prefix.
180
- enable_self_signed_jwt = @config.scope == Client.configure.scope &&
181
- @config.endpoint == Client.configure.endpoint &&
160
+ enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
182
161
  !@config.endpoint.split(".").first.include?("-")
183
162
  credentials ||= Credentials.default scope: @config.scope,
184
163
  enable_self_signed_jwt: enable_self_signed_jwt
185
- if credentials.is_a?(String) || credentials.is_a?(Hash)
164
+ if credentials.is_a?(::String) || credentials.is_a?(::Hash)
186
165
  credentials = Credentials.new credentials, scope: @config.scope
187
166
  end
188
167
  @quota_project_id = @config.quota_project
@@ -230,7 +209,7 @@ module Google
230
209
  # the default parameter values, pass an empty Hash as a request object (see above).
231
210
  #
232
211
  # @param parent [::String]
233
- # Required. The parent resource name. Uses the form:
212
+ # Required. The parent resource name, in the following form:
234
213
  # `projects/{project}/locations/{location}`.
235
214
  # @param page_size [::Integer]
236
215
  # Optional. The maximum number of items to return. If unspecified, the server
@@ -281,7 +260,9 @@ module Google
281
260
  options.apply_defaults timeout: @config.rpcs.list_game_server_deployments.timeout,
282
261
  metadata: metadata,
283
262
  retry_policy: @config.rpcs.list_game_server_deployments.retry_policy
284
- options.apply_defaults metadata: @config.metadata,
263
+
264
+ options.apply_defaults timeout: @config.timeout,
265
+ metadata: @config.metadata,
285
266
  retry_policy: @config.retry_policy
286
267
 
287
268
  @game_server_deployments_service_stub.call_rpc :list_game_server_deployments, request, options: options do |response, operation|
@@ -312,8 +293,7 @@ module Google
312
293
  # the default parameter values, pass an empty Hash as a request object (see above).
313
294
  #
314
295
  # @param name [::String]
315
- # Required. The name of the game server delpoyment to retrieve. Uses the form:
316
- #
296
+ # Required. The name of the game server delpoyment to retrieve, in the following form:
317
297
  # `projects/{project}/locations/{location}/gameServerDeployments/{deployment}`.
318
298
  #
319
299
  # @yield [response, operation] Access the result along with the RPC operation
@@ -350,7 +330,9 @@ module Google
350
330
  options.apply_defaults timeout: @config.rpcs.get_game_server_deployment.timeout,
351
331
  metadata: metadata,
352
332
  retry_policy: @config.rpcs.get_game_server_deployment.retry_policy
353
- options.apply_defaults metadata: @config.metadata,
333
+
334
+ options.apply_defaults timeout: @config.timeout,
335
+ metadata: @config.metadata,
354
336
  retry_policy: @config.retry_policy
355
337
 
356
338
  @game_server_deployments_service_stub.call_rpc :get_game_server_deployment, request, options: options do |response, operation|
@@ -380,7 +362,7 @@ module Google
380
362
  # the default parameter values, pass an empty Hash as a request object (see above).
381
363
  #
382
364
  # @param parent [::String]
383
- # Required. The parent resource name. Uses the form:
365
+ # Required. The parent resource name, in the following form:
384
366
  # `projects/{project}/locations/{location}`.
385
367
  # @param deployment_id [::String]
386
368
  # Required. The ID of the game server delpoyment resource to be created.
@@ -421,7 +403,9 @@ module Google
421
403
  options.apply_defaults timeout: @config.rpcs.create_game_server_deployment.timeout,
422
404
  metadata: metadata,
423
405
  retry_policy: @config.rpcs.create_game_server_deployment.retry_policy
424
- options.apply_defaults metadata: @config.metadata,
406
+
407
+ options.apply_defaults timeout: @config.timeout,
408
+ metadata: @config.metadata,
425
409
  retry_policy: @config.retry_policy
426
410
 
427
411
  @game_server_deployments_service_stub.call_rpc :create_game_server_deployment, request, options: options do |response, operation|
@@ -452,8 +436,7 @@ module Google
452
436
  # the default parameter values, pass an empty Hash as a request object (see above).
453
437
  #
454
438
  # @param name [::String]
455
- # Required. The name of the game server delpoyment to delete. Uses the form:
456
- #
439
+ # Required. The name of the game server delpoyment to delete, in the following form:
457
440
  # `projects/{project}/locations/{location}/gameServerDeployments/{deployment}`.
458
441
  #
459
442
  # @yield [response, operation] Access the result along with the RPC operation
@@ -490,7 +473,9 @@ module Google
490
473
  options.apply_defaults timeout: @config.rpcs.delete_game_server_deployment.timeout,
491
474
  metadata: metadata,
492
475
  retry_policy: @config.rpcs.delete_game_server_deployment.retry_policy
493
- options.apply_defaults metadata: @config.metadata,
476
+
477
+ options.apply_defaults timeout: @config.timeout,
478
+ metadata: @config.metadata,
494
479
  retry_policy: @config.retry_policy
495
480
 
496
481
  @game_server_deployments_service_stub.call_rpc :delete_game_server_deployment, request, options: options do |response, operation|
@@ -526,10 +511,7 @@ module Google
526
511
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
527
512
  # Required. Mask of fields to update. At least one path must be supplied in
528
513
  # this field. For the `FieldMask` definition, see
529
- #
530
- # https:
531
- # //developers.google.com/protocol-buffers
532
- # // /docs/reference/google.protobuf#fieldmask
514
+ # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
533
515
  #
534
516
  # @yield [response, operation] Access the result along with the RPC operation
535
517
  # @yieldparam response [::Gapic::Operation]
@@ -565,7 +547,9 @@ module Google
565
547
  options.apply_defaults timeout: @config.rpcs.update_game_server_deployment.timeout,
566
548
  metadata: metadata,
567
549
  retry_policy: @config.rpcs.update_game_server_deployment.retry_policy
568
- options.apply_defaults metadata: @config.metadata,
550
+
551
+ options.apply_defaults timeout: @config.timeout,
552
+ metadata: @config.metadata,
569
553
  retry_policy: @config.retry_policy
570
554
 
571
555
  @game_server_deployments_service_stub.call_rpc :update_game_server_deployment, request, options: options do |response, operation|
@@ -596,8 +580,7 @@ module Google
596
580
  # the default parameter values, pass an empty Hash as a request object (see above).
597
581
  #
598
582
  # @param name [::String]
599
- # Required. The name of the game server delpoyment to retrieve. Uses the form:
600
- #
583
+ # Required. The name of the game server delpoyment to retrieve, in the following form:
601
584
  # `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout`.
602
585
  #
603
586
  # @yield [response, operation] Access the result along with the RPC operation
@@ -634,7 +617,9 @@ module Google
634
617
  options.apply_defaults timeout: @config.rpcs.get_game_server_deployment_rollout.timeout,
635
618
  metadata: metadata,
636
619
  retry_policy: @config.rpcs.get_game_server_deployment_rollout.retry_policy
637
- options.apply_defaults metadata: @config.metadata,
620
+
621
+ options.apply_defaults timeout: @config.timeout,
622
+ metadata: @config.metadata,
638
623
  retry_policy: @config.retry_policy
639
624
 
640
625
  @game_server_deployments_service_stub.call_rpc :get_game_server_deployment_rollout, request, options: options do |response, operation|
@@ -674,10 +659,7 @@ module Google
674
659
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
675
660
  # Required. Mask of fields to update. At least one path must be supplied in
676
661
  # this field. For the `FieldMask` definition, see
677
- #
678
- # https:
679
- # //developers.google.com/protocol-buffers
680
- # // /docs/reference/google.protobuf#fieldmask
662
+ # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
681
663
  #
682
664
  # @yield [response, operation] Access the result along with the RPC operation
683
665
  # @yieldparam response [::Gapic::Operation]
@@ -713,7 +695,9 @@ module Google
713
695
  options.apply_defaults timeout: @config.rpcs.update_game_server_deployment_rollout.timeout,
714
696
  metadata: metadata,
715
697
  retry_policy: @config.rpcs.update_game_server_deployment_rollout.retry_policy
716
- options.apply_defaults metadata: @config.metadata,
698
+
699
+ options.apply_defaults timeout: @config.timeout,
700
+ metadata: @config.metadata,
717
701
  retry_policy: @config.retry_policy
718
702
 
719
703
  @game_server_deployments_service_stub.call_rpc :update_game_server_deployment_rollout, request, options: options do |response, operation|
@@ -750,10 +734,7 @@ module Google
750
734
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
751
735
  # Optional. Mask of fields to update. At least one path must be supplied in
752
736
  # this field. For the `FieldMask` definition, see
753
- #
754
- # https:
755
- # //developers.google.com/protocol-buffers
756
- # // /docs/reference/google.protobuf#fieldmask
737
+ # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
757
738
  # @param preview_time [::Google::Protobuf::Timestamp, ::Hash]
758
739
  # Optional. The target timestamp to compute the preview. Defaults to the immediately
759
740
  # after the proposed rollout completes.
@@ -792,7 +773,9 @@ module Google
792
773
  options.apply_defaults timeout: @config.rpcs.preview_game_server_deployment_rollout.timeout,
793
774
  metadata: metadata,
794
775
  retry_policy: @config.rpcs.preview_game_server_deployment_rollout.retry_policy
795
- options.apply_defaults metadata: @config.metadata,
776
+
777
+ options.apply_defaults timeout: @config.timeout,
778
+ metadata: @config.metadata,
796
779
  retry_policy: @config.retry_policy
797
780
 
798
781
  @game_server_deployments_service_stub.call_rpc :preview_game_server_deployment_rollout, request, options: options do |response, operation|
@@ -824,8 +807,7 @@ module Google
824
807
  # the default parameter values, pass an empty Hash as a request object (see above).
825
808
  #
826
809
  # @param name [::String]
827
- # Required. The name of the game server delpoyment. Uses the form:
828
- #
810
+ # Required. The name of the game server delpoyment, in the following form:
829
811
  # `projects/{project}/locations/{location}/gameServerDeployments/{deployment}`.
830
812
  #
831
813
  # @yield [response, operation] Access the result along with the RPC operation
@@ -862,7 +844,9 @@ module Google
862
844
  options.apply_defaults timeout: @config.rpcs.fetch_deployment_state.timeout,
863
845
  metadata: metadata,
864
846
  retry_policy: @config.rpcs.fetch_deployment_state.retry_policy
865
- options.apply_defaults metadata: @config.metadata,
847
+
848
+ options.apply_defaults timeout: @config.timeout,
849
+ metadata: @config.metadata,
866
850
  retry_policy: @config.retry_policy
867
851
 
868
852
  @game_server_deployments_service_stub.call_rpc :fetch_deployment_state, request, options: options do |response, operation|
@@ -886,22 +870,21 @@ module Google
886
870
  # Configuration can be applied globally to all clients, or to a single client
887
871
  # on construction.
888
872
  #
889
- # # Examples
890
- #
891
- # To modify the global config, setting the timeout for list_game_server_deployments
892
- # to 20 seconds, and all remaining timeouts to 10 seconds:
893
- #
894
- # ::Google::Cloud::Gaming::V1::GameServerDeploymentsService::Client.configure do |config|
895
- # config.timeout = 10.0
896
- # config.rpcs.list_game_server_deployments.timeout = 20.0
897
- # end
898
- #
899
- # To apply the above configuration only to a new client:
900
- #
901
- # client = ::Google::Cloud::Gaming::V1::GameServerDeploymentsService::Client.new do |config|
902
- # config.timeout = 10.0
903
- # config.rpcs.list_game_server_deployments.timeout = 20.0
904
- # end
873
+ # @example
874
+ #
875
+ # # Modify the global config, setting the timeout for
876
+ # # list_game_server_deployments to 20 seconds,
877
+ # # and all remaining timeouts to 10 seconds.
878
+ # ::Google::Cloud::Gaming::V1::GameServerDeploymentsService::Client.configure do |config|
879
+ # config.timeout = 10.0
880
+ # config.rpcs.list_game_server_deployments.timeout = 20.0
881
+ # end
882
+ #
883
+ # # Apply the above configuration only to a new client.
884
+ # client = ::Google::Cloud::Gaming::V1::GameServerDeploymentsService::Client.new do |config|
885
+ # config.timeout = 10.0
886
+ # config.rpcs.list_game_server_deployments.timeout = 20.0
887
+ # end
905
888
  #
906
889
  # @!attribute [rw] endpoint
907
890
  # The hostname or hostname:port of the service endpoint.