google-cloud-talent-v4beta1 0.8.1 → 0.10.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.
Files changed (27) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +72 -101
  3. data/lib/google/cloud/talent/v4beta1/company_service/client.rb +41 -9
  4. data/lib/google/cloud/talent/v4beta1/company_service/rest/client.rb +117 -7
  5. data/lib/google/cloud/talent/v4beta1/company_service/rest/service_stub.rb +14 -2
  6. data/lib/google/cloud/talent/v4beta1/completion/client.rb +41 -9
  7. data/lib/google/cloud/talent/v4beta1/completion/rest/client.rb +49 -7
  8. data/lib/google/cloud/talent/v4beta1/completion/rest/service_stub.rb +14 -2
  9. data/lib/google/cloud/talent/v4beta1/event_service/client.rb +41 -9
  10. data/lib/google/cloud/talent/v4beta1/event_service/rest/client.rb +49 -7
  11. data/lib/google/cloud/talent/v4beta1/event_service/rest/service_stub.rb +14 -2
  12. data/lib/google/cloud/talent/v4beta1/job_service/client.rb +42 -9
  13. data/lib/google/cloud/talent/v4beta1/job_service/operations.rb +38 -7
  14. data/lib/google/cloud/talent/v4beta1/job_service/rest/client.rb +212 -7
  15. data/lib/google/cloud/talent/v4beta1/job_service/rest/operations.rb +108 -8
  16. data/lib/google/cloud/talent/v4beta1/job_service/rest/service_stub.rb +14 -2
  17. data/lib/google/cloud/talent/v4beta1/tenant_service/client.rb +41 -9
  18. data/lib/google/cloud/talent/v4beta1/tenant_service/rest/client.rb +117 -7
  19. data/lib/google/cloud/talent/v4beta1/tenant_service/rest/service_stub.rb +14 -2
  20. data/lib/google/cloud/talent/v4beta1/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/v4beta1/common.rb +1 -0
  24. data/proto_docs/google/cloud/talent/v4beta1/company.rb +1 -0
  25. data/proto_docs/google/cloud/talent/v4beta1/job.rb +1 -0
  26. data/proto_docs/google/cloud/talent/v4beta1/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
@@ -121,6 +124,15 @@ module Google
121
124
  @config
122
125
  end
123
126
 
127
+ ##
128
+ # The effective universe domain
129
+ #
130
+ # @return [String]
131
+ #
132
+ def universe_domain
133
+ @job_service_stub.universe_domain
134
+ end
135
+
124
136
  ##
125
137
  # Create a new JobService REST client object.
126
138
  #
@@ -148,8 +160,9 @@ module Google
148
160
  credentials = @config.credentials
149
161
  # Use self-signed JWT if the endpoint is unchanged from default,
150
162
  # but only if the default endpoint does not have a region prefix.
151
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
152
- !@config.endpoint.split(".").first.include?("-")
163
+ enable_self_signed_jwt = @config.endpoint.nil? ||
164
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
165
+ !@config.endpoint.split(".").first.include?("-"))
153
166
  credentials ||= Credentials.default scope: @config.scope,
154
167
  enable_self_signed_jwt: enable_self_signed_jwt
155
168
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -163,9 +176,15 @@ module Google
163
176
  config.credentials = credentials
164
177
  config.quota_project = @quota_project_id
165
178
  config.endpoint = @config.endpoint
179
+ config.universe_domain = @config.universe_domain
166
180
  end
167
181
 
168
- @job_service_stub = ::Google::Cloud::Talent::V4beta1::JobService::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
182
+ @job_service_stub = ::Google::Cloud::Talent::V4beta1::JobService::Rest::ServiceStub.new(
183
+ endpoint: @config.endpoint,
184
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
185
+ universe_domain: @config.universe_domain,
186
+ credentials: credentials
187
+ )
169
188
  end
170
189
 
171
190
  ##
@@ -213,6 +232,22 @@ module Google
213
232
  # @return [::Google::Cloud::Talent::V4beta1::Job]
214
233
  #
