google-cloud-beyond_corp-client_connector_services-v1 0.4.1 → 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (29) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +3 -143
  3. data/lib/google/cloud/beyond_corp/client_connector_services/v1/version.rb +3 -8
  4. metadata +15 -226
  5. data/.yardopts +0 -12
  6. data/AUTHENTICATION.md +0 -122
  7. data/lib/google/cloud/beyond_corp/client_connector_services/v1/client_connector_services_service/client.rb +0 -954
  8. data/lib/google/cloud/beyond_corp/client_connector_services/v1/client_connector_services_service/credentials.rb +0 -49
  9. data/lib/google/cloud/beyond_corp/client_connector_services/v1/client_connector_services_service/operations.rb +0 -803
  10. data/lib/google/cloud/beyond_corp/client_connector_services/v1/client_connector_services_service/paths.rb +0 -71
  11. data/lib/google/cloud/beyond_corp/client_connector_services/v1/client_connector_services_service.rb +0 -62
  12. data/lib/google/cloud/beyond_corp/client_connector_services/v1.rb +0 -42
  13. data/lib/google/cloud/beyondcorp/clientconnectorservices/v1/client_connector_services_service_pb.rb +0 -68
  14. data/lib/google/cloud/beyondcorp/clientconnectorservices/v1/client_connector_services_service_services_pb.rb +0 -65
  15. data/lib/google-cloud-beyond_corp-client_connector_services-v1.rb +0 -21
  16. data/proto_docs/README.md +0 -4
  17. data/proto_docs/google/api/client.rb +0 -395
  18. data/proto_docs/google/api/field_behavior.rb +0 -85
  19. data/proto_docs/google/api/launch_stage.rb +0 -71
  20. data/proto_docs/google/api/resource.rb +0 -222
  21. data/proto_docs/google/cloud/beyondcorp/clientconnectorservices/v1/client_connector_services_service.rb +0 -336
  22. data/proto_docs/google/longrunning/operations.rb +0 -164
  23. data/proto_docs/google/protobuf/any.rb +0 -144
  24. data/proto_docs/google/protobuf/duration.rb +0 -98
  25. data/proto_docs/google/protobuf/empty.rb +0 -34
  26. data/proto_docs/google/protobuf/field_mask.rb +0 -229
  27. data/proto_docs/google/protobuf/timestamp.rb +0 -127
  28. data/proto_docs/google/rpc/status.rb +0 -48
  29. data/proto_docs/google/type/expr.rb +0 -75
