google-cloud-talent-v4 0.10.1 → 0.12.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (27) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +72 -101
  3. data/lib/google/cloud/talent/v4/company_service/client.rb +41 -9
  4. data/lib/google/cloud/talent/v4/company_service/rest/client.rb +117 -7
  5. data/lib/google/cloud/talent/v4/company_service/rest/service_stub.rb +14 -2
  6. data/lib/google/cloud/talent/v4/completion/client.rb +41 -9
  7. data/lib/google/cloud/talent/v4/completion/rest/client.rb +49 -7
  8. data/lib/google/cloud/talent/v4/completion/rest/service_stub.rb +14 -2
  9. data/lib/google/cloud/talent/v4/event_service/client.rb +41 -9
  10. data/lib/google/cloud/talent/v4/event_service/rest/client.rb +49 -7
  11. data/lib/google/cloud/talent/v4/event_service/rest/service_stub.rb +14 -2
  12. data/lib/google/cloud/talent/v4/job_service/client.rb +42 -9
  13. data/lib/google/cloud/talent/v4/job_service/operations.rb +38 -7
  14. data/lib/google/cloud/talent/v4/job_service/rest/client.rb +219 -7
  15. data/lib/google/cloud/talent/v4/job_service/rest/operations.rb +108 -8
  16. data/lib/google/cloud/talent/v4/job_service/rest/service_stub.rb +14 -2
  17. data/lib/google/cloud/talent/v4/tenant_service/client.rb +41 -9
  18. data/lib/google/cloud/talent/v4/tenant_service/rest/client.rb +117 -7
  19. data/lib/google/cloud/talent/v4/tenant_service/rest/service_stub.rb +14 -2
  20. data/lib/google/cloud/talent/v4/version.rb +1 -1
  21. data/proto_docs/google/api/client.rb +14 -0
  22. data/proto_docs/google/api/field_behavior.rb +14 -0
  23. data/proto_docs/google/cloud/talent/v4/common.rb +1 -0
  24. data/proto_docs/google/cloud/talent/v4/company.rb +1 -0
  25. data/proto_docs/google/cloud/talent/v4/job.rb +1 -0
  26. data/proto_docs/google/cloud/talent/v4/job_service.rb +1 -0
  27. metadata +5 -5
@@ -26,6 +26,9 @@ module Google
26
26
  module JobService
27
27
  # Service that implements Longrunning Operations API.
28
28
  class Operations
29
+ # @private
30
+ DEFAULT_ENDPOINT_TEMPLATE = "jobs.$UNIVERSE_DOMAIN$"
31
+
29
32
  # @private
30
33
  attr_reader :operations_stub
31
34
 
@@ -60,6 +63,15 @@ module Google
60
63
  @config
61
64
  end
62
65
 
66
+ ##
67
+ # The effective universe domain
68
+ #
69
+ # @return [String]
70
+ #
71
+ def universe_domain
72
+ @operations_stub.universe_domain
73
+ end
74
+
63
75
  ##
64
76
  # Create a new Operations client object.
65
77
  #
@@ -90,10 +102,13 @@ module Google
90
102
 
91
103
  @operations_stub = ::Gapic::ServiceStub.new(
92
104
  ::Google::Longrunning::Operations::Stub,
93
- credentials: credentials,
94
- endpoint: @config.endpoint,
105
+ credentials: credentials,
106
+ endpoint: @config.endpoint,
107
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
108
+ universe_domain: @config.universe_domain,
95
109
  channel_args: @config.channel_args,
96
- interceptors: @config.interceptors
110
+ interceptors: @config.interceptors,
111
+ channel_pool_config: @config.channel_pool
97
112
  )
98
113
 
99
114
  # Used by an LRO wrapper for some methods of this service
@@ -612,9 +627,9 @@ module Google
612
627
  # end
613
628
  #
614
629
  # @!attribute [rw] endpoint
615
- # The hostname or hostname:port of the service endpoint.
616
- # Defaults to `"jobs.googleapis.com"`.
617
- # @return [::String]
630
+ # A custom service endpoint, as a hostname or hostname:port. The default is
631
+ # nil, indicating to use the default endpoint in the current universe domain.
632
+ # @return [::String,nil]
618
633
  # @!attribute [rw] credentials
