google-cloud-talent-v4beta1 0.4.6 → 0.5.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 (48) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +6 -6
  3. data/README.md +9 -4
  4. data/lib/google/cloud/talent/v4beta1/batch_pb.rb +0 -1
  5. data/lib/google/cloud/talent/v4beta1/common_pb.rb +3 -65
  6. data/lib/google/cloud/talent/v4beta1/company_pb.rb +2 -2
  7. data/lib/google/cloud/talent/v4beta1/company_service_pb.rb +2 -1
  8. data/lib/google/cloud/talent/v4beta1/completion_service_pb.rb +3 -2
  9. data/lib/google/cloud/talent/v4beta1/event_pb.rb +2 -16
  10. data/lib/google/cloud/talent/v4beta1/event_service_pb.rb +2 -1
  11. data/lib/google/cloud/talent/v4beta1/filters_pb.rb +3 -102
  12. data/lib/google/cloud/talent/v4beta1/histogram_pb.rb +0 -1
  13. data/lib/google/cloud/talent/v4beta1/job_pb.rb +2 -3
  14. data/lib/google/cloud/talent/v4beta1/job_service/client.rb +48 -23
  15. data/lib/google/cloud/talent/v4beta1/job_service_pb.rb +10 -2
  16. data/lib/google/cloud/talent/v4beta1/tenant_pb.rb +2 -3
  17. data/lib/google/cloud/talent/v4beta1/tenant_service_pb.rb +2 -1
  18. data/lib/google/cloud/talent/v4beta1/version.rb +1 -1
  19. data/lib/google/cloud/talent/v4beta1.rb +3 -3
  20. data/proto_docs/google/cloud/talent/v4beta1/common.rb +10 -227
  21. data/proto_docs/google/cloud/talent/v4beta1/event.rb +1 -60
  22. data/proto_docs/google/cloud/talent/v4beta1/filters.rb +40 -482
  23. data/proto_docs/google/cloud/talent/v4beta1/histogram.rb +1 -1
  24. data/proto_docs/google/cloud/talent/v4beta1/job.rb +1 -1
  25. data/proto_docs/google/cloud/talent/v4beta1/job_service.rb +64 -16
  26. data/proto_docs/google/cloud/talent/v4beta1/tenant.rb +1 -1
  27. data/proto_docs/google/protobuf/any.rb +3 -3
  28. data/proto_docs/google/type/timeofday.rb +1 -1
  29. metadata +3 -22
  30. data/lib/google/cloud/talent/v4beta1/application_pb.rb +0 -64
  31. data/lib/google/cloud/talent/v4beta1/application_service/client.rb +0 -813
  32. data/lib/google/cloud/talent/v4beta1/application_service/credentials.rb +0 -52
  33. data/lib/google/cloud/talent/v4beta1/application_service/paths.rb +0 -155
  34. data/lib/google/cloud/talent/v4beta1/application_service.rb +0 -50
  35. data/lib/google/cloud/talent/v4beta1/application_service_pb.rb +0 -56
  36. data/lib/google/cloud/talent/v4beta1/application_service_services_pb.rb +0 -54
  37. data/lib/google/cloud/talent/v4beta1/profile_pb.rb +0 -214
  38. data/lib/google/cloud/talent/v4beta1/profile_service/client.rb +0 -1107
  39. data/lib/google/cloud/talent/v4beta1/profile_service/credentials.rb +0 -52
  40. data/lib/google/cloud/talent/v4beta1/profile_service/paths.rb +0 -69
  41. data/lib/google/cloud/talent/v4beta1/profile_service.rb +0 -50
  42. data/lib/google/cloud/talent/v4beta1/profile_service_pb.rb +0 -92
  43. data/lib/google/cloud/talent/v4beta1/profile_service_services_pb.rb +0 -63
  44. data/proto_docs/google/cloud/talent/v4beta1/application.rb +0 -169
  45. data/proto_docs/google/cloud/talent/v4beta1/application_service.rb +0 -122
  46. data/proto_docs/google/cloud/talent/v4beta1/profile.rb +0 -811
  47. data/proto_docs/google/cloud/talent/v4beta1/profile_service.rb +0 -392
  48. data/proto_docs/google/type/date.rb +0 -53