215
234
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
235
+ #
236
+ # @example Basic example
237
+ # require "google/cloud/talent/v4beta1"
238
+ #
239
+ # # Create a client object. The client can be reused for multiple calls.
240
+ # client = Google::Cloud::Talent::V4beta1::JobService::Rest::Client.new
241
+ #
242
+ # # Create a request. To set request fields, pass in keyword arguments.
243
+ # request = Google::Cloud::Talent::V4beta1::CreateJobRequest.new
244
+ #
245
+ # # Call the create_job method.
246
+ # result = client.create_job request
247
+ #
248
+ # # The returned object is of type Google::Cloud::Talent::V4beta1::Job.
249
+ # p result
250
+ #
216
251
  def create_job request, options = nil
217
252
  raise ::ArgumentError, "request must be provided" if request.nil?
218
253
 
@@ -281,6 +316,29 @@ module Google
281
316
  # @return [::Gapic::Operation]
282
317
  #
283
318
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
319
+ #
320
+ # @example Basic example
321
+ # require "google/cloud/talent/v4beta1"
322
+ #
323
+ # # Create a client object. The client can be reused for multiple calls.
324
+ # client = Google::Cloud::Talent::V4beta1::JobService::Rest::Client.new
325
+ #
326
+ # # Create a request. To set request fields, pass in keyword arguments.
327
+ # request = Google::Cloud::Talent::V4beta1::BatchCreateJobsRequest.new
328
+ #
329
+ # # Call the batch_create_jobs method.
330
+ # result = client.batch_create_jobs request
331
+ #
332
+ # # The returned object is of type Gapic::Operation. You can use it to
333
+ # # check the status of an operation, cancel it, or wait for results.
334
+ # # Here is how to wait for a response.
335
+ # result.wait_until_done! timeout: 60
336
+ # if result.response?
337
+ # p result.response
338
+ # else
339
+ # puts "No response received."
340
+ # end
341
+ #
284
342
  def batch_create_jobs request, options = nil
285
343
  raise ::ArgumentError, "request must be provided" if request.nil?
286
344
 
@@ -352,6 +410,22 @@ module Google
352
410
  # @return [::Google::Cloud::Talent::V4beta1::Job]
353
411
  #
354
412
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
413
+ #
414
+ # @example Basic example
415
+ # require "google/cloud/talent/v4beta1"
416
+ #
417
+ # # Create a client object. The client can be reused for multiple calls.
418
+ # client = Google::Cloud::Talent::V4beta1::JobService::Rest::Client.new
419
+ #
420
+ # # Create a request. To set request fields, pass in keyword arguments.
421
+ # request = Google::Cloud::Talent::V4beta1::GetJobRequest.new
422
+ #
423
+ # # Call the get_job method.
424
+ # result = client.get_job request
425
+ #
426
+ # # The returned object is of type Google::Cloud::Talent::V4beta1::Job.
427
+ # p result
428
+ #
355
429
  def get_job request, options = nil
356
430
  raise ::ArgumentError, "request must be provided" if request.nil?
357
431
 
@@ -427,6 +501,22 @@ module Google
427
501
  # @return [::Google::Cloud::Talent::V4beta1::Job]
428
502
  #
429
503
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
504
+ #
505
+ # @example Basic example
506
+ # require "google/cloud/talent/v4beta1"
507
+ #
508
+ # # Create a client object. The client can be reused for multiple calls.
509
+ # client = Google::Cloud::Talent::V4beta1::JobService::Rest::Client.new
510
+ #
511
+ # # Create a request. To set request fields, pass in keyword arguments.
512
+ # request = Google::Cloud::Talent::V4beta1::UpdateJobRequest.new
513
+ #
514
+ # # Call the update_job method.
515
+ # result = client.update_job request
516
+ #
517
+ # # The returned object is of type Google::Cloud::Talent::V4beta1::Job.
518
+ # p result
519
+ #
430
520
  def update_job request, options = nil
431
521
  raise ::ArgumentError, "request must be provided" if request.nil?
432
522
 
@@ -515,6 +605,29 @@ module Google
515
605
  # @return [::Gapic::Operation]
516
606
  #