619
634
  # Credentials to send with calls. You may provide any of the following types:
620
635
  # * (`String`) The path to a service account key file in JSON format
@@ -660,13 +675,20 @@ module Google
660
675
  # @!attribute [rw] quota_project
661
676
  # A separate project against which to charge quota.
662
677
  # @return [::String]
678
+ # @!attribute [rw] universe_domain
679
+ # The universe domain within which to make requests. This determines the
680
+ # default endpoint URL. The default value of nil uses the environment
681
+ # universe (usually the default "googleapis.com" universe).
682
+ # @return [::String,nil]
663
683
  #
664
684
  class Configuration
665
685
  extend ::Gapic::Config
666
686
 
687
+ # @private
688
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
667
689
  DEFAULT_ENDPOINT = "jobs.googleapis.com"
668
690
 
669
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
691
+ config_attr :endpoint, nil, ::String, nil
670
692
  config_attr :credentials, nil do |value|
671
693
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
672
694
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -681,6 +703,7 @@ module Google
681
703
  config_attr :metadata, nil, ::Hash, nil
682
704
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
683
705
  config_attr :quota_project, nil, ::String, nil
706
+ config_attr :universe_domain, nil, ::String, nil
684
707
 
685
708
  # @private
686
709
  def initialize parent_config = nil
@@ -701,6 +724,14 @@ module Google
701
724
  end
702
725
  end
703
726
 
727
+ ##
728
+ # Configuration for the channel pool
729
+ # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
730
+ #
731
+ def channel_pool
732
+ @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
733
+ end
734
+
704
735
  ##
705
736
  # Configuration RPC class for the Operations API.
706
737
  #
@@ -32,6 +32,9 @@ module Google
32
32
  # A service handles job management, including job CRUD, enumeration and search.
33
33
  #
34
34
  class Client
35
+ # @private
36
+ DEFAULT_ENDPOINT_TEMPLATE = "jobs.$UNIVERSE_DOMAIN$"
37
+
35
38
  include Paths
36
39
 
37
40
  # @private
@@ -119,6 +122,15 @@ module Google
119
122
  @config
120
123
  end
121
124
 
125
+ ##
126
+ # The effective universe domain
127
+ #
128
+ # @return [String]
129
+ #
130
+ def universe_domain
131
+ @job_service_stub.universe_domain
132
+ end
133
+
122
134
  ##
123
135
  # Create a new JobService REST client object.
124
136
  #
@@ -146,8 +158,9 @@ module Google
146
158
  credentials = @config.credentials
147
159
  # Use self-signed JWT if the endpoint is unchanged from default,
148
160
  # but only if the default endpoint does not have a region prefix.
149
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
150
- !@config.endpoint.split(".").first.include?("-")
161
+ enable_self_signed_jwt = @config.endpoint.nil? ||
162
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
163
+ !@config.endpoint.split(".").first.include?("-"))
151
164
  credentials ||= Credentials.default scope: @config.scope,
152
165
  enable_self_signed_jwt: enable_self_signed_jwt
153
166
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -161,9 +174,15 @@ module Google
161
174
  config.credentials = credentials
162
175
  config.quota_project = @quota_project_id
163
176
  config.endpoint = @config.endpoint
177
+ config.universe_domain = @config.universe_domain
164
178
  end
165
179
 
166
- @job_service_stub = ::Google::Cloud::Talent::V4::JobService::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
180
+ @job_service_stub = ::Google::Cloud::Talent::V4::JobService::Rest::ServiceStub.new(
181
+ endpoint: @config.endpoint,
182
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
183
+ universe_domain: @config.universe_domain,
184
+ credentials: credentials
185
+ )
167
186
  end
168
187
 
169
188
  ##
@@ -210,6 +229,22 @@ module Google
210
229
  # @return [::Google::Cloud::Talent::V4::Job]
211
230
  #