@@ -1,813 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- # Copyright 2020 Google LLC
4
- #
5
- # Licensed under the Apache License, Version 2.0 (the "License");
6
- # you may not use this file except in compliance with the License.
7
- # You may obtain a copy of the License at
8
- #
9
- # https://www.apache.org/licenses/LICENSE-2.0
10
- #
11
- # Unless required by applicable law or agreed to in writing, software
12
- # distributed under the License is distributed on an "AS IS" BASIS,
13
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
- # See the License for the specific language governing permissions and
15
- # limitations under the License.
16
-
17
- # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
-
19
- require "google/cloud/errors"
20
- require "google/cloud/talent/v4beta1/application_service_pb"
21
-
22
- module Google
23
- module Cloud
24
- module Talent
25
- module V4beta1
26
- module ApplicationService
27
- ##
28
- # Client for the ApplicationService service.
29
- #
30
- # A service that handles application management, including CRUD and
31
- # enumeration.
32
- #
33
- class Client
34
- include Paths
35
-
36
- # @private
37
- attr_reader :application_service_stub
38
-
39
- ##
40
- # Configure the ApplicationService Client class.
41
- #
42
- # See {::Google::Cloud::Talent::V4beta1::ApplicationService::Client::Configuration}
43
- # for a description of the configuration fields.
44
- #
45
- # @example
46
- #
47
- # # Modify the configuration for all ApplicationService clients
48
- # ::Google::Cloud::Talent::V4beta1::ApplicationService::Client.configure do |config|
49
- # config.timeout = 10.0
50
- # end
51
- #
52
- # @yield [config] Configure the Client client.
53
- # @yieldparam config [Client::Configuration]
54
- #
55
- # @return [Client::Configuration]
56
- #
57
- def self.configure
58
- @configure ||= begin
59
- namespace = ["Google", "Cloud", "Talent", "V4beta1"]
60
- parent_config = while namespace.any?
61
- parent_name = namespace.join "::"
62
- parent_const = const_get parent_name
63
- break parent_const.configure if parent_const.respond_to? :configure
64
- namespace.pop
65
- end
66
- default_config = Client::Configuration.new parent_config
67
-
68
- default_config.rpcs.create_application.timeout = 30.0
69
-
70
- default_config.rpcs.get_application.timeout = 30.0
71
- default_config.rpcs.get_application.retry_policy = {
72
- initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
73
- }
74
-
75
- default_config.rpcs.update_application.timeout = 30.0
76
-
77
- default_config.rpcs.delete_application.timeout = 30.0
78
- default_config.rpcs.delete_application.retry_policy = {
79
- initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
80
- }
81
-
82
- default_config.rpcs.list_applications.timeout = 30.0
83
- default_config.rpcs.list_applications.retry_policy = {
84
- initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
85
- }
86
-
87
- default_config
88
- end
89
- yield @configure if block_given?
90
- @configure
91
- end
92
-
93
- ##
94
- # Configure the ApplicationService Client instance.
95
- #
96
- # The configuration is set to the derived mode, meaning that values can be changed,
97
- # but structural changes (adding new fields, etc.) are not allowed. Structural changes
98
- # should be made on {Client.configure}.
99
- #
100
- # See {::Google::Cloud::Talent::V4beta1::ApplicationService::Client::Configuration}
101
- # for a description of the configuration fields.
102
- #
103
- # @yield [config] Configure the Client client.
104
- # @yieldparam config [Client::Configuration]
105
- #
106
- # @return [Client::Configuration]
107
- #
108
- def configure
109
- yield @config if block_given?
110
- @config
111
- end
112
-
113
- ##
114
- # Create a new ApplicationService client object.
115
- #
116
- # @example
117
- #
118
- # # Create a client using the default configuration
119
- # client = ::Google::Cloud::Talent::V4beta1::ApplicationService::Client.new
120
- #
121
- # # Create a client using a custom configuration
122
- # client = ::Google::Cloud::Talent::V4beta1::ApplicationService::Client.new do |config|
123
- # config.timeout = 10.0
124
- # end
125
- #
126
- # @yield [config] Configure the ApplicationService client.
127
- # @yieldparam config [Client::Configuration]
128
- #
129
- def initialize
130
- # These require statements are intentionally placed here to initialize
131
- # the gRPC module only when it's required.
132
- # See https://github.com/googleapis/toolkit/issues/446
133
- require "gapic/grpc"
134
- require "google/cloud/talent/v4beta1/application_service_services_pb"
135
-
136
- # Create the configuration object
137
- @config = Configuration.new Client.configure
138
-
139
- # Yield the configuration if needed
140
- yield @config if block_given?
141
-
142
- # Create credentials
143
- credentials = @config.credentials
144
- # Use self-signed JWT if the endpoint is unchanged from default,
145
- # but only if the default endpoint does not have a region prefix.
146
- enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
147
- !@config.endpoint.split(".").first.include?("-")
148
- credentials ||= Credentials.default scope: @config.scope,
149
- enable_self_signed_jwt: enable_self_signed_jwt
150
- if credentials.is_a?(::String) || credentials.is_a?(::Hash)
151
- credentials = Credentials.new credentials, scope: @config.scope
152
- end
153
- @quota_project_id = @config.quota_project
154
- @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
155
-
156
- @application_service_stub = ::Gapic::ServiceStub.new(
157
- ::Google::Cloud::Talent::V4beta1::ApplicationService::Stub,
158
- credentials: credentials,
159
- endpoint: @config.endpoint,
160
- channel_args: @config.channel_args,
161
- interceptors: @config.interceptors
162
- )
163
- end
164
-
165
- # Service calls
166
-
167
- ##
168
- # Creates a new application entity.
169
- #
170
- # @overload create_application(request, options = nil)
171
- # Pass arguments to `create_application` via a request object, either of type
172
- # {::Google::Cloud::Talent::V4beta1::CreateApplicationRequest} or an equivalent Hash.
173
- #
174
- # @param request [::Google::Cloud::Talent::V4beta1::CreateApplicationRequest, ::Hash]
175
- # A request object representing the call parameters. Required. To specify no
176
- # parameters, or to keep all the default parameter values, pass an empty Hash.
177
- # @param options [::Gapic::CallOptions, ::Hash]
178
- # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
179
- #
180
- # @overload create_application(parent: nil, application: nil)
181
- # Pass arguments to `create_application` via keyword arguments. Note that at
182
- # least one keyword argument is required. To specify no parameters, or to keep all
183
- # the default parameter values, pass an empty Hash as a request object (see above).
184
- #
185
- # @param parent [::String]
186
- # Required. Resource name of the profile under which the application is created.
187
- #
188
- # The format is
189
- # "projects/\\{project_id}/tenants/\\{tenant_id}/profiles/\\{profile_id}".
190
- # For example, "projects/foo/tenants/bar/profiles/baz".
191
- # @param application [::Google::Cloud::Talent::V4beta1::Application, ::Hash]
192
- # Required. The application to be created.
193
- #
194
- # @yield [response, operation] Access the result along with the RPC operation
195
- # @yieldparam response [::Google::Cloud::Talent::V4beta1::Application]
196
- # @yieldparam operation [::GRPC::ActiveCall::Operation]
197
- #
198
- # @return [::Google::Cloud::Talent::V4beta1::Application]
199
- #
200
- # @raise [::Google::Cloud::Error] if the RPC is aborted.
201
- #
202
- # @example Basic example
203
- # require "google/cloud/talent/v4beta1"
204
- #
205
- # # Create a client object. The client can be reused for multiple calls.
206
- # client = Google::Cloud::Talent::V4beta1::ApplicationService::Client.new
207
- #
208
- # # Create a request. To set request fields, pass in keyword arguments.
209
- # request = Google::Cloud::Talent::V4beta1::CreateApplicationRequest.new
210
- #
211
- # # Call the create_application method.
212
- # result = client.create_application request
213
- #
214
- # # The returned object is of type Google::Cloud::Talent::V4beta1::Application.
215
- # p result
216
- #
217
- def create_application request, options = nil
218
- raise ::ArgumentError, "request must be provided" if request.nil?
219
-
220
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Talent::V4beta1::CreateApplicationRequest
221
-
222
- # Converts hash and nil to an options object
223
- options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
224
-
225
- # Customize the options with defaults
226
- metadata = @config.rpcs.create_application.metadata.to_h
227
-
228
- # Set x-goog-api-client and x-goog-user-project headers
229
- metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
230
- lib_name: @config.lib_name, lib_version: @config.lib_version,
231
- gapic_version: ::Google::Cloud::Talent::V4beta1::VERSION
232
- metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
233
-
234
- header_params = {}
235
- if request.parent
236
- header_params["parent"] = request.parent
237
- end
238
-
239
- request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
240
- metadata[:"x-goog-request-params"] ||= request_params_header
241
-
242
- options.apply_defaults timeout: @config.rpcs.create_application.timeout,
243
- metadata: metadata,
244
- retry_policy: @config.rpcs.create_application.retry_policy
245
-
246
- options.apply_defaults timeout: @config.timeout,
247
- metadata: @config.metadata,
248
- retry_policy: @config.retry_policy
249
-
250
- @application_service_stub.call_rpc :create_application, request, options: options do |response, operation|
251
- yield response, operation if block_given?
252
- return response
253
- end
254
- rescue ::GRPC::BadStatus => e
255
- raise ::Google::Cloud::Error.from_error(e)
256
- end
257
-
258
- ##
259
- # Retrieves specified application.
260
- #
261
- # @overload get_application(request, options = nil)
262
- # Pass arguments to `get_application` via a request object, either of type
263
- # {::Google::Cloud::Talent::V4beta1::GetApplicationRequest} or an equivalent Hash.
264
- #
265
- # @param request [::Google::Cloud::Talent::V4beta1::GetApplicationRequest, ::Hash]
266
- # A request object representing the call parameters. Required. To specify no
267
- # parameters, or to keep all the default parameter values, pass an empty Hash.
268
- # @param options [::Gapic::CallOptions, ::Hash]
269
- # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
270
- #
271
- # @overload get_application(name: nil)
272
- # Pass arguments to `get_application` via keyword arguments. Note that at
273
- # least one keyword argument is required. To specify no parameters, or to keep all
274
- # the default parameter values, pass an empty Hash as a request object (see above).
275
- #
276
- # @param name [::String]
277
- # Required. The resource name of the application to be retrieved.
278
- #
279
- # The format is
280
- # "projects/\\{project_id}/tenants/\\{tenant_id}/profiles/\\{profile_id}/applications/\\{application_id}".
281
- # For example, "projects/foo/tenants/bar/profiles/baz/applications/qux".
282
- #
283
- # @yield [response, operation] Access the result along with the RPC operation
284
- # @yieldparam response [::Google::Cloud::Talent::V4beta1::Application]
285
- # @yieldparam operation [::GRPC::ActiveCall::Operation]
286
- #
287
- # @return [::Google::Cloud::Talent::V4beta1::Application]
288
- #
289
- # @raise [::Google::Cloud::Error] if the RPC is aborted.
290
- #
291
- # @example Basic example
292
- # require "google/cloud/talent/v4beta1"
293
- #
294
- # # Create a client object. The client can be reused for multiple calls.
295
- # client = Google::Cloud::Talent::V4beta1::ApplicationService::Client.new
296
- #
297
- # # Create a request. To set request fields, pass in keyword arguments.
298
- # request = Google::Cloud::Talent::V4beta1::GetApplicationRequest.new
299
- #
300
- # # Call the get_application method.
301
- # result = client.get_application request
302
- #
303
- # # The returned object is of type Google::Cloud::Talent::V4beta1::Application.
304
- # p result
305
- #
306
- def get_application request, options = nil
307
- raise ::ArgumentError, "request must be provided" if request.nil?
308
-
309
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Talent::V4beta1::GetApplicationRequest
310
-
311
- # Converts hash and nil to an options object
312
- options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
313
-
314
- # Customize the options with defaults
315
- metadata = @config.rpcs.get_application.metadata.to_h
316
-
317
- # Set x-goog-api-client and x-goog-user-project headers
318
- metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
319
- lib_name: @config.lib_name, lib_version: @config.lib_version,
320
- gapic_version: ::Google::Cloud::Talent::V4beta1::VERSION
321
- metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
322
-
323
- header_params = {}
324
- if request.name
325
- header_params["name"] = request.name
326
- end
327
-
328
- request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
329
- metadata[:"x-goog-request-params"] ||= request_params_header
330
-
331
- options.apply_defaults timeout: @config.rpcs.get_application.timeout,
332
- metadata: metadata,
333
- retry_policy: @config.rpcs.get_application.retry_policy
334
-
335
- options.apply_defaults timeout: @config.timeout,
336
- metadata: @config.metadata,
337
- retry_policy: @config.retry_policy
338
-
339
- @application_service_stub.call_rpc :get_application, request, options: options do |response, operation|
340
- yield response, operation if block_given?
341
- return response
342
- end
343
- rescue ::GRPC::BadStatus => e
344
- raise ::Google::Cloud::Error.from_error(e)
345
- end
346
-
347
- ##
348
- # Updates specified application.
349
- #
350
- # @overload update_application(request, options = nil)
351
- # Pass arguments to `update_application` via a request object, either of type
352
- # {::Google::Cloud::Talent::V4beta1::UpdateApplicationRequest} or an equivalent Hash.
353
- #
354
- # @param request [::Google::Cloud::Talent::V4beta1::UpdateApplicationRequest, ::Hash]
355
- # A request object representing the call parameters. Required. To specify no
356
- # parameters, or to keep all the default parameter values, pass an empty Hash.
357
- # @param options [::Gapic::CallOptions, ::Hash]
358
- # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
359
- #
360
- # @overload update_application(application: nil, update_mask: nil)
361
- # Pass arguments to `update_application` via keyword arguments. Note that at
362
- # least one keyword argument is required. To specify no parameters, or to keep all
363
- # the default parameter values, pass an empty Hash as a request object (see above).
364
- #
365
- # @param application [::Google::Cloud::Talent::V4beta1::Application, ::Hash]
366
- # Required. The application resource to replace the current resource in the system.
367
- # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
368
- # Strongly recommended for the best service experience.
369
- #
370
- # If {::Google::Cloud::Talent::V4beta1::UpdateApplicationRequest#update_mask update_mask} is provided, only the specified fields in
371
- # {::Google::Cloud::Talent::V4beta1::UpdateApplicationRequest#application application} are updated. Otherwise all the fields are updated.
372
- #
373
- # A field mask to specify the application fields to be updated. Only
374
- # top level fields of {::Google::Cloud::Talent::V4beta1::Application Application} are supported.
375
- #
376
- # @yield [response, operation] Access the result along with the RPC operation
377
- # @yieldparam response [::Google::Cloud::Talent::V4beta1::Application]
378
- # @yieldparam operation [::GRPC::ActiveCall::Operation]
379
- #
380
- # @return [::Google::Cloud::Talent::V4beta1::Application]
381
- #
382
- # @raise [::Google::Cloud::Error] if the RPC is aborted.
383
- #
384
- # @example Basic example
385
- # require "google/cloud/talent/v4beta1"
386
- #
387
- # # Create a client object. The client can be reused for multiple calls.
388
- # client = Google::Cloud::Talent::V4beta1::ApplicationService::Client.new
389
- #
390
- # # Create a request. To set request fields, pass in keyword arguments.
391
- # request = Google::Cloud::Talent::V4beta1::UpdateApplicationRequest.new
392
- #
393
- # # Call the update_application method.
394
- # result = client.update_application request
395
- #
396
- # # The returned object is of type Google::Cloud::Talent::V4beta1::Application.
397
- # p result
398
- #
399
- def update_application request, options = nil
400
- raise ::ArgumentError, "request must be provided" if request.nil?
401
-
402
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Talent::V4beta1::UpdateApplicationRequest
403
-
404
- # Converts hash and nil to an options object
405
- options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
406
-
407
- # Customize the options with defaults
408
- metadata = @config.rpcs.update_application.metadata.to_h
409
-
410
- # Set x-goog-api-client and x-goog-user-project headers
411
- metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
412
- lib_name: @config.lib_name, lib_version: @config.lib_version,
413
- gapic_version: ::Google::Cloud::Talent::V4beta1::VERSION
414
- metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
415
-
416
- header_params = {}
417
- if request.application&.name
418
- header_params["application.name"] = request.application.name
419
- end
420
-
421
- request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
422
- metadata[:"x-goog-request-params"] ||= request_params_header
423
-
424
- options.apply_defaults timeout: @config.rpcs.update_application.timeout,
425
- metadata: metadata,
426
- retry_policy: @config.rpcs.update_application.retry_policy
427
-
428
- options.apply_defaults timeout: @config.timeout,
429
- metadata: @config.metadata,
430
- retry_policy: @config.retry_policy
431
-
432
- @application_service_stub.call_rpc :update_application, request, options: options do |response, operation|
433
- yield response, operation if block_given?
434
- return response
435
- end
436
- rescue ::GRPC::BadStatus => e
437
- raise ::Google::Cloud::Error.from_error(e)
438
- end
439
-
440
- ##
441
- # Deletes specified application.
442
- #
443
- # @overload delete_application(request, options = nil)
444
- # Pass arguments to `delete_application` via a request object, either of type
445
- # {::Google::Cloud::Talent::V4beta1::DeleteApplicationRequest} or an equivalent Hash.
446
- #
447
- # @param request [::Google::Cloud::Talent::V4beta1::DeleteApplicationRequest, ::Hash]
448
- # A request object representing the call parameters. Required. To specify no
449
- # parameters, or to keep all the default parameter values, pass an empty Hash.
450
- # @param options [::Gapic::CallOptions, ::Hash]
451
- # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
452
- #
453
- # @overload delete_application(name: nil)
454
- # Pass arguments to `delete_application` via keyword arguments. Note that at
455
- # least one keyword argument is required. To specify no parameters, or to keep all
456
- # the default parameter values, pass an empty Hash as a request object (see above).
457
- #
458
- # @param name [::String]
459
- # Required. The resource name of the application to be deleted.
460
- #
461
- # The format is
462
- # "projects/\\{project_id}/tenants/\\{tenant_id}/profiles/\\{profile_id}/applications/\\{application_id}".
463
- # For example, "projects/foo/tenants/bar/profiles/baz/applications/qux".
464
- #
465
- # @yield [response, operation] Access the result along with the RPC operation
466
- # @yieldparam response [::Google::Protobuf::Empty]
467
- # @yieldparam operation [::GRPC::ActiveCall::Operation]
468
- #
469
- # @return [::Google::Protobuf::Empty]
470
- #
471
- # @raise [::Google::Cloud::Error] if the RPC is aborted.
472
- #
473
- # @example Basic example
474
- # require "google/cloud/talent/v4beta1"
475
- #
476
- # # Create a client object. The client can be reused for multiple calls.
477
- # client = Google::Cloud::Talent::V4beta1::ApplicationService::Client.new
478
- #
479
- # # Create a request. To set request fields, pass in keyword arguments.
480
- # request = Google::Cloud::Talent::V4beta1::DeleteApplicationRequest.new
481
- #
482
- # # Call the delete_application method.
483
- # result = client.delete_application request
484
- #
485
- # # The returned object is of type Google::Protobuf::Empty.
486
- # p result
487
- #
488
- def delete_application request, options = nil
489
- raise ::ArgumentError, "request must be provided" if request.nil?
490
-
491
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Talent::V4beta1::DeleteApplicationRequest
492
-
493
- # Converts hash and nil to an options object
494
- options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
495
-
496
- # Customize the options with defaults
497
- metadata = @config.rpcs.delete_application.metadata.to_h
498
-
499
- # Set x-goog-api-client and x-goog-user-project headers
500
- metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
501
- lib_name: @config.lib_name, lib_version: @config.lib_version,
502
- gapic_version: ::Google::Cloud::Talent::V4beta1::VERSION
503
- metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
504
-
505
- header_params = {}
506
- if request.name
507
- header_params["name"] = request.name
508
- end
509
-
510
- request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
511
- metadata[:"x-goog-request-params"] ||= request_params_header
512
-
513
- options.apply_defaults timeout: @config.rpcs.delete_application.timeout,
514
- metadata: metadata,
515
- retry_policy: @config.rpcs.delete_application.retry_policy
516
-
517
- options.apply_defaults timeout: @config.timeout,
518
- metadata: @config.metadata,
519
- retry_policy: @config.retry_policy
520
-
521
- @application_service_stub.call_rpc :delete_application, request, options: options do |response, operation|
522
- yield response, operation if block_given?
523
- return response
524
- end
525
- rescue ::GRPC::BadStatus => e
526
- raise ::Google::Cloud::Error.from_error(e)
527
- end
528
-
529
- ##
530
- # Lists all applications associated with the profile.
531
- #
532
- # @overload list_applications(request, options = nil)
533
- # Pass arguments to `list_applications` via a request object, either of type
534
- # {::Google::Cloud::Talent::V4beta1::ListApplicationsRequest} or an equivalent Hash.
535
- #
536
- # @param request [::Google::Cloud::Talent::V4beta1::ListApplicationsRequest, ::Hash]
537
- # A request object representing the call parameters. Required. To specify no
538
- # parameters, or to keep all the default parameter values, pass an empty Hash.
539
- # @param options [::Gapic::CallOptions, ::Hash]
540
- # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
541
- #
542
- # @overload list_applications(parent: nil, page_token: nil, page_size: nil)
543
- # Pass arguments to `list_applications` via keyword arguments. Note that at
544
- # least one keyword argument is required. To specify no parameters, or to keep all
545
- # the default parameter values, pass an empty Hash as a request object (see above).
546
- #
547
- # @param parent [::String]
548
- # Required. Resource name of the profile under which the application is created.
549
- #
550
- # The format is
551
- # "projects/\\{project_id}/tenants/\\{tenant_id}/profiles/\\{profile_id}", for
552
- # example, "projects/foo/tenants/bar/profiles/baz".
553
- # @param page_token [::String]
554
- # The starting indicator from which to return results.
555
- # @param page_size [::Integer]
556
- # The maximum number of applications to be returned, at most 100.
557
- # Default is 100 if a non-positive number is provided.
558
- #
559
- # @yield [response, operation] Access the result along with the RPC operation
560
- # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Talent::V4beta1::Application>]
561
- # @yieldparam operation [::GRPC::ActiveCall::Operation]
562
- #
563
- # @return [::Gapic::PagedEnumerable<::Google::Cloud::Talent::V4beta1::Application>]
564
- #
565
- # @raise [::Google::Cloud::Error] if the RPC is aborted.
566
- #
567
- # @example Basic example
568
- # require "google/cloud/talent/v4beta1"
569
- #
570
- # # Create a client object. The client can be reused for multiple calls.
571
- # client = Google::Cloud::Talent::V4beta1::ApplicationService::Client.new
572
- #
573
- # # Create a request. To set request fields, pass in keyword arguments.
574
- # request = Google::Cloud::Talent::V4beta1::ListApplicationsRequest.new
575
- #
576
- # # Call the list_applications method.
577
- # result = client.list_applications request
578
- #
579
- # # The returned object is of type Gapic::PagedEnumerable. You can
580
- # # iterate over all elements by calling #each, and the enumerable
581
- # # will lazily make API calls to fetch subsequent pages. Other
582
- # # methods are also available for managing paging directly.
583
- # result.each do |response|
584
- # # Each element is of type ::Google::Cloud::Talent::V4beta1::Application.
585
- # p response
586
- # end
587
- #
588
- def list_applications request, options = nil
589
- raise ::ArgumentError, "request must be provided" if request.nil?
590
-
591
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Talent::V4beta1::ListApplicationsRequest
592
-
593
- # Converts hash and nil to an options object
594
- options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
595
-
596
- # Customize the options with defaults
597
- metadata = @config.rpcs.list_applications.metadata.to_h
598
-
599
- # Set x-goog-api-client and x-goog-user-project headers
600
- metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
601
- lib_name: @config.lib_name, lib_version: @config.lib_version,
602
- gapic_version: ::Google::Cloud::Talent::V4beta1::VERSION
603
- metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
604
-
605
- header_params = {}
606
- if request.parent
607
- header_params["parent"] = request.parent
608
- end
609
-
610
- request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
611
- metadata[:"x-goog-request-params"] ||= request_params_header
612
-
613
- options.apply_defaults timeout: @config.rpcs.list_applications.timeout,
614
- metadata: metadata,
615
- retry_policy: @config.rpcs.list_applications.retry_policy
616
-
617
- options.apply_defaults timeout: @config.timeout,
618
- metadata: @config.metadata,
619
- retry_policy: @config.retry_policy
620
-
621
- @application_service_stub.call_rpc :list_applications, request, options: options do |response, operation|
622
- response = ::Gapic::PagedEnumerable.new @application_service_stub, :list_applications, request, response, operation, options
623
- yield response, operation if block_given?
624
- return response
625
- end
626
- rescue ::GRPC::BadStatus => e
627
- raise ::Google::Cloud::Error.from_error(e)
628
- end
629
-
630
- ##
631
- # Configuration class for the ApplicationService API.
632
- #
633
- # This class represents the configuration for ApplicationService,
634
- # providing control over timeouts, retry behavior, logging, transport
635
- # parameters, and other low-level controls. Certain parameters can also be
636
- # applied individually to specific RPCs. See
637
- # {::Google::Cloud::Talent::V4beta1::ApplicationService::Client::Configuration::Rpcs}
638
- # for a list of RPCs that can be configured independently.
639
- #
640
- # Configuration can be applied globally to all clients, or to a single client
641
- # on construction.
642
- #
643
- # @example
644
- #
645
- # # Modify the global config, setting the timeout for
646
- # # create_application to 20 seconds,
647
- # # and all remaining timeouts to 10 seconds.
648
- # ::Google::Cloud::Talent::V4beta1::ApplicationService::Client.configure do |config|
649
- # config.timeout = 10.0
650
- # config.rpcs.create_application.timeout = 20.0
651
- # end
652
- #
653
- # # Apply the above configuration only to a new client.
654
- # client = ::Google::Cloud::Talent::V4beta1::ApplicationService::Client.new do |config|
655
- # config.timeout = 10.0
656
- # config.rpcs.create_application.timeout = 20.0
657
- # end
658
- #
659
- # @!attribute [rw] endpoint
660
- # The hostname or hostname:port of the service endpoint.
661
- # Defaults to `"jobs.googleapis.com"`.
662
- # @return [::String]
663
- # @!attribute [rw] credentials
664
- # Credentials to send with calls. You may provide any of the following types:
665
- # * (`String`) The path to a service account key file in JSON format
666
- # * (`Hash`) A service account key as a Hash
667
- # * (`Google::Auth::Credentials`) A googleauth credentials object
668
- # (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
669
- # * (`Signet::OAuth2::Client`) A signet oauth2 client object
670
- # (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
671
- # * (`GRPC::Core::Channel`) a gRPC channel with included credentials
672
- # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
673
- # * (`nil`) indicating no credentials
674
- # @return [::Object]
675
- # @!attribute [rw] scope
676
- # The OAuth scopes
677
- # @return [::Array<::String>]
678
- # @!attribute [rw] lib_name
679
- # The library name as recorded in instrumentation and logging
680
- # @return [::String]
681
- # @!attribute [rw] lib_version
682
- # The library version as recorded in instrumentation and logging
683
- # @return [::String]
684
- # @!attribute [rw] channel_args
685
- # Extra parameters passed to the gRPC channel. Note: this is ignored if a
686
- # `GRPC::Core::Channel` object is provided as the credential.
687
- # @return [::Hash]
688
- # @!attribute [rw] interceptors
689
- # An array of interceptors that are run before calls are executed.
690
- # @return [::Array<::GRPC::ClientInterceptor>]
691
- # @!attribute [rw] timeout
692
- # The call timeout in seconds.
693
- # @return [::Numeric]
694
- # @!attribute [rw] metadata
695
- # Additional gRPC headers to be sent with the call.
696
- # @return [::Hash{::Symbol=>::String}]
697
- # @!attribute [rw] retry_policy
698
- # The retry policy. The value is a hash with the following keys:
699
- # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
700
- # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
701
- # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
702
- # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
703
- # trigger a retry.
704
- # @return [::Hash]
705
- # @!attribute [rw] quota_project
706
- # A separate project against which to charge quota.
707
- # @return [::String]
708
- #
709
- class Configuration
710
- extend ::Gapic::Config
711
-
712
- config_attr :endpoint, "jobs.googleapis.com", ::String
713
- config_attr :credentials, nil do |value|
714
- allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
715
- allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
716
- allowed.any? { |klass| klass === value }
717
- end
718
- config_attr :scope, nil, ::String, ::Array, nil
719
- config_attr :lib_name, nil, ::String, nil
720
- config_attr :lib_version, nil, ::String, nil
721
- config_attr(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
722
- config_attr :interceptors, nil, ::Array, nil
723
- config_attr :timeout, nil, ::Numeric, nil
724
- config_attr :metadata, nil, ::Hash, nil
725
- config_attr :retry_policy, nil, ::Hash, ::Proc, nil
726
- config_attr :quota_project, nil, ::String, nil
727
-
728
- # @private
729
- def initialize parent_config = nil
730
- @parent_config = parent_config unless parent_config.nil?
731
-
732
- yield self if block_given?
733
- end
734
-
735
- ##
736
- # Configurations for individual RPCs
737
- # @return [Rpcs]
738
- #
739
- def rpcs
740
- @rpcs ||= begin
741
- parent_rpcs = nil
742
- parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
743
- Rpcs.new parent_rpcs
744
- end
745
- end
746
-
747
- ##
748
- # Configuration RPC class for the ApplicationService API.
749
- #
750
- # Includes fields providing the configuration for each RPC in this service.
751
- # Each configuration object is of type `Gapic::Config::Method` and includes
752
- # the following configuration fields:
753
- #
754
- # * `timeout` (*type:* `Numeric`) - The call timeout in seconds
755
- # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
756
- # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
757
- # include the following keys:
758
- # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
759
- # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
760
- # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
761
- # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
762
- # trigger a retry.
763
- #
764
- class Rpcs
765
- ##
766
- # RPC-specific configuration for `create_application`
767
- # @return [::Gapic::Config::Method]
768
- #
769
- attr_reader :create_application
770
- ##
771
- # RPC-specific configuration for `get_application`
772
- # @return [::Gapic::Config::Method]
773
- #
774
- attr_reader :get_application
775
- ##
776
- # RPC-specific configuration for `update_application`
777
- # @return [::Gapic::Config::Method]
778
- #
779
- attr_reader :update_application
780
- ##
781
- # RPC-specific configuration for `delete_application`
782
- # @return [::Gapic::Config::Method]
783
- #
784
- attr_reader :delete_application
785
- ##
786
- # RPC-specific configuration for `list_applications`
787
- # @return [::Gapic::Config::Method]
788
- #
789
- attr_reader :list_applications
790
-
791
- # @private
792
- def initialize parent_rpcs = nil
793
- create_application_config = parent_rpcs.create_application if parent_rpcs.respond_to? :create_application
794
- @create_application = ::Gapic::Config::Method.new create_application_config
795
- get_application_config = parent_rpcs.get_application if parent_rpcs.respond_to? :get_application
796
- @get_application = ::Gapic::Config::Method.new get_application_config
797
- update_application_config = parent_rpcs.update_application if parent_rpcs.respond_to? :update_application
798
- @update_application = ::Gapic::Config::Method.new update_application_config
799
- delete_application_config = parent_rpcs.delete_application if parent_rpcs.respond_to? :delete_application
800
- @delete_application = ::Gapic::Config::Method.new delete_application_config
801
- list_applications_config = parent_rpcs.list_applications if parent_rpcs.respond_to? :list_applications
802
- @list_applications = ::Gapic::Config::Method.new list_applications_config
803
-
804
- yield self if block_given?
805
- end
806
- end
807
- end
808
- end
809
- end
810
- end
811
- end
812
- end
813
- end