517
607
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
608
+ #
609
+ # @example Basic example
610
+ # require "google/cloud/talent/v4beta1"
611
+ #
612
+ # # Create a client object. The client can be reused for multiple calls.
613
+ # client = Google::Cloud::Talent::V4beta1::JobService::Rest::Client.new
614
+ #
615
+ # # Create a request. To set request fields, pass in keyword arguments.
616
+ # request = Google::Cloud::Talent::V4beta1::BatchUpdateJobsRequest.new
617
+ #
618
+ # # Call the batch_update_jobs method.
619
+ # result = client.batch_update_jobs request
620
+ #
621
+ # # The returned object is of type Gapic::Operation. You can use it to
622
+ # # check the status of an operation, cancel it, or wait for results.
623
+ # # Here is how to wait for a response.
624
+ # result.wait_until_done! timeout: 60
625
+ # if result.response?
626
+ # p result.response
627
+ # else
628
+ # puts "No response received."
629
+ # end
630
+ #
518
631
  def batch_update_jobs request, options = nil
519
632
  raise ::ArgumentError, "request must be provided" if request.nil?
520
633
 
@@ -588,6 +701,22 @@ module Google
588
701
  # @return [::Google::Protobuf::Empty]
589
702
  #
590
703
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
704
+ #
705
+ # @example Basic example
706
+ # require "google/cloud/talent/v4beta1"
707
+ #
708
+ # # Create a client object. The client can be reused for multiple calls.
709
+ # client = Google::Cloud::Talent::V4beta1::JobService::Rest::Client.new
710
+ #
711
+ # # Create a request. To set request fields, pass in keyword arguments.
712
+ # request = Google::Cloud::Talent::V4beta1::DeleteJobRequest.new
713
+ #
714
+ # # Call the delete_job method.
715
+ # result = client.delete_job request
716
+ #
717
+ # # The returned object is of type Google::Protobuf::Empty.
718
+ # p result
719
+ #
591
720
  def delete_job request, options = nil
592
721
  raise ::ArgumentError, "request must be provided" if request.nil?
593
722
 
@@ -666,6 +795,22 @@ module Google
666
795
  # @return [::Google::Protobuf::Empty]
667
796
  #
668
797
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
798
+ #
799
+ # @example Basic example
800
+ # require "google/cloud/talent/v4beta1"
801
+ #
802
+ # # Create a client object. The client can be reused for multiple calls.
803
+ # client = Google::Cloud::Talent::V4beta1::JobService::Rest::Client.new
804
+ #
805
+ # # Create a request. To set request fields, pass in keyword arguments.
806
+ # request = Google::Cloud::Talent::V4beta1::BatchDeleteJobsRequest.new
807
+ #
808
+ # # Call the batch_delete_jobs method.
809
+ # result = client.batch_delete_jobs request
810
+ #
811
+ # # The returned object is of type Google::Protobuf::Empty.
812
+ # p result
813
+ #
669
814
  def batch_delete_jobs request, options = nil
670
815
  raise ::ArgumentError, "request must be provided" if request.nil?
671
816
 
@@ -773,6 +918,26 @@ module Google
773
918
  # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Talent::V4beta1::Job>]
774
919
  #
775
920
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
921
+ #
922
+ # @example Basic example
923
+ # require "google/cloud/talent/v4beta1"
924
+ #
925
+ # # Create a client object. The client can be reused for multiple calls.
926
+ # client = Google::Cloud::Talent::V4beta1::JobService::Rest::Client.new
927
+ #
928
+ # # Create a request. To set request fields, pass in keyword arguments.
929
+ # request = Google::Cloud::Talent::V4beta1::ListJobsRequest.new
930
+ #
931
+ # # Call the list_jobs method.
932
+ # result = client.list_jobs request
933
+ #
934
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
935
+ # # over elements, and API calls will be issued to fetch pages as needed.
936
+ # result.each do |item|
937
+ # # Each element is of type ::Google::Cloud::Talent::V4beta1::Job.
938
+ # p item
939
+ # end
940
+ #
776
941
  def list_jobs request, options = nil
777
942
  raise ::ArgumentError, "request must be provided" if request.nil?
778
943
 
@@ -1118,6 +1283,22 @@ module Google
1118
1283
  # @return [::Google::Cloud::Talent::V4beta1::SearchJobsResponse]