212
231
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
232
+ #
233
+ # @example Basic example
234
+ # require "google/cloud/talent/v4"
235
+ #
236
+ # # Create a client object. The client can be reused for multiple calls.
237
+ # client = Google::Cloud::Talent::V4::JobService::Rest::Client.new
238
+ #
239
+ # # Create a request. To set request fields, pass in keyword arguments.
240
+ # request = Google::Cloud::Talent::V4::CreateJobRequest.new
241
+ #
242
+ # # Call the create_job method.
243
+ # result = client.create_job request
244
+ #
245
+ # # The returned object is of type Google::Cloud::Talent::V4::Job.
246
+ # p result
247
+ #
213
248
  def create_job request, options = nil
214
249
  raise ::ArgumentError, "request must be provided" if request.nil?
215
250
 
@@ -278,6 +313,29 @@ module Google
278
313
  # @return [::Gapic::Operation]
279
314
  #
280
315
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
316
+ #
317
+ # @example Basic example
318
+ # require "google/cloud/talent/v4"
319
+ #
320
+ # # Create a client object. The client can be reused for multiple calls.
321
+ # client = Google::Cloud::Talent::V4::JobService::Rest::Client.new
322
+ #
323
+ # # Create a request. To set request fields, pass in keyword arguments.
324
+ # request = Google::Cloud::Talent::V4::BatchCreateJobsRequest.new
325
+ #
326
+ # # Call the batch_create_jobs method.
327
+ # result = client.batch_create_jobs request
328
+ #
329
+ # # The returned object is of type Gapic::Operation. You can use it to
330
+ # # check the status of an operation, cancel it, or wait for results.
331
+ # # Here is how to wait for a response.
332
+ # result.wait_until_done! timeout: 60
333
+ # if result.response?
334
+ # p result.response
335
+ # else
336
+ # puts "No response received."
337
+ # end
338
+ #
281
339
  def batch_create_jobs request, options = nil
282
340
  raise ::ArgumentError, "request must be provided" if request.nil?
283
341
 
@@ -346,6 +404,22 @@ module Google
346
404
  # @return [::Google::Cloud::Talent::V4::Job]
347
405
  #
348
406
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
407
+ #
408
+ # @example Basic example
409
+ # require "google/cloud/talent/v4"
410
+ #
411
+ # # Create a client object. The client can be reused for multiple calls.
412
+ # client = Google::Cloud::Talent::V4::JobService::Rest::Client.new
413
+ #
414
+ # # Create a request. To set request fields, pass in keyword arguments.
415
+ # request = Google::Cloud::Talent::V4::GetJobRequest.new
416
+ #
417
+ # # Call the get_job method.
418
+ # result = client.get_job request
419
+ #
420
+ # # The returned object is of type Google::Cloud::Talent::V4::Job.
421
+ # p result
422
+ #
349
423
  def get_job request, options = nil
350
424
  raise ::ArgumentError, "request must be provided" if request.nil?
351
425
 
@@ -421,6 +495,22 @@ module Google
421
495
  # @return [::Google::Cloud::Talent::V4::Job]
422
496
  #
423
497
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
498
+ #
499
+ # @example Basic example
500
+ # require "google/cloud/talent/v4"
501
+ #
502
+ # # Create a client object. The client can be reused for multiple calls.
503
+ # client = Google::Cloud::Talent::V4::JobService::Rest::Client.new
504
+ #
505
+ # # Create a request. To set request fields, pass in keyword arguments.
506
+ # request = Google::Cloud::Talent::V4::UpdateJobRequest.new
507
+ #
508
+ # # Call the update_job method.
509
+ # result = client.update_job request
510
+ #
511
+ # # The returned object is of type Google::Cloud::Talent::V4::Job.
512
+ # p result
513
+ #
424
514
  def update_job request, options = nil
425
515
  raise ::ArgumentError, "request must be provided" if request.nil?
426
516
 
@@ -506,6 +596,29 @@ module Google
506
596
  # @return [::Gapic::Operation]
507
597
  #
