google-cloud-gke_hub-v1 0.3.0 → 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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 9a578c6b601802cbf6f745ea8440d6757c32d203c66d7aac7d3528ba47e600f4
4
- data.tar.gz: 567bd796308fee786e085765e6bd61f2d4df76beec091190f106025dd648c1dd
3
+ metadata.gz: 68b640139c983d7fb3f82ae7a8d2167f75c0ad214d1ac8c605f6c196a252568f
4
+ data.tar.gz: 8e2820da7d7998e2ea610da93ba8765869400374bfa58f9dd9132c70c6ff72bd
5
5
  SHA512:
6
- metadata.gz: 72db5aed16cf963921e5f38dee7c08281ebcacc3cff18e0f1f05d7895e414f3de8f8856fd2ccc88600df386352094b2db10757d91db2bcf5b72d9b0d9ee8e7c5
7
- data.tar.gz: 625009957e4c360ae738b7f581dff14b8cd93cfbc710621f259734deee890509277ffafa38f762707ba0a7bb8b3d9037cf6f1d4933711ee385b717ea77cd1bbd
6
+ metadata.gz: a91172fa0e47681f0dba2caa871a261ba383f356ad540eec3f9c7f5ef19d4c49e3a8060a24ab7530214461190d9fbadf744fbec2951b55766fc350c707e58680
7
+ data.tar.gz: 131589f7f062ed906c51d4d097c8eaa9cec11a9d0e0730c80efd395732225abb6af3aae0c2ea19fd33155faa4e2ef595437efa55651399295c020f819691f016
data/AUTHENTICATION.md CHANGED
@@ -114,7 +114,7 @@ credentials are discovered.
114
114
  To configure your system for this, simply:
115
115
 
116
116
  1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
117
- 2. Authenticate using OAuth 2.0 `$ gcloud auth login`
117
+ 2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
118
118
  3. Write code as if already authenticated.
119
119
 
120
120
  **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
data/README.md CHANGED
@@ -46,8 +46,8 @@ for general usage information.
46
46
  ## Enabling Logging
47
47
 
48
48
  To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