1119
1284
  #
1120
1285
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1286
+ #
1287
+ # @example Basic example
1288
+ # require "google/cloud/talent/v4beta1"
1289
+ #
1290
+ # # Create a client object. The client can be reused for multiple calls.
1291
+ # client = Google::Cloud::Talent::V4beta1::JobService::Rest::Client.new
1292
+ #
1293
+ # # Create a request. To set request fields, pass in keyword arguments.
1294
+ # request = Google::Cloud::Talent::V4beta1::SearchJobsRequest.new
1295
+ #
1296
+ # # Call the search_jobs method.
1297
+ # result = client.search_jobs request
1298
+ #
1299
+ # # The returned object is of type Google::Cloud::Talent::V4beta1::SearchJobsResponse.
1300
+ # p result
1301
+ #
1121
1302
  def search_jobs request, options = nil
1122
1303
  raise ::ArgumentError, "request must be provided" if request.nil?
1123
1304
 
@@ -1467,6 +1648,22 @@ module Google
1467
1648
  # @return [::Google::Cloud::Talent::V4beta1::SearchJobsResponse]
1468
1649
  #
1469
1650
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1651
+ #
1652
+ # @example Basic example
1653
+ # require "google/cloud/talent/v4beta1"
1654
+ #
1655
+ # # Create a client object. The client can be reused for multiple calls.
1656
+ # client = Google::Cloud::Talent::V4beta1::JobService::Rest::Client.new
1657
+ #
1658
+ # # Create a request. To set request fields, pass in keyword arguments.
1659
+ # request = Google::Cloud::Talent::V4beta1::SearchJobsRequest.new
1660
+ #
1661
+ # # Call the search_jobs_for_alert method.
1662
+ # result = client.search_jobs_for_alert request
1663
+ #
1664
+ # # The returned object is of type Google::Cloud::Talent::V4beta1::SearchJobsResponse.
1665
+ # p result
1666
+ #
1470
1667
  def search_jobs_for_alert request, options = nil
1471
1668
  raise ::ArgumentError, "request must be provided" if request.nil?
1472
1669
 
@@ -1532,9 +1729,9 @@ module Google
1532
1729
  # end
1533
1730
  #
1534
1731
  # @!attribute [rw] endpoint
1535
- # The hostname or hostname:port of the service endpoint.
1536
- # Defaults to `"jobs.googleapis.com"`.
1537
- # @return [::String]
1732
+ # A custom service endpoint, as a hostname or hostname:port. The default is
1733
+ # nil, indicating to use the default endpoint in the current universe domain.
1734
+ # @return [::String,nil]
1538
1735
  # @!attribute [rw] credentials
1539
1736
  # Credentials to send with calls. You may provide any of the following types:
1540
1737
  # * (`String`) The path to a service account key file in JSON format
@@ -1571,13 +1768,20 @@ module Google
1571
1768
  # @!attribute [rw] quota_project
1572
1769
  # A separate project against which to charge quota.
1573
1770
  # @return [::String]
1771
+ # @!attribute [rw] universe_domain
1772
+ # The universe domain within which to make requests. This determines the
1773
+ # default endpoint URL. The default value of nil uses the environment
1774
+ # universe (usually the default "googleapis.com" universe).
1775
+ # @return [::String,nil]
1574
1776
  #
1575
1777
  class Configuration
1576
1778
  extend ::Gapic::Config
1577
1779
 
1780
+ # @private
1781
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
1578
1782
  DEFAULT_ENDPOINT = "jobs.googleapis.com"
1579
1783
 
1580
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
1784
+ config_attr :endpoint, nil, ::String, nil
1581
1785
  config_attr :credentials, nil do |value|
1582
1786
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1583
1787
  allowed.any? { |klass| klass === value }
@@ -1589,6 +1793,7 @@ module Google
1589
1793
  config_attr :metadata, nil, ::Hash, nil
1590
1794
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1591
1795
  config_attr :quota_project, nil, ::String, nil
1796
+ config_attr :universe_domain, nil, ::String, nil
1592
1797
 
1593
1798
  # @private
1594
1799
  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
  #