data/lib/google/cloud/beyond_corp/client_connector_services/v1/client_connector_services_service/client.rb DELETED
@@ -1,954 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- # Copyright 2022 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/beyondcorp/clientconnectorservices/v1/client_connector_services_service_pb"
21
- require "google/cloud/location"
22
- require "google/iam/v1"
23
-
24
- module Google
25
- module Cloud
26
- module BeyondCorp
27
- module ClientConnectorServices
28
- module V1
29
- module ClientConnectorServicesService
30
- ##
31
- # Client for the ClientConnectorServicesService service.
32
- #
33
- # API Overview:
34
- #
35
- # The `beyondcorp.googleapis.com` service implements the Google Cloud
36
- # BeyondCorp API.
37
- #
38
- # Data Model:
39
- #
40
- # The ClientConnectorServicesService exposes the following resources:
41
- #
42
- # * Client Connector Services, named as follows:
43
- # `projects/{project_id}/locations/{location_id}/client_connector_services/{client_connector_service_id}`.
44
- #
45
- class Client
46
- # @private
47
- DEFAULT_ENDPOINT_TEMPLATE = "beyondcorp.$UNIVERSE_DOMAIN$"
48
-
49
- include Paths
50
-
51
- # @private
52
- attr_reader :client_connector_services_service_stub
53
-
54
- ##
55
- # Configure the ClientConnectorServicesService Client class.
56
- #
57
- # See {::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ClientConnectorServicesService::Client::Configuration}
58
- # for a description of the configuration fields.
59
- #
60
- # @example
61
- #
62
- # # Modify the configuration for all ClientConnectorServicesService clients
63
- # ::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ClientConnectorServicesService::Client.configure do |config|
64
- # config.timeout = 10.0
65
- # end
66
- #
67
- # @yield [config] Configure the Client client.
68
- # @yieldparam config [Client::Configuration]
69
- #
70
- # @return [Client::Configuration]
71
- #
72
- def self.configure
73
- @configure ||= begin
74
- namespace = ["Google", "Cloud", "BeyondCorp", "ClientConnectorServices", "V1"]
75
- parent_config = while namespace.any?
76
- parent_name = namespace.join "::"
77
- parent_const = const_get parent_name
78
- break parent_const.configure if parent_const.respond_to? :configure
79
- namespace.pop
80
- end
81
- default_config = Client::Configuration.new parent_config
82
-
83
- default_config
84
- end
85
- yield @configure if block_given?
86
- @configure
87
- end
88
-
89
- ##
90
- # Configure the ClientConnectorServicesService Client instance.
91
- #
92
- # The configuration is set to the derived mode, meaning that values can be changed,
93
- # but structural changes (adding new fields, etc.) are not allowed. Structural changes
94
- # should be made on {Client.configure}.
95
- #
96
- # See {::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ClientConnectorServicesService::Client::Configuration}
97
- # for a description of the configuration fields.
98
- #
99
- # @yield [config] Configure the Client client.
100
- # @yieldparam config [Client::Configuration]
101
- #
102
- # @return [Client::Configuration]
103
- #
104
- def configure
105
- yield @config if block_given?
106
- @config
107
- end
108
-
109
- ##
110
- # The effective universe domain
111
- #
112
- # @return [String]
113
- #
114
- def universe_domain
115
- @client_connector_services_service_stub.universe_domain
116
- end
117
-
118
- ##
119
- # Create a new ClientConnectorServicesService client object.
120
- #
121
- # @example
122
- #
123
- # # Create a client using the default configuration
124
- # client = ::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ClientConnectorServicesService::Client.new
125
- #
126
- # # Create a client using a custom configuration
127
- # client = ::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ClientConnectorServicesService::Client.new do |config|
128
- # config.timeout = 10.0
129
- # end
130
- #
131
- # @yield [config] Configure the ClientConnectorServicesService client.
132
- # @yieldparam config [Client::Configuration]
133
- #
134
- def initialize
135
- # These require statements are intentionally placed here to initialize
136
- # the gRPC module only when it's required.
137
- # See https://github.com/googleapis/toolkit/issues/446
138
- require "gapic/grpc"
139
- require "google/cloud/beyondcorp/clientconnectorservices/v1/client_connector_services_service_services_pb"
140
-
141
- # Create the configuration object
142
- @config = Configuration.new Client.configure
143
-
144
- # Yield the configuration if needed
145
- yield @config if block_given?
146
-
147
- # Create credentials
148
- credentials = @config.credentials
149
- # Use self-signed JWT if the endpoint is unchanged from default,
150
- # but only if the default endpoint does not have a region prefix.
151
- enable_self_signed_jwt = @config.endpoint.nil? ||
152
- (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
153
- !@config.endpoint.split(".").first.include?("-"))
154
- credentials ||= Credentials.default scope: @config.scope,
155
- enable_self_signed_jwt: enable_self_signed_jwt
156
- if credentials.is_a?(::String) || credentials.is_a?(::Hash)
157
- credentials = Credentials.new credentials, scope: @config.scope
158
- end
159
- @quota_project_id = @config.quota_project
160
- @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
161
-
162
- @operations_client = Operations.new do |config|
163
- config.credentials = credentials
164
- config.quota_project = @quota_project_id
165
- config.endpoint = @config.endpoint
166
- config.universe_domain = @config.universe_domain
167
- end
168
-
169
- @client_connector_services_service_stub = ::Gapic::ServiceStub.new(
170
- ::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ClientConnectorServicesService::Stub,
171
- credentials: credentials,
172
- endpoint: @config.endpoint,
173
- endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
174
- universe_domain: @config.universe_domain,
175
- channel_args: @config.channel_args,
176
- interceptors: @config.interceptors,
177
- channel_pool_config: @config.channel_pool
178
- )
179
-
180
- @location_client = Google::Cloud::Location::Locations::Client.new do |config|
181
- config.credentials = credentials
182
- config.quota_project = @quota_project_id
183
- config.endpoint = @client_connector_services_service_stub.endpoint
184
- config.universe_domain = @client_connector_services_service_stub.universe_domain
185
- end
186
-
187
- @iam_policy_client = Google::Iam::V1::IAMPolicy::Client.new do |config|
188
- config.credentials = credentials
189
- config.quota_project = @quota_project_id
190
- config.endpoint = @client_connector_services_service_stub.endpoint
191
- config.universe_domain = @client_connector_services_service_stub.universe_domain
192
- end
193
- end
194
-
195
- ##
196
- # Get the associated client for long-running operations.
197
- #
198
- # @return [::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ClientConnectorServicesService::Operations]
199
- #
200
- attr_reader :operations_client
201
-
202
- ##
203
- # Get the associated client for mix-in of the Locations.
204
- #
205
- # @return [Google::Cloud::Location::Locations::Client]
206
- #
207
- attr_reader :location_client
208
-
209
- ##
210
- # Get the associated client for mix-in of the IAMPolicy.
211
- #
212
- # @return [Google::Iam::V1::IAMPolicy::Client]
213
- #
214
- attr_reader :iam_policy_client
215
-
216
- # Service calls
217
-
218
- ##
219
- # Lists ClientConnectorServices in a given project and location.
220
- #
221
- # @overload list_client_connector_services(request, options = nil)
222
- # Pass arguments to `list_client_connector_services` via a request object, either of type
223
- # {::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ListClientConnectorServicesRequest} or an equivalent Hash.
224
- #
225
- # @param request [::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ListClientConnectorServicesRequest, ::Hash]
226
- # A request object representing the call parameters. Required. To specify no
227
- # parameters, or to keep all the default parameter values, pass an empty Hash.
228
- # @param options [::Gapic::CallOptions, ::Hash]
229
- # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
230
- #
231
- # @overload list_client_connector_services(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil)
232
- # Pass arguments to `list_client_connector_services` via keyword arguments. Note that at
233
- # least one keyword argument is required. To specify no parameters, or to keep all
234
- # the default parameter values, pass an empty Hash as a request object (see above).
235
- #
236
- # @param parent [::String]
237
- # Required. Parent value for ListClientConnectorServicesRequest.
238
- # @param page_size [::Integer]
239
- # Optional. Requested page size. Server may return fewer items than
240
- # requested. If unspecified, server will pick an appropriate default.
241
- # @param page_token [::String]
242
- # Optional. A token identifying a page of results the server should return.
243
- # @param filter [::String]
244
- # Optional. Filtering results.
245
- # @param order_by [::String]
246
- # Optional. Hint for how to order the results.
247
- #
248
- # @yield [response, operation] Access the result along with the RPC operation
249
- # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ClientConnectorService>]
250
- # @yieldparam operation [::GRPC::ActiveCall::Operation]
251
- #
252
- # @return [::Gapic::PagedEnumerable<::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ClientConnectorService>]
253
- #
254
- # @raise [::Google::Cloud::Error] if the RPC is aborted.
255
- #
256
- # @example Basic example
257
- # require "google/cloud/beyond_corp/client_connector_services/v1"
258
- #
259
- # # Create a client object. The client can be reused for multiple calls.
260
- # client = Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ClientConnectorServicesService::Client.new
261
- #
262
- # # Create a request. To set request fields, pass in keyword arguments.
263
- # request = Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ListClientConnectorServicesRequest.new
264
- #
265
- # # Call the list_client_connector_services method.
266
- # result = client.list_client_connector_services request
267
- #
268
- # # The returned object is of type Gapic::PagedEnumerable. You can iterate
269
- # # over elements, and API calls will be issued to fetch pages as needed.
270
- # result.each do |item|
271
- # # Each element is of type ::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ClientConnectorService.
272
- # p item
273
- # end
274
- #
275
- def list_client_connector_services request, options = nil
276
- raise ::ArgumentError, "request must be provided" if request.nil?
277
-
278
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ListClientConnectorServicesRequest
279
-
280
- # Converts hash and nil to an options object
281
- options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
282
-
283
- # Customize the options with defaults
284
- metadata = @config.rpcs.list_client_connector_services.metadata.to_h
285
-
286
- # Set x-goog-api-client and x-goog-user-project headers
287
- metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
288
- lib_name: @config.lib_name, lib_version: @config.lib_version,
289
- gapic_version: ::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::VERSION
290
- metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
291
-
292
- header_params = {}
293
- if request.parent
294
- header_params["parent"] = request.parent
295
- end
296
-
297
- request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
298
- metadata[:"x-goog-request-params"] ||= request_params_header
299
-
300
- options.apply_defaults timeout: @config.rpcs.list_client_connector_services.timeout,
301
- metadata: metadata,
302
- retry_policy: @config.rpcs.list_client_connector_services.retry_policy
303
-
304
- options.apply_defaults timeout: @config.timeout,
305
- metadata: @config.metadata,
306
- retry_policy: @config.retry_policy
307
-
308
- @client_connector_services_service_stub.call_rpc :list_client_connector_services, request, options: options do |response, operation|
309
- response = ::Gapic::PagedEnumerable.new @client_connector_services_service_stub, :list_client_connector_services, request, response, operation, options
310
- yield response, operation if block_given?
311
- return response
312
- end
313
- rescue ::GRPC::BadStatus => e
314
- raise ::Google::Cloud::Error.from_error(e)
315
- end
316
-
317
- ##
318
- # Gets details of a single ClientConnectorService.
319
- #
320
- # @overload get_client_connector_service(request, options = nil)
321
- # Pass arguments to `get_client_connector_service` via a request object, either of type
322
- # {::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::GetClientConnectorServiceRequest} or an equivalent Hash.
323
- #
324
- # @param request [::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::GetClientConnectorServiceRequest, ::Hash]
325
- # A request object representing the call parameters. Required. To specify no
326
- # parameters, or to keep all the default parameter values, pass an empty Hash.
327
- # @param options [::Gapic::CallOptions, ::Hash]
328
- # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
329
- #
330
- # @overload get_client_connector_service(name: nil)
331
- # Pass arguments to `get_client_connector_service` via keyword arguments. Note that at
332
- # least one keyword argument is required. To specify no parameters, or to keep all
333
- # the default parameter values, pass an empty Hash as a request object (see above).
334
- #
335
- # @param name [::String]
336
- # Required. Name of the resource.
337
- #
338
- # @yield [response, operation] Access the result along with the RPC operation
339
- # @yieldparam response [::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ClientConnectorService]
340
- # @yieldparam operation [::GRPC::ActiveCall::Operation]
341
- #
342
- # @return [::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ClientConnectorService]
343
- #
344
- # @raise [::Google::Cloud::Error] if the RPC is aborted.
345
- #
346
- # @example Basic example
347
- # require "google/cloud/beyond_corp/client_connector_services/v1"
348
- #
349
- # # Create a client object. The client can be reused for multiple calls.
350
- # client = Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ClientConnectorServicesService::Client.new
351
- #
352
- # # Create a request. To set request fields, pass in keyword arguments.
353
- # request = Google::Cloud::BeyondCorp::ClientConnectorServices::V1::GetClientConnectorServiceRequest.new
354
- #
355
- # # Call the get_client_connector_service method.
356
- # result = client.get_client_connector_service request
357
- #
358
- # # The returned object is of type Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ClientConnectorService.
359
- # p result
360
- #
361
- def get_client_connector_service request, options = nil
362
- raise ::ArgumentError, "request must be provided" if request.nil?
363
-
364
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::GetClientConnectorServiceRequest
365
-
366
- # Converts hash and nil to an options object
367
- options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
368
-
369
- # Customize the options with defaults
370
- metadata = @config.rpcs.get_client_connector_service.metadata.to_h
371
-
372
- # Set x-goog-api-client and x-goog-user-project headers
373
- metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
374
- lib_name: @config.lib_name, lib_version: @config.lib_version,
375
- gapic_version: ::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::VERSION
376
- metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
377
-
378
- header_params = {}
379
- if request.name
380
- header_params["name"] = request.name
381
- end
382
-
383
- request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
384
- metadata[:"x-goog-request-params"] ||= request_params_header
385
-
386
- options.apply_defaults timeout: @config.rpcs.get_client_connector_service.timeout,
387
- metadata: metadata,
388
- retry_policy: @config.rpcs.get_client_connector_service.retry_policy
389
-
390
- options.apply_defaults timeout: @config.timeout,
391
- metadata: @config.metadata,
392
- retry_policy: @config.retry_policy
393
-
394
- @client_connector_services_service_stub.call_rpc :get_client_connector_service, request, options: options do |response, operation|
395
- yield response, operation if block_given?
396
- return response
397
- end
398
- rescue ::GRPC::BadStatus => e
399
- raise ::Google::Cloud::Error.from_error(e)
400
- end
401
-
402
- ##
403
- # Creates a new ClientConnectorService in a given project and location.
404
- #
405
- # @overload create_client_connector_service(request, options = nil)
406
- # Pass arguments to `create_client_connector_service` via a request object, either of type
407
- # {::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::CreateClientConnectorServiceRequest} or an equivalent Hash.
408
- #
409
- # @param request [::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::CreateClientConnectorServiceRequest, ::Hash]
410
- # A request object representing the call parameters. Required. To specify no
411
- # parameters, or to keep all the default parameter values, pass an empty Hash.
412
- # @param options [::Gapic::CallOptions, ::Hash]
413
- # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
414
- #
415
- # @overload create_client_connector_service(parent: nil, client_connector_service_id: nil, client_connector_service: nil, request_id: nil, validate_only: nil)
416
- # Pass arguments to `create_client_connector_service` via keyword arguments. Note that at
417
- # least one keyword argument is required. To specify no parameters, or to keep all
418
- # the default parameter values, pass an empty Hash as a request object (see above).
419
- #
420
- # @param parent [::String]
421
- # Required. Value for parent.
422
- # @param client_connector_service_id [::String]
423
- # Optional. User-settable client connector service resource ID.
424
- # * Must start with a letter.
425
- # * Must contain between 4-63 characters from `/[a-z][0-9]-/`.
426
- # * Must end with a number or a letter.
427
- #
428
- # A random system generated name will be assigned
429
- # if not specified by the user.
430
- # @param client_connector_service [::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ClientConnectorService, ::Hash]
431
- # Required. The resource being created.
432
- # @param request_id [::String]
433
- # Optional. An optional request ID to identify requests. Specify a unique
434
- # request ID so that if you must retry your request, the server will know to
435
- # ignore the request if it has already been completed. The server will
436
- # guarantee that for at least 60 minutes since the first request.
437
- #
438
- # For example, consider a situation where you make an initial request and t
439
- # he request times out. If you make the request again with the same request
440
- # ID, the server can check if original operation with the same request ID
441
- # was received, and if so, will ignore the second request. This prevents
442
- # clients from accidentally creating duplicate commitments.
443
- #
444
- # The request ID must be a valid UUID with the exception that zero UUID is
445
- # not supported (00000000-0000-0000-0000-000000000000).
446
- # @param validate_only [::Boolean]
447
- # Optional. If set, validates request by executing a dry-run which would not
448
- # alter the resource in any way.
449
- #
450
- # @yield [response, operation] Access the result along with the RPC operation
451
- # @yieldparam response [::Gapic::Operation]
452
- # @yieldparam operation [::GRPC::ActiveCall::Operation]
453
- #
454
- # @return [::Gapic::Operation]
455
- #
456
- # @raise [::Google::Cloud::Error] if the RPC is aborted.
457
- #
458
- # @example Basic example
459
- # require "google/cloud/beyond_corp/client_connector_services/v1"
460
- #
461
- # # Create a client object. The client can be reused for multiple calls.
462
- # client = Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ClientConnectorServicesService::Client.new
463
- #
464
- # # Create a request. To set request fields, pass in keyword arguments.
465
- # request = Google::Cloud::BeyondCorp::ClientConnectorServices::V1::CreateClientConnectorServiceRequest.new
466
- #
467
- # # Call the create_client_connector_service method.
468
- # result = client.create_client_connector_service request
469
- #
470
- # # The returned object is of type Gapic::Operation. You can use it to
471
- # # check the status of an operation, cancel it, or wait for results.
472
- # # Here is how to wait for a response.
473
- # result.wait_until_done! timeout: 60
474
- # if result.response?
475
- # p result.response
476
- # else
477
- # puts "No response received."
478
- # end
479
- #
480
- def create_client_connector_service request, options = nil
481
- raise ::ArgumentError, "request must be provided" if request.nil?
482
-
483
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::CreateClientConnectorServiceRequest
484
-
485
- # Converts hash and nil to an options object
486
- options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
487
-
488
- # Customize the options with defaults
489
- metadata = @config.rpcs.create_client_connector_service.metadata.to_h
490
-
491
- # Set x-goog-api-client and x-goog-user-project headers
492
- metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
493
- lib_name: @config.lib_name, lib_version: @config.lib_version,
494
- gapic_version: ::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::VERSION
495
- metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
496
-
497
- header_params = {}
498
- if request.parent
499
- header_params["parent"] = request.parent
500
- end
501
-
502
- request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
503
- metadata[:"x-goog-request-params"] ||= request_params_header
504
-
505
- options.apply_defaults timeout: @config.rpcs.create_client_connector_service.timeout,
506
- metadata: metadata,
507
- retry_policy: @config.rpcs.create_client_connector_service.retry_policy
508
-
509
- options.apply_defaults timeout: @config.timeout,
510
- metadata: @config.metadata,
511
- retry_policy: @config.retry_policy
512
-
513
- @client_connector_services_service_stub.call_rpc :create_client_connector_service, request, options: options do |response, operation|
514
- response = ::Gapic::Operation.new response, @operations_client, options: options
515
- yield response, operation if block_given?
516
- return response
517
- end
518
- rescue ::GRPC::BadStatus => e
519
- raise ::Google::Cloud::Error.from_error(e)
520
- end
521
-
522
- ##
523
- # Updates the parameters of a single ClientConnectorService.
524
- #
525
- # @overload update_client_connector_service(request, options = nil)
526
- # Pass arguments to `update_client_connector_service` via a request object, either of type
527
- # {::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::UpdateClientConnectorServiceRequest} or an equivalent Hash.
528
- #
529
- # @param request [::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::UpdateClientConnectorServiceRequest, ::Hash]
530
- # A request object representing the call parameters. Required. To specify no
531
- # parameters, or to keep all the default parameter values, pass an empty Hash.
532
- # @param options [::Gapic::CallOptions, ::Hash]
533
- # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
534
- #
535
- # @overload update_client_connector_service(update_mask: nil, client_connector_service: nil, request_id: nil, validate_only: nil, allow_missing: nil)
536
- # Pass arguments to `update_client_connector_service` via keyword arguments. Note that at
537
- # least one keyword argument is required. To specify no parameters, or to keep all
538
- # the default parameter values, pass an empty Hash as a request object (see above).
539
- #
540
- # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
541
- # Required. Field mask is used to specify the fields to be overwritten in the
542
- # ClientConnectorService resource by the update.
543
- # The fields specified in the update_mask are relative to the resource, not
544
- # the full request. A field will be overwritten if it is in the mask. If the
545
- # user does not provide a mask then all fields will be overwritten.
546
- #
547
- # Mutable fields: display_name.
548
- # @param client_connector_service [::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ClientConnectorService, ::Hash]
549
- # Required. The resource being updated.
550
- # @param request_id [::String]
551
- # Optional. An optional request ID to identify requests. Specify a unique
552
- # request ID so that if you must retry your request, the server will know to
553
- # ignore the request if it has already been completed. The server will
554
- # guarantee that for at least 60 minutes since the first request.
555
- #
556
- # For example, consider a situation where you make an initial request and t
557
- # he request times out. If you make the request again with the same request
558
- # ID, the server can check if original operation with the same request ID
559
- # was received, and if so, will ignore the second request. This prevents
560
- # clients from accidentally creating duplicate commitments.
561
- #
562
- # The request ID must be a valid UUID with the exception that zero UUID is
563
- # not supported (00000000-0000-0000-0000-000000000000).
564
- # @param validate_only [::Boolean]
565
- # Optional. If set, validates request by executing a dry-run which would not
566
- # alter the resource in any way.
567
- # @param allow_missing [::Boolean]
568
- # Optional. If set as true, will create the resource if it is not found.
569
- #
570
- # @yield [response, operation] Access the result along with the RPC operation
571
- # @yieldparam response [::Gapic::Operation]
572
- # @yieldparam operation [::GRPC::ActiveCall::Operation]
573
- #
574
- # @return [::Gapic::Operation]
575
- #
576
- # @raise [::Google::Cloud::Error] if the RPC is aborted.
577
- #
578
- # @example Basic example
579
- # require "google/cloud/beyond_corp/client_connector_services/v1"
580
- #
581
- # # Create a client object. The client can be reused for multiple calls.
582
- # client = Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ClientConnectorServicesService::Client.new
583
- #
584
- # # Create a request. To set request fields, pass in keyword arguments.
585
- # request = Google::Cloud::BeyondCorp::ClientConnectorServices::V1::UpdateClientConnectorServiceRequest.new
586
- #
587
- # # Call the update_client_connector_service method.
588
- # result = client.update_client_connector_service request
589
- #
590
- # # The returned object is of type Gapic::Operation. You can use it to
591
- # # check the status of an operation, cancel it, or wait for results.
592
- # # Here is how to wait for a response.
593
- # result.wait_until_done! timeout: 60
594
- # if result.response?
595
- # p result.response
596
- # else
597
- # puts "No response received."
598
- # end
599
- #
600
- def update_client_connector_service request, options = nil
601
- raise ::ArgumentError, "request must be provided" if request.nil?
602
-
603
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::UpdateClientConnectorServiceRequest
604
-
605
- # Converts hash and nil to an options object
606
- options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
607
-
608
- # Customize the options with defaults
609
- metadata = @config.rpcs.update_client_connector_service.metadata.to_h
610
-
611
- # Set x-goog-api-client and x-goog-user-project headers
612
- metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
613
- lib_name: @config.lib_name, lib_version: @config.lib_version,
614
- gapic_version: ::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::VERSION
615
- metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
616
-
617
- header_params = {}
618
- if request.client_connector_service&.name
619
- header_params["client_connector_service.name"] = request.client_connector_service.name
620
- end
621
-
622
- request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
623
- metadata[:"x-goog-request-params"] ||= request_params_header
624
-
625
- options.apply_defaults timeout: @config.rpcs.update_client_connector_service.timeout,
626
- metadata: metadata,
627
- retry_policy: @config.rpcs.update_client_connector_service.retry_policy
628
-
629
- options.apply_defaults timeout: @config.timeout,
630
- metadata: @config.metadata,
631
- retry_policy: @config.retry_policy
632
-
633
- @client_connector_services_service_stub.call_rpc :update_client_connector_service, request, options: options do |response, operation|
634
- response = ::Gapic::Operation.new response, @operations_client, options: options
635
- yield response, operation if block_given?
636
- return response
637
- end
638
- rescue ::GRPC::BadStatus => e
639
- raise ::Google::Cloud::Error.from_error(e)
640
- end
641
-
642
- ##
643
- # Deletes a single ClientConnectorService.
644
- #
645
- # @overload delete_client_connector_service(request, options = nil)
646
- # Pass arguments to `delete_client_connector_service` via a request object, either of type
647
- # {::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::DeleteClientConnectorServiceRequest} or an equivalent Hash.
648
- #
649
- # @param request [::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::DeleteClientConnectorServiceRequest, ::Hash]
650
- # A request object representing the call parameters. Required. To specify no
651
- # parameters, or to keep all the default parameter values, pass an empty Hash.
652
- # @param options [::Gapic::CallOptions, ::Hash]
653
- # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
654
- #
655
- # @overload delete_client_connector_service(name: nil, request_id: nil, validate_only: nil)
656
- # Pass arguments to `delete_client_connector_service` via keyword arguments. Note that at
657
- # least one keyword argument is required. To specify no parameters, or to keep all
658
- # the default parameter values, pass an empty Hash as a request object (see above).
659
- #
660
- # @param name [::String]
661
- # Required. Name of the resource.
662
- # @param request_id [::String]
663
- # Optional. An optional request ID to identify requests. Specify a unique
664
- # request ID so that if you must retry your request, the server will know to
665
- # ignore the request if it has already been completed. The server will
666
- # guarantee that for at least 60 minutes after the first request.
667
- #
668
- # For example, consider a situation where you make an initial request and t
669
- # he request times out. If you make the request again with the same request
670
- # ID, the server can check if original operation with the same request ID
671
- # was received, and if so, will ignore the second request. This prevents
672
- # clients from accidentally creating duplicate commitments.
673
- #
674
- # The request ID must be a valid UUID with the exception that zero UUID is
675
- # not supported (00000000-0000-0000-0000-000000000000).
676
- # @param validate_only [::Boolean]
677
- # Optional. If set, validates request by executing a dry-run which would not
678
- # alter the resource in any way.
679
- #
680
- # @yield [response, operation] Access the result along with the RPC operation
681
- # @yieldparam response [::Gapic::Operation]
682
- # @yieldparam operation [::GRPC::ActiveCall::Operation]
683
- #
684
- # @return [::Gapic::Operation]
685
- #
686
- # @raise [::Google::Cloud::Error] if the RPC is aborted.
687
- #
688
- # @example Basic example
689
- # require "google/cloud/beyond_corp/client_connector_services/v1"
690
- #
691
- # # Create a client object. The client can be reused for multiple calls.
692
- # client = Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ClientConnectorServicesService::Client.new
693
- #
694
- # # Create a request. To set request fields, pass in keyword arguments.
695
- # request = Google::Cloud::BeyondCorp::ClientConnectorServices::V1::DeleteClientConnectorServiceRequest.new
696
- #
697
- # # Call the delete_client_connector_service method.
698
- # result = client.delete_client_connector_service request
699
- #
700
- # # The returned object is of type Gapic::Operation. You can use it to
701
- # # check the status of an operation, cancel it, or wait for results.
702
- # # Here is how to wait for a response.
703
- # result.wait_until_done! timeout: 60
704
- # if result.response?
705
- # p result.response
706
- # else
707
- # puts "No response received."
708
- # end
709
- #
710
- def delete_client_connector_service request, options = nil
711
- raise ::ArgumentError, "request must be provided" if request.nil?
712
-
713
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::DeleteClientConnectorServiceRequest
714
-
715
- # Converts hash and nil to an options object
716
- options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
717
-
718
- # Customize the options with defaults
719
- metadata = @config.rpcs.delete_client_connector_service.metadata.to_h
720
-
721
- # Set x-goog-api-client and x-goog-user-project headers
722
- metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
723
- lib_name: @config.lib_name, lib_version: @config.lib_version,
724
- gapic_version: ::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::VERSION
725
- metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
726
-
727
- header_params = {}
728
- if request.name
729
- header_params["name"] = request.name
730
- end
731
-
732
- request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
733
- metadata[:"x-goog-request-params"] ||= request_params_header
734
-
735
- options.apply_defaults timeout: @config.rpcs.delete_client_connector_service.timeout,
736
- metadata: metadata,
737
- retry_policy: @config.rpcs.delete_client_connector_service.retry_policy
738
-
739
- options.apply_defaults timeout: @config.timeout,
740
- metadata: @config.metadata,
741
- retry_policy: @config.retry_policy
742
-
743
- @client_connector_services_service_stub.call_rpc :delete_client_connector_service, request, options: options do |response, operation|
744
- response = ::Gapic::Operation.new response, @operations_client, options: options
745
- yield response, operation if block_given?
746
- return response
747
- end
748
- rescue ::GRPC::BadStatus => e
749
- raise ::Google::Cloud::Error.from_error(e)
750
- end
751
-
752
- ##
753
- # Configuration class for the ClientConnectorServicesService API.
754
- #
755
- # This class represents the configuration for ClientConnectorServicesService,
756
- # providing control over timeouts, retry behavior, logging, transport
757
- # parameters, and other low-level controls. Certain parameters can also be
758
- # applied individually to specific RPCs. See
759
- # {::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ClientConnectorServicesService::Client::Configuration::Rpcs}
760
- # for a list of RPCs that can be configured independently.
761
- #
762
- # Configuration can be applied globally to all clients, or to a single client
763
- # on construction.
764
- #
765
- # @example
766
- #
767
- # # Modify the global config, setting the timeout for
768
- # # list_client_connector_services to 20 seconds,
769
- # # and all remaining timeouts to 10 seconds.
770
- # ::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ClientConnectorServicesService::Client.configure do |config|
771
- # config.timeout = 10.0
772
- # config.rpcs.list_client_connector_services.timeout = 20.0
773
- # end
774
- #
775
- # # Apply the above configuration only to a new client.
776
- # client = ::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ClientConnectorServicesService::Client.new do |config|
777
- # config.timeout = 10.0
778
- # config.rpcs.list_client_connector_services.timeout = 20.0
779
- # end
780
- #
781
- # @!attribute [rw] endpoint
782
- # A custom service endpoint, as a hostname or hostname:port. The default is
783
- # nil, indicating to use the default endpoint in the current universe domain.
784
- # @return [::String,nil]
785
- # @!attribute [rw] credentials
786
- # Credentials to send with calls. You may provide any of the following types:
787
- # * (`String`) The path to a service account key file in JSON format
788
- # * (`Hash`) A service account key as a Hash
789
- # * (`Google::Auth::Credentials`) A googleauth credentials object
790
- # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
791
- # * (`Signet::OAuth2::Client`) A signet oauth2 client object
792
- # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
793
- # * (`GRPC::Core::Channel`) a gRPC channel with included credentials
794
- # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
795
- # * (`nil`) indicating no credentials
796
- # @return [::Object]
797
- # @!attribute [rw] scope
798
- # The OAuth scopes
799
- # @return [::Array<::String>]
800
- # @!attribute [rw] lib_name
801
- # The library name as recorded in instrumentation and logging
802
- # @return [::String]
803
- # @!attribute [rw] lib_version
804
- # The library version as recorded in instrumentation and logging
805
- # @return [::String]
806
- # @!attribute [rw] channel_args
807
- # Extra parameters passed to the gRPC channel. Note: this is ignored if a
808
- # `GRPC::Core::Channel` object is provided as the credential.
809
- # @return [::Hash]
810
- # @!attribute [rw] interceptors
811
- # An array of interceptors that are run before calls are executed.
812
- # @return [::Array<::GRPC::ClientInterceptor>]
813
- # @!attribute [rw] timeout
814
- # The call timeout in seconds.
815
- # @return [::Numeric]
816
- # @!attribute [rw] metadata
817
- # Additional gRPC headers to be sent with the call.
818
- # @return [::Hash{::Symbol=>::String}]
819
- # @!attribute [rw] retry_policy
820
- # The retry policy. The value is a hash with the following keys:
821
- # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
822
- # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
823
- # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
824
- # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
825
- # trigger a retry.
826
- # @return [::Hash]
827
- # @!attribute [rw] quota_project
828
- # A separate project against which to charge quota.
829
- # @return [::String]
830
- # @!attribute [rw] universe_domain
831
- # The universe domain within which to make requests. This determines the
832
- # default endpoint URL. The default value of nil uses the environment
833
- # universe (usually the default "googleapis.com" universe).
834
- # @return [::String,nil]
835
- #
836
- class Configuration
837
- extend ::Gapic::Config
838
-
839
- # @private
840
- # The endpoint specific to the default "googleapis.com" universe. Deprecated.
841
- DEFAULT_ENDPOINT = "beyondcorp.googleapis.com"
842
-
843
- config_attr :endpoint, nil, ::String, nil
844
- config_attr :credentials, nil do |value|
845
- allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
846
- allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
847
- allowed.any? { |klass| klass === value }
848
- end
849
- config_attr :scope, nil, ::String, ::Array, nil
850
- config_attr :lib_name, nil, ::String, nil
851
- config_attr :lib_version, nil, ::String, nil
852
- config_attr(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
853
- config_attr :interceptors, nil, ::Array, nil
854
- config_attr :timeout, nil, ::Numeric, nil
855
- config_attr :metadata, nil, ::Hash, nil
856
- config_attr :retry_policy, nil, ::Hash, ::Proc, nil
857
- config_attr :quota_project, nil, ::String, nil
858
- config_attr :universe_domain, nil, ::String, nil
859
-
860
- # @private
861
- def initialize parent_config = nil
862
- @parent_config = parent_config unless parent_config.nil?
863
-
864
- yield self if block_given?
865
- end
866
-
867
- ##
868
- # Configurations for individual RPCs
869
- # @return [Rpcs]
870
- #
871
- def rpcs
872
- @rpcs ||= begin
873
- parent_rpcs = nil
874
- parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
875
- Rpcs.new parent_rpcs
876
- end
877
- end
878
-
879
- ##
880
- # Configuration for the channel pool
881
- # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
882
- #
883
- def channel_pool
884
- @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
885
- end
886
-
887
- ##
888
- # Configuration RPC class for the ClientConnectorServicesService API.
889
- #
890
- # Includes fields providing the configuration for each RPC in this service.
891
- # Each configuration object is of type `Gapic::Config::Method` and includes
892
- # the following configuration fields:
893
- #
894
- # * `timeout` (*type:* `Numeric`) - The call timeout in seconds
895
- # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
896
- # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
897
- # include the following keys:
898
- # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
899
- # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
900
- # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
901
- # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
902
- # trigger a retry.
903
- #
904
- class Rpcs
905
- ##
906
- # RPC-specific configuration for `list_client_connector_services`
907
- # @return [::Gapic::Config::Method]
908
- #
909
- attr_reader :list_client_connector_services
910
- ##
911
- # RPC-specific configuration for `get_client_connector_service`
912
- # @return [::Gapic::Config::Method]
913
- #
914
- attr_reader :get_client_connector_service
915
- ##
916
- # RPC-specific configuration for `create_client_connector_service`
917
- # @return [::Gapic::Config::Method]
918
- #
919
- attr_reader :create_client_connector_service
920
- ##
921
- # RPC-specific configuration for `update_client_connector_service`
922
- # @return [::Gapic::Config::Method]
923
- #
924
- attr_reader :update_client_connector_service
925
- ##
926
- # RPC-specific configuration for `delete_client_connector_service`
927
- # @return [::Gapic::Config::Method]
928
- #
929
- attr_reader :delete_client_connector_service
930
-
931
- # @private
932
- def initialize parent_rpcs = nil
933
- list_client_connector_services_config = parent_rpcs.list_client_connector_services if parent_rpcs.respond_to? :list_client_connector_services
934
- @list_client_connector_services = ::Gapic::Config::Method.new list_client_connector_services_config
935
- get_client_connector_service_config = parent_rpcs.get_client_connector_service if parent_rpcs.respond_to? :get_client_connector_service
936
- @get_client_connector_service = ::Gapic::Config::Method.new get_client_connector_service_config
937
- create_client_connector_service_config = parent_rpcs.create_client_connector_service if parent_rpcs.respond_to? :create_client_connector_service
938
- @create_client_connector_service = ::Gapic::Config::Method.new create_client_connector_service_config
939
- update_client_connector_service_config = parent_rpcs.update_client_connector_service if parent_rpcs.respond_to? :update_client_connector_service
940
- @update_client_connector_service = ::Gapic::Config::Method.new update_client_connector_service_config
941
- delete_client_connector_service_config = parent_rpcs.delete_client_connector_service if parent_rpcs.respond_to? :delete_client_connector_service
942
- @delete_client_connector_service = ::Gapic::Config::Method.new delete_client_connector_service_config
943
-
944
- yield self if block_given?
945
- end
946
- end
947
- end
948
- end
949
- end
950
- end
951
- end
952
- end
953
- end
954
- end