508
598
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
599
+ #
600
+ # @example Basic example
601
+ # require "google/cloud/talent/v4"
602
+ #
603
+ # # Create a client object. The client can be reused for multiple calls.
604
+ # client = Google::Cloud::Talent::V4::JobService::Rest::Client.new
605
+ #
606
+ # # Create a request. To set request fields, pass in keyword arguments.
607
+ # request = Google::Cloud::Talent::V4::BatchUpdateJobsRequest.new
608
+ #
609
+ # # Call the batch_update_jobs method.
610
+ # result = client.batch_update_jobs request
611
+ #
612
+ # # The returned object is of type Gapic::Operation. You can use it to
613
+ # # check the status of an operation, cancel it, or wait for results.
614
+ # # Here is how to wait for a response.
615
+ # result.wait_until_done! timeout: 60
616
+ # if result.response?
617
+ # p result.response
618
+ # else
619
+ # puts "No response received."
620
+ # end
621
+ #
509
622
  def batch_update_jobs request, options = nil
510
623
  raise ::ArgumentError, "request must be provided" if request.nil?
511
624
 
@@ -576,6 +689,22 @@ module Google
576
689
  # @return [::Google::Protobuf::Empty]
577
690
  #
578
691
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
692
+ #
693
+ # @example Basic example
694
+ # require "google/cloud/talent/v4"
695
+ #
696
+ # # Create a client object. The client can be reused for multiple calls.
697
+ # client = Google::Cloud::Talent::V4::JobService::Rest::Client.new
698
+ #
699
+ # # Create a request. To set request fields, pass in keyword arguments.
700
+ # request = Google::Cloud::Talent::V4::DeleteJobRequest.new
701
+ #
702
+ # # Call the delete_job method.
703
+ # result = client.delete_job request
704
+ #
705
+ # # The returned object is of type Google::Protobuf::Empty.
706
+ # p result
707
+ #
579
708
  def delete_job request, options = nil
580
709
  raise ::ArgumentError, "request must be provided" if request.nil?
581
710
 
@@ -650,6 +779,29 @@ module Google
650
779
  # @return [::Gapic::Operation]
651
780
  #
652
781
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
782
+ #
783
+ # @example Basic example
784
+ # require "google/cloud/talent/v4"
785
+ #
786
+ # # Create a client object. The client can be reused for multiple calls.
787
+ # client = Google::Cloud::Talent::V4::JobService::Rest::Client.new
788
+ #
789
+ # # Create a request. To set request fields, pass in keyword arguments.
790
+ # request = Google::Cloud::Talent::V4::BatchDeleteJobsRequest.new
791
+ #
792
+ # # Call the batch_delete_jobs method.
793
+ # result = client.batch_delete_jobs request
794
+ #
795
+ # # The returned object is of type Gapic::Operation. You can use it to
796
+ # # check the status of an operation, cancel it, or wait for results.
797
+ # # Here is how to wait for a response.
798
+ # result.wait_until_done! timeout: 60
799
+ # if result.response?
800
+ # p result.response
801
+ # else
802
+ # puts "No response received."
803
+ # end
804
+ #
653
805
  def batch_delete_jobs request, options = nil
654
806
  raise ::ArgumentError, "request must be provided" if request.nil?
655
807
 
@@ -756,6 +908,26 @@ module Google
756
908
  # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Talent::V4::Job>]
757
909
  #
758
910
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
911
+ #
912
+ # @example Basic example
913
+ # require "google/cloud/talent/v4"
914
+ #
915
+ # # Create a client object. The client can be reused for multiple calls.
916
+ # client = Google::Cloud::Talent::V4::JobService::Rest::Client.new
917
+ #
918
+ # # Create a request. To set request fields, pass in keyword arguments.
919
+ # request = Google::Cloud::Talent::V4::ListJobsRequest.new
920
+ #
921
+ # # Call the list_jobs method.
922
+ # result = client.list_jobs request
923
+ #
924
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
925
+ # # over elements, and API calls will be issued to fetch pages as needed.
926
+ # result.each do |item|
927
+ # # Each element is of type ::Google::Cloud::Talent::V4::Job.
928
+ # p item
929
+ # end
930
+ #
759
931
  def list_jobs request, options = nil
760
932
  raise ::ArgumentError, "request must be provided" if request.nil?
761
933
 
@@ -1095,6 +1267,22 @@ module Google
1095
1267
  # @return [::Google::Cloud::Talent::V4::SearchJobsResponse]
1096
1268
  #