49
- The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html) as shown below,
50
- or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
49
+ The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
50
+ or a [`Google::Cloud::Logging::Logger`](https://cloud.google.com/ruby/docs/reference/google-cloud-logging/latest)
51
51
  that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
52
52
  and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
53
53
 
@@ -36,7 +36,10 @@ module Google
36
36
  # * {::Google::Cloud::GkeHub::V1::Membership Membership}
37
37
  # * {::Google::Cloud::GkeHub::V1::Feature Feature}
38
38
  #
39
- # GKE Hub is currently only available in the global region.
39
+ # GKE Hub is currently available in the global region and all regions in
40
+ # https://cloud.google.com/compute/docs/regions-zones. Feature is only
41
+ # available in global region while membership is global region and all the
42
+ # regions.
40
43
  #
41
44
  # **Membership management may be non-trivial:** it is recommended to use one
42
45
  # of the Google-provided client libraries or tools where possible when working
@@ -194,19 +197,20 @@ module Google
194
197
  # the default parameter values, pass an empty Hash as a request object (see above).
195
198
  #
196
199
  # @param parent [::String]
197
- # Required. The parent (project and location) where the Memberships will be listed.
198
- # Specified in the format `projects/*/locations/*`.
200
+ # Required. The parent (project and location) where the Memberships will be
201
+ # listed. Specified in the format `projects/*/locations/*`.
202
+ # `projects/*/locations/-` list memberships in all the regions.
199
203
  # @param page_size [::Integer]
200
- # Optional. When requesting a 'page' of resources, `page_size` specifies number of
201
- # resources to return. If unspecified or set to 0, all resources will
202
- # be returned.
204
+ # Optional. When requesting a 'page' of resources, `page_size` specifies
205
+ # number of resources to return. If unspecified or set to 0, all resources
206
+ # will be returned.
203
207
  # @param page_token [::String]
204
208
  # Optional. Token returned by previous call to `ListMemberships` which
205
209
  # specifies the position in the list from where to continue listing the
206
210
  # resources.
207
211
  # @param filter [::String]
208
- # Optional. Lists Memberships that match the filter expression, following the syntax
209
- # outlined in https://google.aip.dev/160.
212
+ # Optional. Lists Memberships that match the filter expression, following the
213
+ # syntax outlined in https://google.aip.dev/160.
210
214
  #
211
215
  # Examples:
212
216
  #
@@ -249,13 +253,11 @@ module Google
249
253
  # # Call the list_memberships method.
250
254
  # result = client.list_memberships request
251
255
  #
252
- # # The returned object is of type Gapic::PagedEnumerable. You can
253
- # # iterate over all elements by calling #each, and the enumerable
254
- # # will lazily make API calls to fetch subsequent pages. Other
255
- # # methods are also available for managing paging directly.
256
- # result.each do |response|
256
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
257
+ # # over elements, and API calls will be issued to fetch pages as needed.
258
+ # result.each do |item|
257
259
  # # Each element is of type ::Google::Cloud::GkeHub::V1::Membership.
258
- # p response
260
+ # p item
259
261
  # end
260
262
  #
261
263
  def list_memberships request, options = nil
@@ -370,13 +372,11 @@ module Google
370
372
  # # Call the list_features method.
371
373
  # result = client.list_features request
372
374
  #
373
- # # The returned object is of type Gapic::PagedEnumerable. You can
374
- # # iterate over all elements by calling #each, and the enumerable
375
- # # will lazily make API calls to fetch subsequent pages. Other
376
- # # methods are also available for managing paging directly.
377
- # result.each do |response|
375
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
376
+ # # over elements, and API calls will be issued to fetch pages as needed.
377
+ # result.each do |item|
378
378
  # # Each element is of type ::Google::Cloud::GkeHub::V1::Feature.
379
- # p response
379
+ # p item
380
380
  # end
381
381
  #
382
382
  def list_features request, options = nil
@@ -616,11 +616,11 @@ module Google
616
616
  # the default parameter values, pass an empty Hash as a request object (see above).
617
617
  #
618
618
  # @param parent [::String]
619
- # Required. The parent (project and location) where the Memberships will be created.
620
- # Specified in the format `projects/*/locations/*`.
619
+ # Required. The parent (project and location) where the Memberships will be
620
+ # created. Specified in the format `projects/*/locations/*`.
621
621
  # @param membership_id [::String]
622
- # Required. Client chosen ID for the membership. `membership_id` must be a valid RFC
623
- # 1123 compliant DNS label:
622
+ # Required. Client chosen ID for the membership. `membership_id` must be a
623
+ # valid RFC 1123 compliant DNS label:
624
624
  #
625
625
  # 1. At most 63 characters in length
626
626
  # 2. It must consist of lower case alphanumeric characters or `-`
@@ -665,14 +665,14 @@ module Google
665
665
  # # Call the create_membership method.
666
666
  # result = client.create_membership request
667
667
  #
668
- # # The returned object is of type Gapic::Operation. You can use this
669
- # # object to check the status of an operation, cancel it, or wait
670
- # # for results. Here is how to block until completion:
668
+ # # The returned object is of type Gapic::Operation. You can use it to
669
+ # # check the status of an operation, cancel it, or wait for results.
670
+ # # Here is how to wait for a response.
671
671
  # result.wait_until_done! timeout: 60
672
672
  # if result.response?
673
673
  # p result.response
674
674
  # else
675
- # puts "Error!"
675
+ # puts "No response received."
676
676
  # end
677
677
  #
678
678
  def create_membership request, options = nil
@@ -777,14 +777,14 @@ module Google
777
777
  # # Call the create_feature method.
778
778
  # result = client.create_feature request
779
779
  #
780
- # # The returned object is of type Gapic::Operation. You can use this
781
- # # object to check the status of an operation, cancel it, or wait
782
- # # for results. Here is how to block until completion:
780
+ # # The returned object is of type Gapic::Operation. You can use it to
781
+ # # check the status of an operation, cancel it, or wait for results.
782
+ # # Here is how to wait for a response.
783
783
  # result.wait_until_done! timeout: 60
784
784
  # if result.response?
785
785
  # p result.response
786
786
  # else
787
- # puts "Error!"
787
+ # puts "No response received."
788
788
  # end
789
789
  #
790
790
  def create_feature request, options = nil
@@ -846,7 +846,7 @@ module Google
846
846
  # @param options [::Gapic::CallOptions, ::Hash]
847
847
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
848
848
  #
849
- # @overload delete_membership(name: nil, request_id: nil)
849
+ # @overload delete_membership(name: nil, request_id: nil, force: nil)
850
850
  # Pass arguments to `delete_membership` via keyword arguments. Note that at
851
851
  # least one keyword argument is required. To specify no parameters, or to keep all
852
852
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -868,6 +868,10 @@ module Google
868
868
  #
869
869
  # The request ID must be a valid UUID with the exception that zero UUID is
870
870
  # not supported (00000000-0000-0000-0000-000000000000).
871
+ # @param force [::Boolean]
872
+ # Optional. If set to true, any subresource from this Membership will also be
873
+ # deleted. Otherwise, the request will only work if the Membership has no
874
+ # subresource.
871
875
  #
872
876
  # @yield [response, operation] Access the result along with the RPC operation
873
877
  # @yieldparam response [::Gapic::Operation]
@@ -889,14 +893,14 @@ module Google
889
893
  # # Call the delete_membership method.
890
894
  # result = client.delete_membership request
891
895
  #
892
- # # The returned object is of type Gapic::Operation. You can use this
893
- # # object to check the status of an operation, cancel it, or wait
894
- # # for results. Here is how to block until completion:
896
+ # # The returned object is of type Gapic::Operation. You can use it to
897
+ # # check the status of an operation, cancel it, or wait for results.
898
+ # # Here is how to wait for a response.
895
899
  # result.wait_until_done! timeout: 60
896
900
  # if result.response?
897
901
  # p result.response
898
902
  # else
899
- # puts "Error!"
903
+ # puts "No response received."
900
904
  # end
901
905
  #
902
906
  def delete_membership request, options = nil
@@ -1001,14 +1005,14 @@ module Google
1001
1005
  # # Call the delete_feature method.
1002
1006
  # result = client.delete_feature request
1003
1007
  #
1004
- # # The returned object is of type Gapic::Operation. You can use this
1005
- # # object to check the status of an operation, cancel it, or wait
1006
- # # for results. Here is how to block until completion:
1008
+ # # The returned object is of type Gapic::Operation. You can use it to
1009
+ # # check the status of an operation, cancel it, or wait for results.
1010
+ # # Here is how to wait for a response.
1007
1011
  # result.wait_until_done! timeout: 60
1008
1012
  # if result.response?
1009
1013
  # p result.response
1010
1014
  # else
1011
- # puts "Error!"
1015
+ # puts "No response received."
1012
1016
  # end
1013
1017
  #
1014
1018
  def delete_feature request, options = nil
@@ -1120,14 +1124,14 @@ module Google
1120
1124
  # # Call the update_membership method.
1121
1125
  # result = client.update_membership request
1122
1126
  #
1123
- # # The returned object is of type Gapic::Operation. You can use this
1124
- # # object to check the status of an operation, cancel it, or wait
1125
- # # for results. Here is how to block until completion:
1127
+ # # The returned object is of type Gapic::Operation. You can use it to
1128
+ # # check the status of an operation, cancel it, or wait for results.
1129
+ # # Here is how to wait for a response.
1126
1130
  # result.wait_until_done! timeout: 60
1127
1131
  # if result.response?
1128
1132
  # p result.response
1129
1133
  # else
1130
- # puts "Error!"
1134
+ # puts "No response received."
1131
1135
  # end
1132
1136
  #
1133
1137
  def update_membership request, options = nil
@@ -1239,14 +1243,14 @@ module Google
1239
1243
  # # Call the update_feature method.
1240
1244
  # result = client.update_feature request
1241
1245
  #
1242
- # # The returned object is of type Gapic::Operation. You can use this
1243
- # # object to check the status of an operation, cancel it, or wait
1244
- # # for results. Here is how to block until completion:
1246
+ # # The returned object is of type Gapic::Operation. You can use it to
1247
+ # # check the status of an operation, cancel it, or wait for results.
1248
+ # # Here is how to wait for a response.
1245
1249
  # result.wait_until_done! timeout: 60
1246
1250
  # if result.response?
1247
1251
  # p result.response
1248
1252
  # else
1249
- # puts "Error!"
1253
+ # puts "No response received."
1250
1254
  # end
1251
1255
  #
1252
1256
  def update_feature request, options = nil
@@ -1313,22 +1317,24 @@ module Google
1313
1317
  # the default parameter values, pass an empty Hash as a request object (see above).
1314
1318
  #
1315
1319
  # @param name [::String]
1316
- # Required. The Membership resource name the Agent will associate with, in the format
1317
- # `projects/*/locations/*/memberships/*`.
1320
+ # Required. The Membership resource name the Agent will associate with, in
1321
+ # the format `projects/*/locations/*/memberships/*`.
1318
1322
  # @param namespace [::String]
1319
- # Optional. Namespace for GKE Connect agent resources. Defaults to `gke-connect`.
1323
+ # Optional. Namespace for GKE Connect agent resources. Defaults to
1324
+ # `gke-connect`.
1320
1325
  #
1321
1326
  # The Connect Agent is authorized automatically when run in the default
1322
1327
  # namespace. Otherwise, explicit authorization must be granted with an
1323
1328
  # additional IAM binding.
1324
1329
  # @param proxy [::String]
1325
- # Optional. URI of a proxy if connectivity from the agent to gkeconnect.googleapis.com
1326
- # requires the use of a proxy. Format must be in the form
1327
- # `http(s)://{proxy_address}`, depending on the HTTP/HTTPS protocol
1330
+ # Optional. URI of a proxy if connectivity from the agent to
1331
+ # gkeconnect.googleapis.com requires the use of a proxy. Format must be in
1332
+ # the form `http(s)://{proxy_address}`, depending on the HTTP/HTTPS protocol
1328
1333
  # supported by the proxy. This will direct the connect agent's outbound
1329
1334
  # traffic through a HTTP(S) proxy.
1330
1335
  # @param version [::String]
1331
- # Optional. The Connect agent version to use. Defaults to the most current version.
1336
+ # Optional. The Connect agent version to use. Defaults to the most current
1337
+ # version.
1332
1338
  # @param is_upgrade [::Boolean]
1333
1339
  # Optional. If true, generate the resources for upgrade only. Some resources
1334
1340
  # generated only for installation (e.g. secrets) will be excluded.
@@ -1440,9 +1446,9 @@ module Google
1440
1446
  # * (`String`) The path to a service account key file in JSON format
1441
1447
  # * (`Hash`) A service account key as a Hash
1442
1448
  # * (`Google::Auth::Credentials`) A googleauth credentials object
1443
- # (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
1449
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
1444
1450
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
1445
- # (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
1451
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
1446
1452
  # * (`GRPC::Core::Channel`) a gRPC channel with included credentials
1447
1453
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
1448
1454
  # * (`nil`) indicating no credentials
@@ -158,13 +158,11 @@ module Google
158
158
  # # Call the list_operations method.
159
159
  # result = client.list_operations request
160
160
  #
161
- # # The returned object is of type Gapic::PagedEnumerable. You can
162
- # # iterate over all elements by calling #each, and the enumerable
163
- # # will lazily make API calls to fetch subsequent pages. Other
164
- # # methods are also available for managing paging directly.
165
- # result.each do |response|
161
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
162
+ # # over elements, and API calls will be issued to fetch pages as needed.
163
+ # result.each do |item|
166
164
  # # Each element is of type ::Google::Longrunning::Operation.
167
- # p response
165
+ # p item
168
166
  # end
169
167
  #
170
168
  def list_operations request, options = nil
@@ -253,14 +251,14 @@ module Google
253
251
  # # Call the get_operation method.
254
252
  # result = client.get_operation request
255
253
  #
256
- # # The returned object is of type Gapic::Operation. You can use this
257
- # # object to check the status of an operation, cancel it, or wait
258
- # # for results. Here is how to block until completion:
254
+ # # The returned object is of type Gapic::Operation. You can use it to
255
+ # # check the status of an operation, cancel it, or wait for results.
256
+ # # Here is how to wait for a response.
259
257
  # result.wait_until_done! timeout: 60
260
258
  # if result.response?
261
259
  # p result.response
262
260
  # else
263
- # puts "Error!"
261
+ # puts "No response received."
264
262
  # end
265
263
  #
266
264
  def get_operation request, options = nil
@@ -540,14 +538,14 @@ module Google
540
538
  # # Call the wait_operation method.
541
539
  # result = client.wait_operation request
542
540
  #
543
- # # The returned object is of type Gapic::Operation. You can use this
544
- # # object to check the status of an operation, cancel it, or wait
545
- # # for results. Here is how to block until completion:
541
+ # # The returned object is of type Gapic::Operation. You can use it to
542
+ # # check the status of an operation, cancel it, or wait for results.
543
+ # # Here is how to wait for a response.
546
544
  # result.wait_until_done! timeout: 60
547
545
  # if result.response?
548
546
  # p result.response
549
547
  # else
550
- # puts "Error!"
548
+ # puts "No response received."
551
549
  # end
552
550
  #
553
551
  def wait_operation request, options = nil
@@ -622,9 +620,9 @@ module Google
622
620
  # * (`String`) The path to a service account key file in JSON format
623
621
  # * (`Hash`) A service account key as a Hash
624
622
  # * (`Google::Auth::Credentials`) A googleauth credentials object
625
- # (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
623
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
626
624
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
627
- # (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
625
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
628
626
  # * (`GRPC::Core::Channel`) a gRPC channel with included credentials
629
627
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
630
628
  # * (`nil`) indicating no credentials