google-cloud-vpc_access-v1 0.1.0 → 0.1.4
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.yardopts +1 -1
- data/AUTHENTICATION.md +15 -33
- data/README.md +1 -1
- data/lib/google/cloud/vpc_access/v1/version.rb +1 -1
- data/lib/google/cloud/vpc_access/v1/vpc_access_service/client.rb +144 -57
- data/lib/google/cloud/vpc_access/v1/vpc_access_service/operations.rb +146 -34
- data/lib/google/cloud/vpcaccess/v1/vpc_access_pb.rb +2 -2
- data/lib/google/cloud/vpcaccess/v1/vpc_access_services_pb.rb +1 -1
- data/proto_docs/google/api/field_behavior.rb +6 -0
- data/proto_docs/google/api/resource.rb +10 -71
- metadata +5 -5
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: daad5e2104e8957391501546218e864faa6d817d7aa3caba3485f933d1a35cfd
|
4
|
+
data.tar.gz: b5a5e756f62dc52ff570e115d856fb2ba76f77d56695347c08d02770fcaa23a3
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: c3f4c1987a410d91f2ebea664b52ad0e2f0d2251a1172ca8214a9e62c0e68af99c829610a3d046dcb0f16a4696445eb1af206c7b2ba69d3e36d2e34690ee39c3
|
7
|
+
data.tar.gz: 626a76ff0d849222cb07f2b7ed685847e4bdcf3730c885eb68993a1a28996311a17c6cf3c35970ea463f4f523257fb5594b99e665a46e47fc2488eb108c15d21
|
data/.yardopts
CHANGED
data/AUTHENTICATION.md
CHANGED
@@ -66,11 +66,11 @@ The environment variables that google-cloud-vpc_access-v1
|
|
66
66
|
checks for credentials are configured on the service Credentials class (such as
|
67
67
|
{::Google::Cloud::VpcAccess::V1::VpcAccessService::Credentials}):
|
68
68
|
|
69
|
-
|
70
|
-
|
71
|
-
|
72
|
-
|
73
|
-
|
69
|
+
* `VPC_ACCESS_CREDENTIALS` - Path to JSON file, or JSON contents
|
70
|
+
* `VPC_ACCESS_KEYFILE` - Path to JSON file, or JSON contents
|
71
|
+
* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
|
72
|
+
* `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
|
73
|
+
* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
|
74
74
|
|
75
75
|
```ruby
|
76
76
|
require "google/cloud/vpc_access/v1"
|
@@ -82,8 +82,8 @@ client = ::Google::Cloud::VpcAccess::V1::VpcAccessService::Client.new
|
|
82
82
|
|
83
83
|
### Configuration
|
84
84
|
|
85
|
-
The **Credentials JSON** can be configured instead of
|
86
|
-
environment
|
85
|
+
The path to the **Credentials JSON** file can be configured instead of storing
|
86
|
+
it in an environment variable. Either on an individual client initialization:
|
87
87
|
|
88
88
|
```ruby
|
89
89
|
require "google/cloud/vpc_access/v1"
|
@@ -93,7 +93,7 @@ client = ::Google::Cloud::VpcAccess::V1::VpcAccessService::Client.new do |config
|
|
93
93
|
end
|
94
94
|
```
|
95
95
|
|
96
|
-
Or
|
96
|
+
Or globally for all clients:
|
97
97
|
|
98
98
|
```ruby
|
99
99
|
require "google/cloud/vpc_access/v1"
|
@@ -120,15 +120,6 @@ To configure your system for this, simply:
|
|
120
120
|
**NOTE:** This is _not_ recommended for running in production. The Cloud SDK
|
121
121
|
*should* only be used during development.
|
122
122
|
|
123
|
-
[gce-how-to]: https://cloud.google.com/compute/docs/authentication#using
|
124
|
-
[dev-console]: https://console.cloud.google.com/project
|
125
|
-
|
126
|
-
[enable-apis]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/enable-apis.png
|
127
|
-
|
128
|
-
[create-new-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account.png
|
129
|
-
[create-new-service-account-existing-keys]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account-existing-keys.png
|
130
|
-
[reuse-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/reuse-service-account.png
|
131
|
-
|
132
123
|
## Creating a Service Account
|
133
124
|
|
134
125
|
Google Cloud requires **Service Account Credentials** to
|
@@ -139,31 +130,22 @@ If you are not running this client within
|
|
139
130
|
[Google Cloud Platform environments](#google-cloud-platform-environments), you
|
140
131
|
need a Google Developers service account.
|
141
132
|
|
142
|
-
1. Visit the [Google
|
133
|
+
1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
|
143
134
|
2. Create a new project or click on an existing project.
|
144
|
-
3. Activate the
|
135
|
+
3. Activate the menu in the upper left and select **APIs & Services**. From
|
145
136
|
here, you will enable the APIs that your application requires.
|
146
137
|
|
147
|
-
![Enable the APIs that your application requires][enable-apis]
|
148
|
-
|
149
138
|
*Note: You may need to enable billing in order to use these services.*
|
150
139
|
|
151
140
|
4. Select **Credentials** from the side navigation.
|
152
141
|
|
153
|
-
|
154
|
-
|
155
|
-
![Create a new service account][create-new-service-account]
|
156
|
-
|
157
|
-
![Create a new service account With Existing Keys][create-new-service-account-existing-keys]
|
158
|
-
|
159
|
-
Find the "Add credentials" drop down and select "Service account" to be
|
160
|
-
guided through downloading a new JSON key file.
|
142
|
+
Find the "Create credentials" drop down near the top of the page, and select
|
143
|
+
"Service account" to be guided through downloading a new JSON key file.
|
161
144
|
|
162
145
|
If you want to re-use an existing service account, you can easily generate a
|
163
|
-
new key file. Just select the account you wish to re-use,
|
164
|
-
|
165
|
-
|
166
|
-
![Re-use an existing service account][reuse-service-account]
|
146
|
+
new key file. Just select the account you wish to re-use, click the pencil
|
147
|
+
tool on the right side to edit the service account, select the **Keys** tab,
|
148
|
+
and then select **Add Key**.
|
167
149
|
|
168
150
|
The key file you download will be used by this library to authenticate API
|
169
151
|
requests and should be stored in a secure location.
|
data/README.md
CHANGED
@@ -33,7 +33,7 @@ In order to use this library, you first need to go through the following steps:
|
|
33
33
|
require "google/cloud/vpc_access/v1"
|
34
34
|
|
35
35
|
client = ::Google::Cloud::VpcAccess::V1::VpcAccessService::Client.new
|
36
|
-
request =
|
36
|
+
request = ::Google::Cloud::VpcAccess::V1::CreateConnectorRequest.new # (request fields as keyword arguments...)
|
37
37
|
response = client.create_connector request
|
38
38
|
```
|
39
39
|
|
@@ -43,13 +43,12 @@ module Google
|
|
43
43
|
# See {::Google::Cloud::VpcAccess::V1::VpcAccessService::Client::Configuration}
|
44
44
|
# for a description of the configuration fields.
|
45
45
|
#
|
46
|
-
#
|
46
|
+
# @example
|
47
47
|
#
|
48
|
-
#
|
49
|
-
#
|
50
|
-
#
|
51
|
-
#
|
52
|
-
# end
|
48
|
+
# # Modify the configuration for all VpcAccessService clients
|
49
|
+
# ::Google::Cloud::VpcAccess::V1::VpcAccessService::Client.configure do |config|
|
50
|
+
# config.timeout = 10.0
|
51
|
+
# end
|
53
52
|
#
|
54
53
|
# @yield [config] Configure the Client client.
|
55
54
|
# @yieldparam config [Client::Configuration]
|
@@ -69,10 +68,7 @@ module Google
|
|
69
68
|
|
70
69
|
default_config.timeout = 60.0
|
71
70
|
default_config.retry_policy = {
|
72
|
-
initial_delay: 1.0,
|
73
|
-
max_delay: 60.0,
|
74
|
-
multiplier: 1.3,
|
75
|
-
retry_codes: [14, 2]
|
71
|
+
initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 2]
|
76
72
|
}
|
77
73
|
|
78
74
|
default_config.rpcs.create_connector.timeout = 60.0
|
@@ -112,19 +108,15 @@ module Google
|
|
112
108
|
##
|
113
109
|
# Create a new VpcAccessService client object.
|
114
110
|
#
|
115
|
-
#
|
116
|
-
#
|
117
|
-
# To create a new VpcAccessService client with the default
|
118
|
-
# configuration:
|
119
|
-
#
|
120
|
-
# client = ::Google::Cloud::VpcAccess::V1::VpcAccessService::Client.new
|
111
|
+
# @example
|
121
112
|
#
|
122
|
-
#
|
123
|
-
#
|
113
|
+
# # Create a client using the default configuration
|
114
|
+
# client = ::Google::Cloud::VpcAccess::V1::VpcAccessService::Client.new
|
124
115
|
#
|
125
|
-
#
|
126
|
-
#
|
127
|
-
#
|
116
|
+
# # Create a client using a custom configuration
|
117
|
+
# client = ::Google::Cloud::VpcAccess::V1::VpcAccessService::Client.new do |config|
|
118
|
+
# config.timeout = 10.0
|
119
|
+
# end
|
128
120
|
#
|
129
121
|
# @yield [config] Configure the VpcAccessService client.
|
130
122
|
# @yieldparam config [Client::Configuration]
|
@@ -144,14 +136,13 @@ module Google
|
|
144
136
|
|
145
137
|
# Create credentials
|
146
138
|
credentials = @config.credentials
|
147
|
-
# Use self-signed JWT if the
|
139
|
+
# Use self-signed JWT if the endpoint is unchanged from default,
|
148
140
|
# but only if the default endpoint does not have a region prefix.
|
149
|
-
enable_self_signed_jwt = @config.
|
150
|
-
@config.endpoint == Client.configure.endpoint &&
|
141
|
+
enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
|
151
142
|
!@config.endpoint.split(".").first.include?("-")
|
152
143
|
credentials ||= Credentials.default scope: @config.scope,
|
153
144
|
enable_self_signed_jwt: enable_self_signed_jwt
|
154
|
-
if credentials.is_a?(String) || credentials.is_a?(Hash)
|
145
|
+
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
155
146
|
credentials = Credentials.new credentials, scope: @config.scope
|
156
147
|
end
|
157
148
|
@quota_project_id = @config.quota_project
|
@@ -159,6 +150,7 @@ module Google
|
|
159
150
|
|
160
151
|
@operations_client = Operations.new do |config|
|
161
152
|
config.credentials = credentials
|
153
|
+
config.quota_project = @quota_project_id
|
162
154
|
config.endpoint = @config.endpoint
|
163
155
|
end
|
164
156
|
|
@@ -214,6 +206,28 @@ module Google
|
|
214
206
|
#
|
215
207
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
216
208
|
#
|
209
|
+
# @example Basic example
|
210
|
+
# require "google/cloud/vpc_access/v1"
|
211
|
+
#
|
212
|
+
# # Create a client object. The client can be reused for multiple calls.
|
213
|
+
# client = Google::Cloud::VpcAccess::V1::VpcAccessService::Client.new
|
214
|
+
#
|
215
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
216
|
+
# request = Google::Cloud::VpcAccess::V1::CreateConnectorRequest.new
|
217
|
+
#
|
218
|
+
# # Call the create_connector method.
|
219
|
+
# result = client.create_connector request
|
220
|
+
#
|
221
|
+
# # The returned object is of type Gapic::Operation. You can use this
|
222
|
+
# # object to check the status of an operation, cancel it, or wait
|
223
|
+
# # for results. Here is how to block until completion:
|
224
|
+
# result.wait_until_done! timeout: 60
|
225
|
+
# if result.response?
|
226
|
+
# p result.response
|
227
|
+
# else
|
228
|
+
# puts "Error!"
|
229
|
+
# end
|
230
|
+
#
|
217
231
|
def create_connector request, options = nil
|
218
232
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
219
233
|
|
@@ -231,16 +245,20 @@ module Google
|
|
231
245
|
gapic_version: ::Google::Cloud::VpcAccess::V1::VERSION
|
232
246
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
233
247
|
|
234
|
-
header_params = {
|
235
|
-
|
236
|
-
|
248
|
+
header_params = {}
|
249
|
+
if request.parent
|
250
|
+
header_params["parent"] = request.parent
|
251
|
+
end
|
252
|
+
|
237
253
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
238
254
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
239
255
|
|
240
256
|
options.apply_defaults timeout: @config.rpcs.create_connector.timeout,
|
241
257
|
metadata: metadata,
|
242
258
|
retry_policy: @config.rpcs.create_connector.retry_policy
|
243
|
-
|
259
|
+
|
260
|
+
options.apply_defaults timeout: @config.timeout,
|
261
|
+
metadata: @config.metadata,
|
244
262
|
retry_policy: @config.retry_policy
|
245
263
|
|
246
264
|
@vpc_access_service_stub.call_rpc :create_connector, request, options: options do |response, operation|
|
@@ -282,6 +300,21 @@ module Google
|
|
282
300
|
#
|
283
301
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
284
302
|
#
|
303
|
+
# @example Basic example
|
304
|
+
# require "google/cloud/vpc_access/v1"
|
305
|
+
#
|
306
|
+
# # Create a client object. The client can be reused for multiple calls.
|
307
|
+
# client = Google::Cloud::VpcAccess::V1::VpcAccessService::Client.new
|
308
|
+
#
|
309
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
310
|
+
# request = Google::Cloud::VpcAccess::V1::GetConnectorRequest.new
|
311
|
+
#
|
312
|
+
# # Call the get_connector method.
|
313
|
+
# result = client.get_connector request
|
314
|
+
#
|
315
|
+
# # The returned object is of type Google::Cloud::VpcAccess::V1::Connector.
|
316
|
+
# p result
|
317
|
+
#
|
285
318
|
def get_connector request, options = nil
|
286
319
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
287
320
|
|
@@ -299,16 +332,20 @@ module Google
|
|
299
332
|
gapic_version: ::Google::Cloud::VpcAccess::V1::VERSION
|
300
333
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
301
334
|
|
302
|
-
header_params = {
|
303
|
-
|
304
|
-
|
335
|
+
header_params = {}
|
336
|
+
if request.name
|
337
|
+
header_params["name"] = request.name
|
338
|
+
end
|
339
|
+
|
305
340
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
306
341
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
307
342
|
|
308
343
|
options.apply_defaults timeout: @config.rpcs.get_connector.timeout,
|
309
344
|
metadata: metadata,
|
310
345
|
retry_policy: @config.rpcs.get_connector.retry_policy
|
311
|
-
|
346
|
+
|
347
|
+
options.apply_defaults timeout: @config.timeout,
|
348
|
+
metadata: @config.metadata,
|
312
349
|
retry_policy: @config.retry_policy
|
313
350
|
|
314
351
|
@vpc_access_service_stub.call_rpc :get_connector, request, options: options do |response, operation|
|
@@ -352,6 +389,27 @@ module Google
|
|
352
389
|
#
|
353
390
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
354
391
|
#
|
392
|
+
# @example Basic example
|
393
|
+
# require "google/cloud/vpc_access/v1"
|
394
|
+
#
|
395
|
+
# # Create a client object. The client can be reused for multiple calls.
|
396
|
+
# client = Google::Cloud::VpcAccess::V1::VpcAccessService::Client.new
|
397
|
+
#
|
398
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
399
|
+
# request = Google::Cloud::VpcAccess::V1::ListConnectorsRequest.new
|
400
|
+
#
|
401
|
+
# # Call the list_connectors method.
|
402
|
+
# result = client.list_connectors request
|
403
|
+
#
|
404
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can
|
405
|
+
# # iterate over all elements by calling #each, and the enumerable
|
406
|
+
# # will lazily make API calls to fetch subsequent pages. Other
|
407
|
+
# # methods are also available for managing paging directly.
|
408
|
+
# result.each do |response|
|
409
|
+
# # Each element is of type ::Google::Cloud::VpcAccess::V1::Connector.
|
410
|
+
# p response
|
411
|
+
# end
|
412
|
+
#
|
355
413
|
def list_connectors request, options = nil
|
356
414
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
357
415
|
|
@@ -369,16 +427,20 @@ module Google
|
|
369
427
|
gapic_version: ::Google::Cloud::VpcAccess::V1::VERSION
|
370
428
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
371
429
|
|
372
|
-
header_params = {
|
373
|
-
|
374
|
-
|
430
|
+
header_params = {}
|
431
|
+
if request.parent
|
432
|
+
header_params["parent"] = request.parent
|
433
|
+
end
|
434
|
+
|
375
435
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
376
436
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
377
437
|
|
378
438
|
options.apply_defaults timeout: @config.rpcs.list_connectors.timeout,
|
379
439
|
metadata: metadata,
|
380
440
|
retry_policy: @config.rpcs.list_connectors.retry_policy
|
381
|
-
|
441
|
+
|
442
|
+
options.apply_defaults timeout: @config.timeout,
|
443
|
+
metadata: @config.metadata,
|
382
444
|
retry_policy: @config.retry_policy
|
383
445
|
|
384
446
|
@vpc_access_service_stub.call_rpc :list_connectors, request, options: options do |response, operation|
|
@@ -420,6 +482,28 @@ module Google
|
|
420
482
|
#
|
421
483
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
422
484
|
#
|
485
|
+
# @example Basic example
|
486
|
+
# require "google/cloud/vpc_access/v1"
|
487
|
+
#
|
488
|
+
# # Create a client object. The client can be reused for multiple calls.
|
489
|
+
# client = Google::Cloud::VpcAccess::V1::VpcAccessService::Client.new
|
490
|
+
#
|
491
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
492
|
+
# request = Google::Cloud::VpcAccess::V1::DeleteConnectorRequest.new
|
493
|
+
#
|
494
|
+
# # Call the delete_connector method.
|
495
|
+
# result = client.delete_connector request
|
496
|
+
#
|
497
|
+
# # The returned object is of type Gapic::Operation. You can use this
|
498
|
+
# # object to check the status of an operation, cancel it, or wait
|
499
|
+
# # for results. Here is how to block until completion:
|
500
|
+
# result.wait_until_done! timeout: 60
|
501
|
+
# if result.response?
|
502
|
+
# p result.response
|
503
|
+
# else
|
504
|
+
# puts "Error!"
|
505
|
+
# end
|
506
|
+
#
|
423
507
|
def delete_connector request, options = nil
|
424
508
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
425
509
|
|
@@ -437,16 +521,20 @@ module Google
|
|
437
521
|
gapic_version: ::Google::Cloud::VpcAccess::V1::VERSION
|
438
522
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
439
523
|
|
440
|
-
header_params = {
|
441
|
-
|
442
|
-
|
524
|
+
header_params = {}
|
525
|
+
if request.name
|
526
|
+
header_params["name"] = request.name
|
527
|
+
end
|
528
|
+
|
443
529
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
444
530
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
445
531
|
|
446
532
|
options.apply_defaults timeout: @config.rpcs.delete_connector.timeout,
|
447
533
|
metadata: metadata,
|
448
534
|
retry_policy: @config.rpcs.delete_connector.retry_policy
|
449
|
-
|
535
|
+
|
536
|
+
options.apply_defaults timeout: @config.timeout,
|
537
|
+
metadata: @config.metadata,
|
450
538
|
retry_policy: @config.retry_policy
|
451
539
|
|
452
540
|
@vpc_access_service_stub.call_rpc :delete_connector, request, options: options do |response, operation|
|
@@ -471,22 +559,21 @@ module Google
|
|
471
559
|
# Configuration can be applied globally to all clients, or to a single client
|
472
560
|
# on construction.
|
473
561
|
#
|
474
|
-
#
|
475
|
-
#
|
476
|
-
#
|
477
|
-
# to 20 seconds,
|
478
|
-
#
|
479
|
-
#
|
480
|
-
#
|
481
|
-
#
|
482
|
-
#
|
483
|
-
#
|
484
|
-
#
|
485
|
-
#
|
486
|
-
#
|
487
|
-
#
|
488
|
-
#
|
489
|
-
# end
|
562
|
+
# @example
|
563
|
+
#
|
564
|
+
# # Modify the global config, setting the timeout for
|
565
|
+
# # create_connector to 20 seconds,
|
566
|
+
# # and all remaining timeouts to 10 seconds.
|
567
|
+
# ::Google::Cloud::VpcAccess::V1::VpcAccessService::Client.configure do |config|
|
568
|
+
# config.timeout = 10.0
|
569
|
+
# config.rpcs.create_connector.timeout = 20.0
|
570
|
+
# end
|
571
|
+
#
|
572
|
+
# # Apply the above configuration only to a new client.
|
573
|
+
# client = ::Google::Cloud::VpcAccess::V1::VpcAccessService::Client.new do |config|
|
574
|
+
# config.timeout = 10.0
|
575
|
+
# config.rpcs.create_connector.timeout = 20.0
|
576
|
+
# end
|
490
577
|
#
|
491
578
|
# @!attribute [rw] endpoint
|
492
579
|
# The hostname or hostname:port of the service endpoint.
|
@@ -82,7 +82,7 @@ module Google
|
|
82
82
|
# Create credentials
|
83
83
|
credentials = @config.credentials
|
84
84
|
credentials ||= Credentials.default scope: @config.scope
|
85
|
-
if credentials.is_a?(String) || credentials.is_a?(Hash)
|
85
|
+
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
86
86
|
credentials = Credentials.new credentials, scope: @config.scope
|
87
87
|
end
|
88
88
|
@quota_project_id = @config.quota_project
|
@@ -143,6 +143,27 @@ module Google
|
|
143
143
|
#
|
144
144
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
145
145
|
#
|
146
|
+
# @example Basic example
|
147
|
+
# require "google/longrunning"
|
148
|
+
#
|
149
|
+
# # Create a client object. The client can be reused for multiple calls.
|
150
|
+
# client = Google::Longrunning::Operations::Client.new
|
151
|
+
#
|
152
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
153
|
+
# request = Google::Longrunning::ListOperationsRequest.new
|
154
|
+
#
|
155
|
+
# # Call the list_operations method.
|
156
|
+
# result = client.list_operations request
|
157
|
+
#
|
158
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can
|
159
|
+
# # iterate over all elements by calling #each, and the enumerable
|
160
|
+
# # will lazily make API calls to fetch subsequent pages. Other
|
161
|
+
# # methods are also available for managing paging directly.
|
162
|
+
# result.each do |response|
|
163
|
+
# # Each element is of type ::Google::Longrunning::Operation.
|
164
|
+
# p response
|
165
|
+
# end
|
166
|
+
#
|
146
167
|
def list_operations request, options = nil
|
147
168
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
148
169
|
|
@@ -160,16 +181,20 @@ module Google
|
|
160
181
|
gapic_version: ::Google::Cloud::VpcAccess::V1::VERSION
|
161
182
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
162
183
|
|
163
|
-
header_params = {
|
164
|
-
|
165
|
-
|
184
|
+
header_params = {}
|
185
|
+
if request.name
|
186
|
+
header_params["name"] = request.name
|
187
|
+
end
|
188
|
+
|
166
189
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
167
190
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
168
191
|
|
169
192
|
options.apply_defaults timeout: @config.rpcs.list_operations.timeout,
|
170
193
|
metadata: metadata,
|
171
194
|
retry_policy: @config.rpcs.list_operations.retry_policy
|
172
|
-
|
195
|
+
|
196
|
+
options.apply_defaults timeout: @config.timeout,
|
197
|
+
metadata: @config.metadata,
|
173
198
|
retry_policy: @config.retry_policy
|
174
199
|
|
175
200
|
@operations_stub.call_rpc :list_operations, request, options: options do |response, operation|
|
@@ -213,6 +238,28 @@ module Google
|
|
213
238
|
#
|
214
239
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
215
240
|
#
|
241
|
+
# @example Basic example
|
242
|
+
# require "google/longrunning"
|
243
|
+
#
|
244
|
+
# # Create a client object. The client can be reused for multiple calls.
|
245
|
+
# client = Google::Longrunning::Operations::Client.new
|
246
|
+
#
|
247
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
248
|
+
# request = Google::Longrunning::GetOperationRequest.new
|
249
|
+
#
|
250
|
+
# # Call the get_operation method.
|
251
|
+
# result = client.get_operation request
|
252
|
+
#
|
253
|
+
# # The returned object is of type Gapic::Operation. You can use this
|
254
|
+
# # object to check the status of an operation, cancel it, or wait
|
255
|
+
# # for results. Here is how to block until completion:
|
256
|
+
# result.wait_until_done! timeout: 60
|
257
|
+
# if result.response?
|
258
|
+
# p result.response
|
259
|
+
# else
|
260
|
+
# puts "Error!"
|
261
|
+
# end
|
262
|
+
#
|
216
263
|
def get_operation request, options = nil
|
217
264
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
218
265
|
|
@@ -230,16 +277,20 @@ module Google
|
|
230
277
|
gapic_version: ::Google::Cloud::VpcAccess::V1::VERSION
|
231
278
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
232
279
|
|
233
|
-
header_params = {
|
234
|
-
|
235
|
-
|
280
|
+
header_params = {}
|
281
|
+
if request.name
|
282
|
+
header_params["name"] = request.name
|
283
|
+
end
|
284
|
+
|
236
285
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
237
286
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
238
287
|
|
239
288
|
options.apply_defaults timeout: @config.rpcs.get_operation.timeout,
|
240
289
|
metadata: metadata,
|
241
290
|
retry_policy: @config.rpcs.get_operation.retry_policy
|
242
|
-
|
291
|
+
|
292
|
+
options.apply_defaults timeout: @config.timeout,
|
293
|
+
metadata: @config.metadata,
|
243
294
|
retry_policy: @config.retry_policy
|
244
295
|
|
245
296
|
@operations_stub.call_rpc :get_operation, request, options: options do |response, operation|
|
@@ -283,6 +334,21 @@ module Google
|
|
283
334
|
#
|
284
335
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
285
336
|
#
|
337
|
+
# @example Basic example
|
338
|
+
# require "google/longrunning"
|
339
|
+
#
|
340
|
+
# # Create a client object. The client can be reused for multiple calls.
|
341
|
+
# client = Google::Longrunning::Operations::Client.new
|
342
|
+
#
|
343
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
344
|
+
# request = Google::Longrunning::DeleteOperationRequest.new
|
345
|
+
#
|
346
|
+
# # Call the delete_operation method.
|
347
|
+
# result = client.delete_operation request
|
348
|
+
#
|
349
|
+
# # The returned object is of type Google::Protobuf::Empty.
|
350
|
+
# p result
|
351
|
+
#
|
286
352
|
def delete_operation request, options = nil
|
287
353
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
288
354
|
|
@@ -300,16 +366,20 @@ module Google
|
|
300
366
|
gapic_version: ::Google::Cloud::VpcAccess::V1::VERSION
|
301
367
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
302
368
|
|
303
|
-
header_params = {
|
304
|
-
|
305
|
-
|
369
|
+
header_params = {}
|
370
|
+
if request.name
|
371
|
+
header_params["name"] = request.name
|
372
|
+
end
|
373
|
+
|
306
374
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
307
375
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
308
376
|
|
309
377
|
options.apply_defaults timeout: @config.rpcs.delete_operation.timeout,
|
310
378
|
metadata: metadata,
|
311
379
|
retry_policy: @config.rpcs.delete_operation.retry_policy
|
312
|
-
|
380
|
+
|
381
|
+
options.apply_defaults timeout: @config.timeout,
|
382
|
+
metadata: @config.metadata,
|
313
383
|
retry_policy: @config.retry_policy
|
314
384
|
|
315
385
|
@operations_stub.call_rpc :delete_operation, request, options: options do |response, operation|
|
@@ -358,6 +428,21 @@ module Google
|
|
358
428
|
#
|
359
429
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
360
430
|
#
|
431
|
+
# @example Basic example
|
432
|
+
# require "google/longrunning"
|
433
|
+
#
|
434
|
+
# # Create a client object. The client can be reused for multiple calls.
|
435
|
+
# client = Google::Longrunning::Operations::Client.new
|
436
|
+
#
|
437
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
438
|
+
# request = Google::Longrunning::CancelOperationRequest.new
|
439
|
+
#
|
440
|
+
# # Call the cancel_operation method.
|
441
|
+
# result = client.cancel_operation request
|
442
|
+
#
|
443
|
+
# # The returned object is of type Google::Protobuf::Empty.
|
444
|
+
# p result
|
445
|
+
#
|
361
446
|
def cancel_operation request, options = nil
|
362
447
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
363
448
|
|
@@ -375,16 +460,20 @@ module Google
|
|
375
460
|
gapic_version: ::Google::Cloud::VpcAccess::V1::VERSION
|
376
461
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
377
462
|
|
378
|
-
header_params = {
|
379
|
-
|
380
|
-
|
463
|
+
header_params = {}
|
464
|
+
if request.name
|
465
|
+
header_params["name"] = request.name
|
466
|
+
end
|
467
|
+
|
381
468
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
382
469
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
383
470
|
|
384
471
|
options.apply_defaults timeout: @config.rpcs.cancel_operation.timeout,
|
385
472
|
metadata: metadata,
|
386
473
|
retry_policy: @config.rpcs.cancel_operation.retry_policy
|
387
|
-
|
474
|
+
|
475
|
+
options.apply_defaults timeout: @config.timeout,
|
476
|
+
metadata: @config.metadata,
|
388
477
|
retry_policy: @config.retry_policy
|
389
478
|
|
390
479
|
@operations_stub.call_rpc :cancel_operation, request, options: options do |response, operation|
|
@@ -436,6 +525,28 @@ module Google
|
|
436
525
|
#
|
437
526
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
438
527
|
#
|
528
|
+
# @example Basic example
|
529
|
+
# require "google/longrunning"
|
530
|
+
#
|
531
|
+
# # Create a client object. The client can be reused for multiple calls.
|
532
|
+
# client = Google::Longrunning::Operations::Client.new
|
533
|
+
#
|
534
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
535
|
+
# request = Google::Longrunning::WaitOperationRequest.new
|
536
|
+
#
|
537
|
+
# # Call the wait_operation method.
|
538
|
+
# result = client.wait_operation request
|
539
|
+
#
|
540
|
+
# # The returned object is of type Gapic::Operation. You can use this
|
541
|
+
# # object to check the status of an operation, cancel it, or wait
|
542
|
+
# # for results. Here is how to block until completion:
|
543
|
+
# result.wait_until_done! timeout: 60
|
544
|
+
# if result.response?
|
545
|
+
# p result.response
|
546
|
+
# else
|
547
|
+
# puts "Error!"
|
548
|
+
# end
|
549
|
+
#
|
439
550
|
def wait_operation request, options = nil
|
440
551
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
441
552
|
|
@@ -456,7 +567,9 @@ module Google
|
|
456
567
|
options.apply_defaults timeout: @config.rpcs.wait_operation.timeout,
|
457
568
|
metadata: metadata,
|
458
569
|
retry_policy: @config.rpcs.wait_operation.retry_policy
|
459
|
-
|
570
|
+
|
571
|
+
options.apply_defaults timeout: @config.timeout,
|
572
|
+
metadata: @config.metadata,
|
460
573
|
retry_policy: @config.retry_policy
|
461
574
|
|
462
575
|
@operations_stub.call_rpc :wait_operation, request, options: options do |response, operation|
|
@@ -481,22 +594,21 @@ module Google
|
|
481
594
|
# Configuration can be applied globally to all clients, or to a single client
|
482
595
|
# on construction.
|
483
596
|
#
|
484
|
-
#
|
485
|
-
#
|
486
|
-
#
|
487
|
-
# to 20 seconds,
|
488
|
-
#
|
489
|
-
#
|
490
|
-
#
|
491
|
-
#
|
492
|
-
#
|
493
|
-
#
|
494
|
-
#
|
495
|
-
#
|
496
|
-
#
|
497
|
-
#
|
498
|
-
#
|
499
|
-
# end
|
597
|
+
# @example
|
598
|
+
#
|
599
|
+
# # Modify the global config, setting the timeout for
|
600
|
+
# # list_operations to 20 seconds,
|
601
|
+
# # and all remaining timeouts to 10 seconds.
|
602
|
+
# ::Google::Longrunning::Operations::Client.configure do |config|
|
603
|
+
# config.timeout = 10.0
|
604
|
+
# config.rpcs.list_operations.timeout = 20.0
|
605
|
+
# end
|
606
|
+
#
|
607
|
+
# # Apply the above configuration only to a new client.
|
608
|
+
# client = ::Google::Longrunning::Operations::Client.new do |config|
|
609
|
+
# config.timeout = 10.0
|
610
|
+
# config.rpcs.list_operations.timeout = 20.0
|
611
|
+
# end
|
500
612
|
#
|
501
613
|
# @!attribute [rw] endpoint
|
502
614
|
# The hostname or hostname:port of the service endpoint.
|
@@ -1,14 +1,14 @@
|
|
1
1
|
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
2
|
# source: google/cloud/vpcaccess/v1/vpc_access.proto
|
3
3
|
|
4
|
-
require 'google/protobuf'
|
5
|
-
|
6
4
|
require 'google/api/annotations_pb'
|
7
5
|
require 'google/api/client_pb'
|
8
6
|
require 'google/api/field_behavior_pb'
|
9
7
|
require 'google/api/resource_pb'
|
10
8
|
require 'google/longrunning/operations_pb'
|
11
9
|
require 'google/protobuf/timestamp_pb'
|
10
|
+
require 'google/protobuf'
|
11
|
+
|
12
12
|
Google::Protobuf::DescriptorPool.generated_pool.build do
|
13
13
|
add_file("google/cloud/vpcaccess/v1/vpc_access.proto", :syntax => :proto3) do
|
14
14
|
add_message "google.cloud.vpcaccess.v1.Connector" do
|
@@ -60,6 +60,12 @@ module Google
|
|
60
60
|
# in any arbitrary order, rather than the order the user originally
|
61
61
|
# provided. Additionally, the list's order may or may not be stable.
|
62
62
|
UNORDERED_LIST = 6
|
63
|
+
|
64
|
+
# Denotes that this field returns a non-empty default value if not set.
|
65
|
+
# This indicates that if the user provides the empty value in a request,
|
66
|
+
# a non-empty value will be returned. The user will not be aware of what
|
67
|
+
# non-empty value to expect.
|
68
|
+
NON_EMPTY_DEFAULT = 7
|
63
69
|
end
|
64
70
|
end
|
65
71
|
end
|
@@ -33,11 +33,7 @@ module Google
|
|
33
33
|
# // For Kubernetes resources, the format is {api group}/{kind}.
|
34
34
|
# option (google.api.resource) = {
|
35
35
|
# type: "pubsub.googleapis.com/Topic"
|
36
|
-
#
|
37
|
-
# pattern: "projects/{project}/topics/{topic}"
|
38
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
39
|
-
# parent_name_extractor: "projects/{project}"
|
40
|
-
# }
|
36
|
+
# pattern: "projects/{project}/topics/{topic}"
|
41
37
|
# };
|
42
38
|
# }
|
43
39
|
#
|
@@ -45,10 +41,7 @@ module Google
|
|
45
41
|
#
|
46
42
|
# resources:
|
47
43
|
# - type: "pubsub.googleapis.com/Topic"
|
48
|
-
#
|
49
|
-
# - pattern: "projects/{project}/topics/{topic}"
|
50
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
51
|
-
# parent_name_extractor: "projects/{project}"
|
44
|
+
# pattern: "projects/{project}/topics/{topic}"
|
52
45
|
#
|
53
46
|
# Sometimes, resources have multiple patterns, typically because they can
|
54
47
|
# live under multiple parents.
|
@@ -58,26 +51,10 @@ module Google
|
|
58
51
|
# message LogEntry {
|
59
52
|
# option (google.api.resource) = {
|
60
53
|
# type: "logging.googleapis.com/LogEntry"
|
61
|
-
#
|
62
|
-
#
|
63
|
-
#
|
64
|
-
#
|
65
|
-
# }
|
66
|
-
# name_descriptor: {
|
67
|
-
# pattern: "folders/{folder}/logs/{log}"
|
68
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Folder"
|
69
|
-
# parent_name_extractor: "folders/{folder}"
|
70
|
-
# }
|
71
|
-
# name_descriptor: {
|
72
|
-
# pattern: "organizations/{organization}/logs/{log}"
|
73
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Organization"
|
74
|
-
# parent_name_extractor: "organizations/{organization}"
|
75
|
-
# }
|
76
|
-
# name_descriptor: {
|
77
|
-
# pattern: "billingAccounts/{billing_account}/logs/{log}"
|
78
|
-
# parent_type: "billing.googleapis.com/BillingAccount"
|
79
|
-
# parent_name_extractor: "billingAccounts/{billing_account}"
|
80
|
-
# }
|
54
|
+
# pattern: "projects/{project}/logs/{log}"
|
55
|
+
# pattern: "folders/{folder}/logs/{log}"
|
56
|
+
# pattern: "organizations/{organization}/logs/{log}"
|
57
|
+
# pattern: "billingAccounts/{billing_account}/logs/{log}"
|
81
58
|
# };
|
82
59
|
# }
|
83
60
|
#
|
@@ -85,48 +62,10 @@ module Google
|
|
85
62
|
#
|
86
63
|
# resources:
|
87
64
|
# - type: 'logging.googleapis.com/LogEntry'
|
88
|
-
#
|
89
|
-
#
|
90
|
-
#
|
91
|
-
#
|
92
|
-
# - pattern: "folders/{folder}/logs/{log}"
|
93
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Folder"
|
94
|
-
# parent_name_extractor: "folders/{folder}"
|
95
|
-
# - pattern: "organizations/{organization}/logs/{log}"
|
96
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Organization"
|
97
|
-
# parent_name_extractor: "organizations/{organization}"
|
98
|
-
# - pattern: "billingAccounts/{billing_account}/logs/{log}"
|
99
|
-
# parent_type: "billing.googleapis.com/BillingAccount"
|
100
|
-
# parent_name_extractor: "billingAccounts/{billing_account}"
|
101
|
-
#
|
102
|
-
# For flexible resources, the resource name doesn't contain parent names, but
|
103
|
-
# the resource itself has parents for policy evaluation.
|
104
|
-
#
|
105
|
-
# Example:
|
106
|
-
#
|
107
|
-
# message Shelf {
|
108
|
-
# option (google.api.resource) = {
|
109
|
-
# type: "library.googleapis.com/Shelf"
|
110
|
-
# name_descriptor: {
|
111
|
-
# pattern: "shelves/{shelf}"
|
112
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
113
|
-
# }
|
114
|
-
# name_descriptor: {
|
115
|
-
# pattern: "shelves/{shelf}"
|
116
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Folder"
|
117
|
-
# }
|
118
|
-
# };
|
119
|
-
# }
|
120
|
-
#
|
121
|
-
# The ResourceDescriptor Yaml config will look like:
|
122
|
-
#
|
123
|
-
# resources:
|
124
|
-
# - type: 'library.googleapis.com/Shelf'
|
125
|
-
# name_descriptor:
|
126
|
-
# - pattern: "shelves/{shelf}"
|
127
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
128
|
-
# - pattern: "shelves/{shelf}"
|
129
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Folder"
|
65
|
+
# pattern: "projects/{project}/logs/{log}"
|
66
|
+
# pattern: "folders/{folder}/logs/{log}"
|
67
|
+
# pattern: "organizations/{organization}/logs/{log}"
|
68
|
+
# pattern: "billingAccounts/{billing_account}/logs/{log}"
|
130
69
|
# @!attribute [rw] type
|
131
70
|
# @return [::String]
|
132
71
|
# The resource type. It must be in the format of
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-cloud-vpc_access-v1
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.1.
|
4
|
+
version: 0.1.4
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2022-01-11 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: gapic-common
|
@@ -16,7 +16,7 @@ dependencies:
|
|
16
16
|
requirements:
|
17
17
|
- - ">="
|
18
18
|
- !ruby/object:Gem::Version
|
19
|
-
version: '0.
|
19
|
+
version: '0.7'
|
20
20
|
- - "<"
|
21
21
|
- !ruby/object:Gem::Version
|
22
22
|
version: 2.a
|
@@ -26,7 +26,7 @@ dependencies:
|
|
26
26
|
requirements:
|
27
27
|
- - ">="
|
28
28
|
- !ruby/object:Gem::Version
|
29
|
-
version: '0.
|
29
|
+
version: '0.7'
|
30
30
|
- - "<"
|
31
31
|
- !ruby/object:Gem::Version
|
32
32
|
version: 2.a
|
@@ -211,7 +211,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
211
211
|
- !ruby/object:Gem::Version
|
212
212
|
version: '0'
|
213
213
|
requirements: []
|
214
|
-
rubygems_version: 3.
|
214
|
+
rubygems_version: 3.3.4
|
215
215
|
signing_key:
|
216
216
|
specification_version: 4
|
217
217
|
summary: API Client library for the Serverless VPC Access V1 API
|