1097
1269
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1270
+ #
1271
+ # @example Basic example
1272
+ # require "google/cloud/talent/v4"
1273
+ #
1274
+ # # Create a client object. The client can be reused for multiple calls.
1275
+ # client = Google::Cloud::Talent::V4::JobService::Rest::Client.new
1276
+ #
1277
+ # # Create a request. To set request fields, pass in keyword arguments.
1278
+ # request = Google::Cloud::Talent::V4::SearchJobsRequest.new
1279
+ #
1280
+ # # Call the search_jobs method.
1281
+ # result = client.search_jobs request
1282
+ #
1283
+ # # The returned object is of type Google::Cloud::Talent::V4::SearchJobsResponse.
1284
+ # p result
1285
+ #
1098
1286
  def search_jobs request, options = nil
1099
1287
  raise ::ArgumentError, "request must be provided" if request.nil?
1100
1288
 
@@ -1438,6 +1626,22 @@ module Google
1438
1626
  # @return [::Google::Cloud::Talent::V4::SearchJobsResponse]
1439
1627
  #
1440
1628
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1629
+ #
1630
+ # @example Basic example
1631
+ # require "google/cloud/talent/v4"
1632
+ #
1633
+ # # Create a client object. The client can be reused for multiple calls.
1634
+ # client = Google::Cloud::Talent::V4::JobService::Rest::Client.new
1635
+ #
1636
+ # # Create a request. To set request fields, pass in keyword arguments.
1637
+ # request = Google::Cloud::Talent::V4::SearchJobsRequest.new
1638
+ #
1639
+ # # Call the search_jobs_for_alert method.
1640
+ # result = client.search_jobs_for_alert request
1641
+ #
1642
+ # # The returned object is of type Google::Cloud::Talent::V4::SearchJobsResponse.
1643
+ # p result
1644
+ #
1441
1645
  def search_jobs_for_alert request, options = nil
1442
1646
  raise ::ArgumentError, "request must be provided" if request.nil?
1443
1647
 
@@ -1503,9 +1707,9 @@ module Google
1503
1707
  # end
1504
1708
  #
1505
1709
  # @!attribute [rw] endpoint
1506
- # The hostname or hostname:port of the service endpoint.
1507
- # Defaults to `"jobs.googleapis.com"`.
1508
- # @return [::String]
1710
+ # A custom service endpoint, as a hostname or hostname:port. The default is
1711
+ # nil, indicating to use the default endpoint in the current universe domain.
1712
+ # @return [::String,nil]
1509
1713
  # @!attribute [rw] credentials
1510
1714
  # Credentials to send with calls. You may provide any of the following types:
1511
1715
  # * (`String`) The path to a service account key file in JSON format
@@ -1542,13 +1746,20 @@ module Google
1542
1746
  # @!attribute [rw] quota_project
1543
1747
  # A separate project against which to charge quota.
1544
1748
  # @return [::String]
1749
+ # @!attribute [rw] universe_domain
1750
+ # The universe domain within which to make requests. This determines the
1751
+ # default endpoint URL. The default value of nil uses the environment
1752
+ # universe (usually the default "googleapis.com" universe).
1753
+ # @return [::String,nil]
1545
1754
  #
1546
1755
  class Configuration
1547
1756
  extend ::Gapic::Config
1548
1757
 
1758
+ # @private
1759
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
1549
1760
  DEFAULT_ENDPOINT = "jobs.googleapis.com"
1550
1761
 
1551
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
1762
+ config_attr :endpoint, nil, ::String, nil
1552
1763
  config_attr :credentials, nil do |value|
1553
1764
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1554
1765
  allowed.any? { |klass| klass === value }
@@ -1560,6 +1771,7 @@ module Google
1560
1771
  config_attr :metadata, nil, ::Hash, nil
1561
1772
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1562
1773
  config_attr :quota_project, nil, ::String, nil
1774
+ config_attr :universe_domain, nil, ::String, nil
1563
1775
 
1564
1776
  # @private
1565
1777
  def initialize parent_config = nil
@@ -26,6 +26,9 @@ module Google
26
26
  module Rest
27
27
  # Service that implements Longrunning Operations API.
28
28
  class Operations
29
+ # @private
30
+ DEFAULT_ENDPOINT_TEMPLATE = "jobs.$UNIVERSE_DOMAIN$"
31
+
29
32
  # @private
