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.
@@ -42,13 +42,12 @@ module Google
42
42
  # See {::Google::Cloud::Gaming::V1::RealmsService::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 RealmsService clients:
48
- #
49
- # ::Google::Cloud::Gaming::V1::RealmsService::Client.configure do |config|
50
- # config.timeout = 10.0
51
- # end
47
+ # # Modify the configuration for all RealmsService clients
48
+ # ::Google::Cloud::Gaming::V1::RealmsService::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_realms.timeout = 60.0
70
69
  default_config.rpcs.list_realms.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_realm.timeout = 60.0
78
74
  default_config.rpcs.get_realm.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_realm.timeout = 60.0
@@ -90,10 +83,7 @@ module Google
90
83
 
91
84
  default_config.rpcs.preview_realm_update.timeout = 60.0
92
85
  default_config.rpcs.preview_realm_update.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
@@ -125,19 +115,15 @@ module Google
125
115
  ##
126
116
  # Create a new RealmsService client object.
127
117
  #
128
- # ## Examples
129
- #
130
- # To create a new RealmsService client with the default
131
- # configuration:
118
+ # @example
132
119
  #
133
- # client = ::Google::Cloud::Gaming::V1::RealmsService::Client.new
120
+ # # Create a client using the default configuration
121
+ # client = ::Google::Cloud::Gaming::V1::RealmsService::Client.new
134
122
  #
135
- # To create a new RealmsService client with a custom
136
- # configuration:
137
- #
138
- # client = ::Google::Cloud::Gaming::V1::RealmsService::Client.new do |config|
139
- # config.timeout = 10.0
140
- # end
123
+ # # Create a client using a custom configuration
124
+ # client = ::Google::Cloud::Gaming::V1::RealmsService::Client.new do |config|
125
+ # config.timeout = 10.0
126
+ # end
141
127
  #
142
128
  # @yield [config] Configure the RealmsService client.
143
129
  # @yieldparam config [Client::Configuration]
@@ -157,14 +143,13 @@ module Google
157
143
 
158
144
  # Create credentials
159
145
  credentials = @config.credentials
160
- # Use self-signed JWT if the scope and endpoint are unchanged from default,
146
+ # Use self-signed JWT if the endpoint is unchanged from default,
161
147
  # but only if the default endpoint does not have a region prefix.
162
- enable_self_signed_jwt = @config.scope == Client.configure.scope &&
163
- @config.endpoint == Client.configure.endpoint &&
148
+ enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
164
149
  !@config.endpoint.split(".").first.include?("-")
165
150
  credentials ||= Credentials.default scope: @config.scope,
166
151
  enable_self_signed_jwt: enable_self_signed_jwt
167
- if credentials.is_a?(String) || credentials.is_a?(Hash)
152
+ if credentials.is_a?(::String) || credentials.is_a?(::Hash)
168
153
  credentials = Credentials.new credentials, scope: @config.scope
169
154
  end
170
155
  @quota_project_id = @config.quota_project
@@ -212,7 +197,7 @@ module Google
212
197
  # the default parameter values, pass an empty Hash as a request object (see above).
213
198
  #
214
199
  # @param parent [::String]
215
- # Required. The parent resource name. Uses the form:
200
+ # Required. The parent resource name, in the following form:
216
201
  # `projects/{project}/locations/{location}`.
217
202
  # @param page_size [::Integer]
218
203
  # Optional. The maximum number of items to return. If unspecified, server
@@ -263,7 +248,9 @@ module Google
263
248
  options.apply_defaults timeout: @config.rpcs.list_realms.timeout,
264
249
  metadata: metadata,
265
250
  retry_policy: @config.rpcs.list_realms.retry_policy
266
- options.apply_defaults metadata: @config.metadata,
251
+
252
+ options.apply_defaults timeout: @config.timeout,
253
+ metadata: @config.metadata,
267
254
  retry_policy: @config.retry_policy
268
255
 
269
256
  @realms_service_stub.call_rpc :list_realms, request, options: options do |response, operation|
@@ -294,7 +281,7 @@ module Google
294
281
  # the default parameter values, pass an empty Hash as a request object (see above).
295
282
  #
296
283
  # @param name [::String]
297
- # Required. The name of the realm to retrieve. Uses the form:
284
+ # Required. The name of the realm to retrieve, in the following form:
298
285
  # `projects/{project}/locations/{location}/realms/{realm}`.
299
286
  #
300
287
  # @yield [response, operation] Access the result along with the RPC operation
@@ -331,7 +318,9 @@ module Google
331
318
  options.apply_defaults timeout: @config.rpcs.get_realm.timeout,
332
319
  metadata: metadata,
333
320
  retry_policy: @config.rpcs.get_realm.retry_policy
334
- options.apply_defaults metadata: @config.metadata,
321
+
322
+ options.apply_defaults timeout: @config.timeout,
323
+ metadata: @config.metadata,
335
324
  retry_policy: @config.retry_policy
336
325
 
337
326
  @realms_service_stub.call_rpc :get_realm, request, options: options do |response, operation|
@@ -361,7 +350,7 @@ module Google
361
350
  # the default parameter values, pass an empty Hash as a request object (see above).
362
351
  #
363
352
  # @param parent [::String]
364
- # Required. The parent resource name. Uses the form:
353
+ # Required. The parent resource name, in the following form:
365
354
  # `projects/{project}/locations/{location}`.
366
355
  # @param realm_id [::String]