30
33
  attr_reader :operations_stub
31
34
 
@@ -60,6 +63,15 @@ module Google
60
63
  @config
61
64
  end
62
65
 
66
+ ##
67
+ # The effective universe domain
68
+ #
69
+ # @return [String]
70
+ #
71
+ def universe_domain
72
+ @operations_stub.universe_domain
73
+ end
74
+
63
75
  ##
64
76
  # Create a new Operations client object.
65
77
  #
@@ -84,8 +96,10 @@ module Google
84
96
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
85
97
 
86
98
  @operations_stub = OperationsServiceStub.new(
87
- endpoint: @config.endpoint,
88
- credentials: credentials
99
+ endpoint: @config.endpoint,
100
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
101
+ universe_domain: @config.universe_domain,
102
+ credentials: credentials
89
103
  )
90
104
 
91
105
  # Used by an LRO wrapper for some methods of this service
@@ -136,6 +150,26 @@ module Google
136
150
  # @return [::Gapic::Operation]
137
151
  #
138
152
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
153
+ #
154
+ # @example Basic example
155
+ # require "google/longrunning"
156
+ #
157
+ # # Create a client object. The client can be reused for multiple calls.
158
+ # client = Google::Longrunning::Operations::Rest::Client.new
159
+ #
160
+ # # Create a request. To set request fields, pass in keyword arguments.
161
+ # request = Google::Longrunning::ListOperationsRequest.new
162
+ #
163
+ # # Call the list_operations method.
164
+ # result = client.list_operations request
165
+ #
166
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
167
+ # # over elements, and API calls will be issued to fetch pages as needed.
168
+ # result.each do |item|
169
+ # # Each element is of type ::Google::Longrunning::Operation.
170
+ # p item
171
+ # end
172
+ #
139
173
  def list_operations request, options = nil
140
174
  raise ::ArgumentError, "request must be provided" if request.nil?
141
175
 
@@ -201,6 +235,29 @@ module Google
201
235
  # @return [::Gapic::Operation]
202
236
  #
203
237
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
238
+ #
239
+ # @example Basic example
240
+ # require "google/longrunning"
241
+ #
242
+ # # Create a client object. The client can be reused for multiple calls.
243
+ # client = Google::Longrunning::Operations::Rest::Client.new
244
+ #
245
+ # # Create a request. To set request fields, pass in keyword arguments.
246
+ # request = Google::Longrunning::GetOperationRequest.new
247
+ #
248
+ # # Call the get_operation method.
249
+ # result = client.get_operation request
250
+ #
251
+ # # The returned object is of type Gapic::Operation. You can use it to
252
+ # # check the status of an operation, cancel it, or wait for results.
253
+ # # Here is how to wait for a response.
254
+ # result.wait_until_done! timeout: 60
255
+ # if result.response?
256
+ # p result.response
257
+ # else
258
+ # puts "No response received."
259
+ # end
260
+ #
204
261
  def get_operation request, options = nil
205
262
  raise ::ArgumentError, "request must be provided" if request.nil?
206
263
 
@@ -267,6 +324,22 @@ module Google
267
324
  # @return [::Google::Protobuf::Empty]
268
325
  #
269
326
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
327
+ #
328
+ # @example Basic example
329
+ # require "google/longrunning"
330
+ #
331
+ # # Create a client object. The client can be reused for multiple calls.
332
+ # client = Google::Longrunning::Operations::Rest::Client.new
333
+ #
334
+ # # Create a request. To set request fields, pass in keyword arguments.
335
+ # request = Google::Longrunning::DeleteOperationRequest.new
336
+ #
337
+ # # Call the delete_operation method.
338
+ # result = client.delete_operation request
339
+ #
340
+ # # The returned object is of type Google::Protobuf::Empty.
341
+ # p result
342
+ #
270
343
  def delete_operation request, options = nil
271
344
  raise ::ArgumentError, "request must be provided" if request.nil?
272
345
 
@@ -338,6 +411,22 @@ module Google
338
411
  # @return [::Google::Protobuf::Empty]
339
412
  #