367
356
  # Required. The ID of the realm resource to be created.
@@ -402,7 +391,9 @@ module Google
402
391
  options.apply_defaults timeout: @config.rpcs.create_realm.timeout,
403
392
  metadata: metadata,
404
393
  retry_policy: @config.rpcs.create_realm.retry_policy
405
- options.apply_defaults metadata: @config.metadata,
394
+
395
+ options.apply_defaults timeout: @config.timeout,
396
+ metadata: @config.metadata,
406
397
  retry_policy: @config.retry_policy
407
398
 
408
399
  @realms_service_stub.call_rpc :create_realm, request, options: options do |response, operation|
@@ -433,7 +424,7 @@ module Google
433
424
  # the default parameter values, pass an empty Hash as a request object (see above).
434
425
  #
435
426
  # @param name [::String]
436
- # Required. The name of the realm to delete. Uses the form:
427
+ # Required. The name of the realm to delete, in the following form:
437
428
  # `projects/{project}/locations/{location}/realms/{realm}`.
438
429
  #
439
430
  # @yield [response, operation] Access the result along with the RPC operation
@@ -470,7 +461,9 @@ module Google
470
461
  options.apply_defaults timeout: @config.rpcs.delete_realm.timeout,
471
462
  metadata: metadata,
472
463
  retry_policy: @config.rpcs.delete_realm.retry_policy
473
- options.apply_defaults metadata: @config.metadata,
464
+
465
+ options.apply_defaults timeout: @config.timeout,
466
+ metadata: @config.metadata,
474
467
  retry_policy: @config.retry_policy
475
468
 
476
469
  @realms_service_stub.call_rpc :delete_realm, request, options: options do |response, operation|
@@ -506,10 +499,7 @@ module Google
506
499
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
507
500
  # Required. The update mask applies to the resource. For the `FieldMask`
508
501
  # definition, see
509
- #
510
- # https:
511
- # //developers.google.com/protocol-buffers
512
- # // /docs/reference/google.protobuf#fieldmask
502
+ # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
513
503
  #
514
504
  # @yield [response, operation] Access the result along with the RPC operation
515
505
  # @yieldparam response [::Gapic::Operation]
@@ -545,7 +535,9 @@ module Google
545
535
  options.apply_defaults timeout: @config.rpcs.update_realm.timeout,
546
536
  metadata: metadata,
547
537
  retry_policy: @config.rpcs.update_realm.retry_policy
548
- options.apply_defaults metadata: @config.metadata,
538
+
539
+ options.apply_defaults timeout: @config.timeout,
540
+ metadata: @config.metadata,
549
541
  retry_policy: @config.retry_policy
550
542
 
551
543
  @realms_service_stub.call_rpc :update_realm, request, options: options do |response, operation|
@@ -581,10 +573,7 @@ module Google
581
573
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
582
574
  # Required. The update mask applies to the resource. For the `FieldMask`
583
575
  # definition, see
584
- #
585
- # https:
586
- # //developers.google.com/protocol-buffers
587
- # // /docs/reference/google.protobuf#fieldmask
576
+ # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
588
577
  # @param preview_time [::Google::Protobuf::Timestamp, ::Hash]
589
578
  # Optional. The target timestamp to compute the preview.
590
579
  #
@@ -622,7 +611,9 @@ module Google
622
611
  options.apply_defaults timeout: @config.rpcs.preview_realm_update.timeout,
623
612
  metadata: metadata,
624
613
  retry_policy: @config.rpcs.preview_realm_update.retry_policy
625
- options.apply_defaults metadata: @config.metadata,
614
+
615
+ options.apply_defaults timeout: @config.timeout,
616
+ metadata: @config.metadata,
626
617
  retry_policy: @config.retry_policy
627
618
 
628
619
  @realms_service_stub.call_rpc :preview_realm_update, request, options: options do |response, operation|
@@ -646,22 +637,21 @@ module Google
646
637
  # Configuration can be applied globally to all clients, or to a single client
647
638
  # on construction.
648
639
  #
649
- # # Examples
650
- #
651
- # To modify the global config, setting the timeout for list_realms
652
- # to 20 seconds, and all remaining timeouts to 10 seconds:
653
- #
654
- # ::Google::Cloud::Gaming::V1::RealmsService::Client.configure do |config|
655
- # config.timeout = 10.0
656
- # config.rpcs.list_realms.timeout = 20.0
657
- # end
658
- #
659
- # To apply the above configuration only to a new client:
660
- #
661
- # client = ::Google::Cloud::Gaming::V1::RealmsService::Client.new do |config|
662
- # config.timeout = 10.0
663
- # config.rpcs.list_realms.timeout = 20.0
664
- # end
640
+ # @example
641
+ #
642
+ # # Modify the global config, setting the timeout for
643
+ # # list_realms to 20 seconds,
644
+ # # and all remaining timeouts to 10 seconds.
645
+ # ::Google::Cloud::Gaming::V1::RealmsService::Client.configure do |config|
646
+ # config.timeout = 10.0
647
+ # config.rpcs.list_realms.timeout = 20.0
648
+ # end
649
+ #
650
+ # # Apply the above configuration only to a new client.
651
+ # client = ::Google::Cloud::Gaming::V1::RealmsService::Client.new do |config|
652
+ # config.timeout = 10.0
653
+ # config.rpcs.list_realms.timeout = 20.0
654
+ # end
665
655
  #
666
656
  # @!attribute [rw] endpoint
667
657
  # 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.