340
413
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
414
+ #
415
+ # @example Basic example
416
+ # require "google/longrunning"
417
+ #
418
+ # # Create a client object. The client can be reused for multiple calls.
419
+ # client = Google::Longrunning::Operations::Rest::Client.new
420
+ #
421
+ # # Create a request. To set request fields, pass in keyword arguments.
422
+ # request = Google::Longrunning::CancelOperationRequest.new
423
+ #
424
+ # # Call the cancel_operation method.
425
+ # result = client.cancel_operation request
426
+ #
427
+ # # The returned object is of type Google::Protobuf::Empty.
428
+ # p result
429
+ #
341
430
  def cancel_operation request, options = nil
342
431
  raise ::ArgumentError, "request must be provided" if request.nil?
343
432
 
@@ -403,9 +492,9 @@ module Google
403
492
  # end
404
493
  #
405
494
  # @!attribute [rw] endpoint
406
- # The hostname or hostname:port of the service endpoint.
407
- # Defaults to `"jobs.googleapis.com"`.
408
- # @return [::String]
495
+ # A custom service endpoint, as a hostname or hostname:port. The default is
496
+ # nil, indicating to use the default endpoint in the current universe domain.
497
+ # @return [::String,nil]
409
498
  # @!attribute [rw] credentials
410
499
  # Credentials to send with calls. You may provide any of the following types:
411
500
  # * (`String`) The path to a service account key file in JSON format
@@ -442,13 +531,20 @@ module Google
442
531
  # @!attribute [rw] quota_project
443
532
  # A separate project against which to charge quota.
444
533
  # @return [::String]
534
+ # @!attribute [rw] universe_domain
535
+ # The universe domain within which to make requests. This determines the
536
+ # default endpoint URL. The default value of nil uses the environment
537
+ # universe (usually the default "googleapis.com" universe).
538
+ # @return [::String,nil]
445
539
  #
446
540
  class Configuration
447
541
  extend ::Gapic::Config
448
542
 
543
+ # @private
544
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
449
545
  DEFAULT_ENDPOINT = "jobs.googleapis.com"
450
546
 
451
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
547
+ config_attr :endpoint, nil, ::String, nil
452
548
  config_attr :credentials, nil do |value|
453
549
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
454
550
  allowed.any? { |klass| klass === value }
@@ -460,6 +556,7 @@ module Google
460
556
  config_attr :metadata, nil, ::Hash, nil
461
557
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
462
558
  config_attr :quota_project, nil, ::String, nil
559
+ config_attr :universe_domain, nil, ::String, nil
463
560
 
464
561
  # @private
465
562
  def initialize parent_config = nil
@@ -542,12 +639,15 @@ module Google
542
639
  # Service stub contains baseline method implementations
543
640
  # including transcoding, making the REST call, and deserialing the response.
544
641
  class OperationsServiceStub
545
- def initialize endpoint:, credentials:
642
+ def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
546
643
  # These require statements are intentionally placed here to initialize
547
644
  # the REST modules only when it's required.
548
645
  require "gapic/rest"
549
646
 
550
- @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials
647
+ @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
648
+ endpoint_template: endpoint_template,
649
+ universe_domain: universe_domain,
650
+ credentials: credentials
551
651
  end
552
652
 
553
653
  ##
@@ -30,16 +30,28 @@ module Google
30
30
  # including transcoding, making the REST call, and deserialing the response.
31
31
  #
32
32
  class ServiceStub
33
- def initialize endpoint:, credentials:
33
+ def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
34
34
  # These require statements are intentionally placed here to initialize
35
35
  # the REST modules only when it's required.
36
36
  require "gapic/rest"
37
37
 
38
- @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials,
38
+ @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
39
+ endpoint_template: endpoint_template,
40
+ universe_domain: universe_domain,
41
+ credentials: credentials,
39
42
  numeric_enums: true,
40
43
  raise_faraday_errors: false
41
44
  end
42
45
 
46
+ ##
47
+ # The effective universe domain
48
+ #
49
+ # @return [String]
50
+ #
51
+ def universe_domain
52
+ @client_stub.universe_domain
53
+ end
54
+
43
55
  ##
44
56
  # Baseline implementation for the create_job REST call
45
57
  #