google-cloud-service_directory-v1beta1 0.2.1 → 0.3.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 8c99a3d8ffe0f6be3ddae0066541275614cf9ef6bd45dec9c03c7c596fcbfb1c
4
- data.tar.gz: 071503d3a440f673f4329140ad2d1768c844fb9097eb25b58610246cd7a8f11c
3
+ metadata.gz: ceb13298218cecaebb2064755709b319f7809a5e67619e3949672403ed9988a6
4
+ data.tar.gz: a683567f3cd8659b66388f6635a91429c7dd54e91db716f0e82795f1d647f56d
5
5
  SHA512:
6
- metadata.gz: d44f1240563aee7c7552fc009c95106eab9bdfcbbdaab5e29b9d55c089a82a4a1c5660052f59cdc07b01bb4a5c3a62cb878380de3776451b6240ee366ff5c9b5
7
- data.tar.gz: 29b161a0fff18109ffdadc6efd6b2ab7e74d77955ac518b6ef505b0d459c0b6fe1cd2934de46895c18efa9ac264cd3469fda0e6632e61f78170dc08b6281be23
6
+ metadata.gz: b145c6591d1ec968a1acd761a92a030b95feaf0ff840bd69ffa0744e81989be7e850ce5da94578aa9e6de3cd569f3bc8b8d3f58c009d1a70611b94868662cbdd
7
+ data.tar.gz: 65229f5652bd8c785b4062fb44f643f88297b4aa5e69d35b834bff848abfbd63260797edc459c5a2f60b8a8bb53677f67310aa45432f686c9197191d6cc0767f
data/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # Service Directory V1beta1
1
+ # Ruby Client for the Service Directory V1beta1 API
2
2
 
3
3
  API Client library for the Service Directory V1beta1 API
4
4
 
@@ -12,6 +12,53 @@ https://github.com/googleapis/google-cloud-ruby
12
12
  $ gem install google-cloud-service_directory-v1beta1
13
13
  ```
14
14
 
15
+ ## Before You Begin
16
+
17
+ In order to use this library, you first need to go through the following steps:
18
+
19
+ 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
20
+ 1. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
21
+ 1. {file:AUTHENTICATION.md Set up authentication.}
22
+
23
+ ## Quick Start
24
+
25
+ ```ruby
26
+ require "google/cloud/service_directory/v1beta1"
27
+
28
+ client = Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client.new
29
+ request = my_create_request
30
+ response = client.resolve_service request
31
+ ```
32
+
33
+ View the [Client Library Documentation](https://googleapis.dev/ruby/google-cloud-service_directory-v1beta1/latest)
34
+ for class and method documentation.
35
+
36
+ ## Enabling Logging
37
+
38
+ To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
39
+ The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html) as shown below,
40
+ or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
41
+ 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)
42
+ and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
43
+
44
+ Configuring a Ruby stdlib logger:
45
+
46
+ ```ruby
47
+ require "logger"
48
+
49
+ module MyLogger
50
+ LOGGER = Logger.new $stderr, level: Logger::WARN
51
+ def logger
52
+ LOGGER
53
+ end
54
+ end
55
+
56
+ # Define a gRPC module-level logger method before grpc/logconfig.rb loads.
57
+ module GRPC
58
+ extend MyLogger
59
+ end
60
+ ```
61
+
15
62
  ## Supported Ruby Versions
16
63
 
17
64
  This library is supported on Ruby 2.4+.
@@ -1 +1,21 @@
1
- require "google/cloud/service_directory/v1beta1/version"
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2020 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+ # This gem does not autoload during Bundler.require. To load this gem,
20
+ # issue explicit require statements for the packages desired, e.g.:
21
+ # require "google/cloud/service_directory/v1beta1"
@@ -18,3 +18,19 @@
18
18
 
19
19
  require "google/cloud/service_directory/v1beta1/lookup_service"
20
20
  require "google/cloud/service_directory/v1beta1/registration_service"
21
+ require "google/cloud/service_directory/v1beta1/version"
22
+
23
+ module Google
24
+ module Cloud
25
+ module ServiceDirectory
26
+ ##
27
+ # To load this package, including all its services, and instantiate a client:
28
+ #
29
+ # require "google/cloud/service_directory/v1beta1"
30
+ # client = Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client.new
31
+ #
32
+ module V1beta1
33
+ end
34
+ end
35
+ end
36
+ end
@@ -16,5 +16,34 @@
16
16
 
17
17
  # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
18
 
19
- require "google/cloud/service_directory/v1beta1/lookup_service/client"
19
+ require "gapic/common"
20
+ require "gapic/config"
21
+ require "gapic/config/method"
22
+
23
+ require "google/cloud/service_directory/v1beta1/version"
24
+
20
25
  require "google/cloud/service_directory/v1beta1/lookup_service/credentials"
26
+ require "google/cloud/service_directory/v1beta1/lookup_service/paths"
27
+ require "google/cloud/service_directory/v1beta1/lookup_service/client"
28
+
29
+ module Google
30
+ module Cloud
31
+ module ServiceDirectory
32
+ module V1beta1
33
+ ##
34
+ # Service Directory API for looking up service data at runtime.
35
+ #
36
+ # To load this service and instantiate a client:
37
+ #
38
+ # require "google/cloud/service_directory/v1beta1/lookup_service"
39
+ # client = Google::Cloud::ServiceDirectory::V1beta1::LookupService::Client.new
40
+ #
41
+ module LookupService
42
+ end
43
+ end
44
+ end
45
+ end
46
+ end
47
+
48
+ helper_path = ::File.join __dir__, "lookup_service", "helpers.rb"
49
+ require "google/cloud/service_directory/v1beta1/lookup_service/helpers" if ::File.file? helper_path
@@ -16,15 +16,8 @@
16
16
 
17
17
  # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
18
 
19
- require "gapic/common"
20
- require "gapic/config"
21
- require "gapic/config/method"
22
-
23
19
  require "google/cloud/errors"
24
- require "google/cloud/service_directory/v1beta1/version"
25
20
  require "google/cloud/servicedirectory/v1beta1/lookup_service_pb"
26
- require "google/cloud/service_directory/v1beta1/lookup_service/credentials"
27
- require "google/cloud/service_directory/v1beta1/lookup_service/paths"
28
21
 
29
22
  module Google
30
23
  module Cloud
@@ -164,14 +157,20 @@ module Google
164
157
  # Resolving a service is not considered an active developer method.
165
158
  #
166
159
  # @overload resolve_service(request, options = nil)
167
- # @param request [Google::Cloud::ServiceDirectory::V1beta1::ResolveServiceRequest | Hash]
168
- # Returns a {Google::Cloud::ServiceDirectory::V1beta1::Service service} and its
169
- # associated endpoints.
170
- # Resolving a service is not considered an active developer method.
160
+ # Pass arguments to `resolve_service` via a request object, either of type
161
+ # {Google::Cloud::ServiceDirectory::V1beta1::ResolveServiceRequest} or an equivalent Hash.
162
+ #
163
+ # @param request [Google::Cloud::ServiceDirectory::V1beta1::ResolveServiceRequest, Hash]
164
+ # A request object representing the call parameters. Required. To specify no
165
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
171
166
  # @param options [Gapic::CallOptions, Hash]
172
167
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
173
168
  #
174
169
  # @overload resolve_service(name: nil, max_endpoints: nil, endpoint_filter: nil)
170
+ # Pass arguments to `resolve_service` via keyword arguments. Note that at
171
+ # least one keyword argument is required. To specify no parameters, or to keep all
172
+ # the default parameter values, pass an empty Hash as a request object (see above).
173
+ #
175
174
  # @param name [String]
176
175
  # Required. The name of the service to resolve.
177
176
  # @param max_endpoints [Integer]
@@ -198,7 +197,6 @@ module Google
198
197
  # Endpoints that have "owner" field in metadata with a value that is not
199
198
  # "sd" AND have the key/value foo=bar.
200
199
  #
201
- #
202
200
  # @yield [response, operation] Access the result along with the RPC operation
203
201
  # @yieldparam response [Google::Cloud::ServiceDirectory::V1beta1::ResolveServiceResponse]
204
202
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -397,13 +395,3 @@ module Google
397
395
  end
398
396
  end
399
397
  end
400
-
401
- # rubocop:disable Lint/HandleExceptions
402
-
403
- # Once client is loaded, load helpers.rb if it exists.
404
- begin
405
- require "google/cloud/service_directory/v1beta1/lookup_service/helpers"
406
- rescue LoadError
407
- end
408
-
409
- # rubocop:enable Lint/HandleExceptions
@@ -16,5 +16,48 @@
16
16
 
17
17
  # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
18
 
19
- require "google/cloud/service_directory/v1beta1/registration_service/client"
19
+ require "gapic/common"
20
+ require "gapic/config"
21
+ require "gapic/config/method"
22
+
23
+ require "google/cloud/service_directory/v1beta1/version"
24
+
20
25
  require "google/cloud/service_directory/v1beta1/registration_service/credentials"
26
+ require "google/cloud/service_directory/v1beta1/registration_service/paths"
27
+ require "google/cloud/service_directory/v1beta1/registration_service/client"
28
+
29
+ module Google
30
+ module Cloud
31
+ module ServiceDirectory
32
+ module V1beta1
33
+ ##
34
+ # Service Directory API for registering services. It defines the following
35
+ # resource model:
36
+ #
37
+ # - The API has a collection of
38
+ # {Google::Cloud::ServiceDirectory::V1beta1::Namespace Namespace}
39
+ # resources, named `projects/*/locations/*/namespaces/*`.
40
+ #
41
+ # - Each Namespace has a collection of
42
+ # {Google::Cloud::ServiceDirectory::V1beta1::Service Service} resources, named
43
+ # `projects/*/locations/*/namespaces/*/services/*`.
44
+ #
45
+ # - Each Service has a collection of
46
+ # {Google::Cloud::ServiceDirectory::V1beta1::Endpoint Endpoint}
47
+ # resources, named
48
+ # `projects/*/locations/*/namespaces/*/services/*/endpoints/*`.
49
+ #
50
+ # To load this service and instantiate a client:
51
+ #
52
+ # require "google/cloud/service_directory/v1beta1/registration_service"
53
+ # client = Google::Cloud::ServiceDirectory::V1beta1::RegistrationService::Client.new
54
+ #
55
+ module RegistrationService
56
+ end
57
+ end
58
+ end
59
+ end
60
+ end
61
+
62
+ helper_path = ::File.join __dir__, "registration_service", "helpers.rb"
63
+ require "google/cloud/service_directory/v1beta1/registration_service/helpers" if ::File.file? helper_path
@@ -16,15 +16,8 @@
16
16
 
17
17
  # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
18
 
19
- require "gapic/common"
20
- require "gapic/config"
21
- require "gapic/config/method"
22
-
23
19
  require "google/cloud/errors"
24
- require "google/cloud/service_directory/v1beta1/version"
25
20
  require "google/cloud/servicedirectory/v1beta1/registration_service_pb"
26
- require "google/cloud/service_directory/v1beta1/registration_service/credentials"
27
- require "google/cloud/service_directory/v1beta1/registration_service/paths"
28
21
 
29
22
  module Google
30
23
  module Cloud
@@ -176,12 +169,20 @@ module Google
176
169
  # Creates a namespace, and returns the new Namespace.
177
170
  #
178
171
  # @overload create_namespace(request, options = nil)
179
- # @param request [Google::Cloud::ServiceDirectory::V1beta1::CreateNamespaceRequest | Hash]
180
- # Creates a namespace, and returns the new Namespace.
172
+ # Pass arguments to `create_namespace` via a request object, either of type
173
+ # {Google::Cloud::ServiceDirectory::V1beta1::CreateNamespaceRequest} or an equivalent Hash.
174
+ #
175
+ # @param request [Google::Cloud::ServiceDirectory::V1beta1::CreateNamespaceRequest, Hash]
176
+ # A request object representing the call parameters. Required. To specify no
177
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
181
178
  # @param options [Gapic::CallOptions, Hash]
182
179
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
183
180
  #
184
181
  # @overload create_namespace(parent: nil, namespace_id: nil, namespace: nil)
182
+ # Pass arguments to `create_namespace` via keyword arguments. Note that at
183
+ # least one keyword argument is required. To specify no parameters, or to keep all
184
+ # the default parameter values, pass an empty Hash as a request object (see above).
185
+ #
185
186
  # @param parent [String]
186
187
  # Required. The resource name of the project and location the namespace
187
188
  # will be created in.
@@ -193,10 +194,9 @@ module Google
193
194
  # character must be a lowercase letter, and all following characters must
194
195
  # be a dash, lowercase letter, or digit, except the last character, which
195
196
  # cannot be a dash.
196
- # @param namespace [Google::Cloud::ServiceDirectory::V1beta1::Namespace | Hash]
197
+ # @param namespace [Google::Cloud::ServiceDirectory::V1beta1::Namespace, Hash]
197
198
  # Required. A namespace with initial fields set.
198
199
  #
199
- #
200
200
  # @yield [response, operation] Access the result along with the RPC operation
201
201
  # @yieldparam response [Google::Cloud::ServiceDirectory::V1beta1::Namespace]
202
202
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -246,12 +246,20 @@ module Google
246
246
  # Lists all namespaces.
247
247
  #
248
248
  # @overload list_namespaces(request, options = nil)
249
- # @param request [Google::Cloud::ServiceDirectory::V1beta1::ListNamespacesRequest | Hash]
250
- # Lists all namespaces.
249
+ # Pass arguments to `list_namespaces` via a request object, either of type
250
+ # {Google::Cloud::ServiceDirectory::V1beta1::ListNamespacesRequest} or an equivalent Hash.
251
+ #
252
+ # @param request [Google::Cloud::ServiceDirectory::V1beta1::ListNamespacesRequest, Hash]
253
+ # A request object representing the call parameters. Required. To specify no
254
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
251
255
  # @param options [Gapic::CallOptions, Hash]
252
256
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
253
257
  #
254
258
  # @overload list_namespaces(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil)
259
+ # Pass arguments to `list_namespaces` via keyword arguments. Note that at
260
+ # least one keyword argument is required. To specify no parameters, or to keep all
261
+ # the default parameter values, pass an empty Hash as a request object (see above).
262
+ #
255
263
  # @param parent [String]
256
264
  # Required. The resource name of the project and location whose namespaces we'd like to
257
265
  # list.
@@ -294,7 +302,6 @@ module Google
294
302
  # Note that an empty order_by string result in default order, which is order
295
303
  # by name in ascending order.
296
304
  #
297
- #
298
305
  # @yield [response, operation] Access the result along with the RPC operation
299
306
  # @yieldparam response [Gapic::PagedEnumerable<Google::Cloud::ServiceDirectory::V1beta1::Namespace>]
300
307
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -345,16 +352,23 @@ module Google
345
352
  # Gets a namespace.
346
353
  #
347
354
  # @overload get_namespace(request, options = nil)
348
- # @param request [Google::Cloud::ServiceDirectory::V1beta1::GetNamespaceRequest | Hash]
349
- # Gets a namespace.
355
+ # Pass arguments to `get_namespace` via a request object, either of type
356
+ # {Google::Cloud::ServiceDirectory::V1beta1::GetNamespaceRequest} or an equivalent Hash.
357
+ #
358
+ # @param request [Google::Cloud::ServiceDirectory::V1beta1::GetNamespaceRequest, Hash]
359
+ # A request object representing the call parameters. Required. To specify no
360
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
350
361
  # @param options [Gapic::CallOptions, Hash]
351
362
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
352
363
  #
353
364
  # @overload get_namespace(name: nil)
365
+ # Pass arguments to `get_namespace` via keyword arguments. Note that at
366
+ # least one keyword argument is required. To specify no parameters, or to keep all
367
+ # the default parameter values, pass an empty Hash as a request object (see above).
368
+ #
354
369
  # @param name [String]
355
370
  # Required. The name of the namespace to retrieve.
356
371
  #
357
- #
358
372
  # @yield [response, operation] Access the result along with the RPC operation
359
373
  # @yieldparam response [Google::Cloud::ServiceDirectory::V1beta1::Namespace]
360
374
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -404,18 +418,25 @@ module Google
404
418
  # Updates a namespace.
405
419
  #
406
420
  # @overload update_namespace(request, options = nil)
407
- # @param request [Google::Cloud::ServiceDirectory::V1beta1::UpdateNamespaceRequest | Hash]
408
- # Updates a namespace.
421
+ # Pass arguments to `update_namespace` via a request object, either of type
422
+ # {Google::Cloud::ServiceDirectory::V1beta1::UpdateNamespaceRequest} or an equivalent Hash.
423
+ #
424
+ # @param request [Google::Cloud::ServiceDirectory::V1beta1::UpdateNamespaceRequest, Hash]
425
+ # A request object representing the call parameters. Required. To specify no
426
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
409
427
  # @param options [Gapic::CallOptions, Hash]
410
428
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
411
429
  #
412
430
  # @overload update_namespace(namespace: nil, update_mask: nil)
413
- # @param namespace [Google::Cloud::ServiceDirectory::V1beta1::Namespace | Hash]
431
+ # Pass arguments to `update_namespace` via keyword arguments. Note that at
432
+ # least one keyword argument is required. To specify no parameters, or to keep all
433
+ # the default parameter values, pass an empty Hash as a request object (see above).
434
+ #
435
+ # @param namespace [Google::Cloud::ServiceDirectory::V1beta1::Namespace, Hash]
414
436
  # Required. The updated namespace.
415
- # @param update_mask [Google::Protobuf::FieldMask | Hash]
437
+ # @param update_mask [Google::Protobuf::FieldMask, Hash]
416
438
  # Required. List of fields to be updated in this request.
417
439
  #
418
- #
419
440
  # @yield [response, operation] Access the result along with the RPC operation
420
441
  # @yieldparam response [Google::Cloud::ServiceDirectory::V1beta1::Namespace]
421
442
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -466,17 +487,23 @@ module Google
466
487
  # the namespace.
467
488
  #
468
489
  # @overload delete_namespace(request, options = nil)
469
- # @param request [Google::Cloud::ServiceDirectory::V1beta1::DeleteNamespaceRequest | Hash]
470
- # Deletes a namespace. This also deletes all services and endpoints in
471
- # the namespace.
490
+ # Pass arguments to `delete_namespace` via a request object, either of type
491
+ # {Google::Cloud::ServiceDirectory::V1beta1::DeleteNamespaceRequest} or an equivalent Hash.
492
+ #
493
+ # @param request [Google::Cloud::ServiceDirectory::V1beta1::DeleteNamespaceRequest, Hash]
494
+ # A request object representing the call parameters. Required. To specify no
495
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
472
496
  # @param options [Gapic::CallOptions, Hash]
473
497
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
474
498
  #
475
499
  # @overload delete_namespace(name: nil)
500
+ # Pass arguments to `delete_namespace` via keyword arguments. Note that at
501
+ # least one keyword argument is required. To specify no parameters, or to keep all
502
+ # the default parameter values, pass an empty Hash as a request object (see above).
503
+ #
476
504
  # @param name [String]
477
505
  # Required. The name of the namespace to delete.
478
506
  #
479
- #
480
507
  # @yield [response, operation] Access the result along with the RPC operation
481
508
  # @yieldparam response [Google::Protobuf::Empty]
482
509
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -526,12 +553,20 @@ module Google
526
553
  # Creates a service, and returns the new Service.
527
554
  #
528
555
  # @overload create_service(request, options = nil)
529
- # @param request [Google::Cloud::ServiceDirectory::V1beta1::CreateServiceRequest | Hash]
530
- # Creates a service, and returns the new Service.
556
+ # Pass arguments to `create_service` via a request object, either of type
557
+ # {Google::Cloud::ServiceDirectory::V1beta1::CreateServiceRequest} or an equivalent Hash.
558
+ #
559
+ # @param request [Google::Cloud::ServiceDirectory::V1beta1::CreateServiceRequest, Hash]
560
+ # A request object representing the call parameters. Required. To specify no
561
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
531
562
  # @param options [Gapic::CallOptions, Hash]
532
563
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
533
564
  #
534
565
  # @overload create_service(parent: nil, service_id: nil, service: nil)
566
+ # Pass arguments to `create_service` via keyword arguments. Note that at
567
+ # least one keyword argument is required. To specify no parameters, or to keep all
568
+ # the default parameter values, pass an empty Hash as a request object (see above).
569
+ #
535
570
  # @param parent [String]
536
571
  # Required. The resource name of the namespace this service will belong to.
537
572
  # @param service_id [String]
@@ -542,10 +577,9 @@ module Google
542
577
  # character must be a lowercase letter, and all following characters must
543
578
  # be a dash, lowercase letter, or digit, except the last character, which
544
579
  # cannot be a dash.
545
- # @param service [Google::Cloud::ServiceDirectory::V1beta1::Service | Hash]
580
+ # @param service [Google::Cloud::ServiceDirectory::V1beta1::Service, Hash]
546
581
  # Required. A service with initial fields set.
547
582
  #
548
- #
549
583
  # @yield [response, operation] Access the result along with the RPC operation
550
584
  # @yieldparam response [Google::Cloud::ServiceDirectory::V1beta1::Service]
551
585
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -595,12 +629,20 @@ module Google
595
629
  # Lists all services belonging to a namespace.
596
630
  #
597
631
  # @overload list_services(request, options = nil)
598
- # @param request [Google::Cloud::ServiceDirectory::V1beta1::ListServicesRequest | Hash]
599
- # Lists all services belonging to a namespace.
632
+ # Pass arguments to `list_services` via a request object, either of type
633
+ # {Google::Cloud::ServiceDirectory::V1beta1::ListServicesRequest} or an equivalent Hash.
634
+ #
635
+ # @param request [Google::Cloud::ServiceDirectory::V1beta1::ListServicesRequest, Hash]
636
+ # A request object representing the call parameters. Required. To specify no
637
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
600
638
  # @param options [Gapic::CallOptions, Hash]
601
639
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
602
640
  #
603
641
  # @overload list_services(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil)
642
+ # Pass arguments to `list_services` via keyword arguments. Note that at
643
+ # least one keyword argument is required. To specify no parameters, or to keep all
644
+ # the default parameter values, pass an empty Hash as a request object (see above).
645
+ #
604
646
  # @param parent [String]
605
647
  # Required. The resource name of the namespace whose services we'd
606
648
  # like to list.
@@ -636,7 +678,6 @@ module Google
636
678
  # @param order_by [String]
637
679
  # Optional. The order to list result by.
638
680
  #
639
- #
640
681
  # @yield [response, operation] Access the result along with the RPC operation
641
682
  # @yieldparam response [Gapic::PagedEnumerable<Google::Cloud::ServiceDirectory::V1beta1::Service>]
642
683
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -687,16 +728,23 @@ module Google
687
728
  # Gets a service.
688
729
  #
689
730
  # @overload get_service(request, options = nil)
690
- # @param request [Google::Cloud::ServiceDirectory::V1beta1::GetServiceRequest | Hash]
691
- # Gets a service.
731
+ # Pass arguments to `get_service` via a request object, either of type
732
+ # {Google::Cloud::ServiceDirectory::V1beta1::GetServiceRequest} or an equivalent Hash.
733
+ #
734
+ # @param request [Google::Cloud::ServiceDirectory::V1beta1::GetServiceRequest, Hash]
735
+ # A request object representing the call parameters. Required. To specify no
736
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
692
737
  # @param options [Gapic::CallOptions, Hash]
693
738
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
694
739
  #
695
740
  # @overload get_service(name: nil)
741
+ # Pass arguments to `get_service` via keyword arguments. Note that at
742
+ # least one keyword argument is required. To specify no parameters, or to keep all
743
+ # the default parameter values, pass an empty Hash as a request object (see above).
744
+ #
696
745
  # @param name [String]
697
746
  # Required. The name of the service to get.
698
747
  #
699
- #
700
748
  # @yield [response, operation] Access the result along with the RPC operation
701
749
  # @yieldparam response [Google::Cloud::ServiceDirectory::V1beta1::Service]
702
750
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -746,18 +794,25 @@ module Google
746
794
  # Updates a service.
747
795
  #
748
796
  # @overload update_service(request, options = nil)
749
- # @param request [Google::Cloud::ServiceDirectory::V1beta1::UpdateServiceRequest | Hash]
750
- # Updates a service.
797
+ # Pass arguments to `update_service` via a request object, either of type
798
+ # {Google::Cloud::ServiceDirectory::V1beta1::UpdateServiceRequest} or an equivalent Hash.
799
+ #
800
+ # @param request [Google::Cloud::ServiceDirectory::V1beta1::UpdateServiceRequest, Hash]
801
+ # A request object representing the call parameters. Required. To specify no
802
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
751
803
  # @param options [Gapic::CallOptions, Hash]
752
804
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
753
805
  #
754
806
  # @overload update_service(service: nil, update_mask: nil)
755
- # @param service [Google::Cloud::ServiceDirectory::V1beta1::Service | Hash]
807
+ # Pass arguments to `update_service` via keyword arguments. Note that at
808
+ # least one keyword argument is required. To specify no parameters, or to keep all
809
+ # the default parameter values, pass an empty Hash as a request object (see above).
810
+ #
811
+ # @param service [Google::Cloud::ServiceDirectory::V1beta1::Service, Hash]
756
812
  # Required. The updated service.
757
- # @param update_mask [Google::Protobuf::FieldMask | Hash]
813
+ # @param update_mask [Google::Protobuf::FieldMask, Hash]
758
814
  # Required. List of fields to be updated in this request.
759
815
  #
760
- #
761
816
  # @yield [response, operation] Access the result along with the RPC operation
762
817
  # @yieldparam response [Google::Cloud::ServiceDirectory::V1beta1::Service]
763
818
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -808,17 +863,23 @@ module Google
808
863
  # the service.
809
864
  #
810
865
  # @overload delete_service(request, options = nil)
811
- # @param request [Google::Cloud::ServiceDirectory::V1beta1::DeleteServiceRequest | Hash]
812
- # Deletes a service. This also deletes all endpoints associated with
813
- # the service.
866
+ # Pass arguments to `delete_service` via a request object, either of type
867
+ # {Google::Cloud::ServiceDirectory::V1beta1::DeleteServiceRequest} or an equivalent Hash.
868
+ #
869
+ # @param request [Google::Cloud::ServiceDirectory::V1beta1::DeleteServiceRequest, Hash]
870
+ # A request object representing the call parameters. Required. To specify no
871
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
814
872
  # @param options [Gapic::CallOptions, Hash]
815
873
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
816
874
  #
817
875
  # @overload delete_service(name: nil)
876
+ # Pass arguments to `delete_service` via keyword arguments. Note that at
877
+ # least one keyword argument is required. To specify no parameters, or to keep all
878
+ # the default parameter values, pass an empty Hash as a request object (see above).
879
+ #
818
880
  # @param name [String]
819
881
  # Required. The name of the service to delete.
820
882
  #
821
- #
822
883
  # @yield [response, operation] Access the result along with the RPC operation
823
884
  # @yieldparam response [Google::Protobuf::Empty]
824
885
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -868,12 +929,20 @@ module Google
868
929
  # Creates a endpoint, and returns the new Endpoint.
869
930
  #
870
931
  # @overload create_endpoint(request, options = nil)
871
- # @param request [Google::Cloud::ServiceDirectory::V1beta1::CreateEndpointRequest | Hash]
872
- # Creates a endpoint, and returns the new Endpoint.
932
+ # Pass arguments to `create_endpoint` via a request object, either of type
933
+ # {Google::Cloud::ServiceDirectory::V1beta1::CreateEndpointRequest} or an equivalent Hash.
934
+ #
935
+ # @param request [Google::Cloud::ServiceDirectory::V1beta1::CreateEndpointRequest, Hash]
936
+ # A request object representing the call parameters. Required. To specify no
937
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
873
938
  # @param options [Gapic::CallOptions, Hash]
874
939
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
875
940
  #
876
941
  # @overload create_endpoint(parent: nil, endpoint_id: nil, endpoint: nil)
942
+ # Pass arguments to `create_endpoint` via keyword arguments. Note that at
943
+ # least one keyword argument is required. To specify no parameters, or to keep all
944
+ # the default parameter values, pass an empty Hash as a request object (see above).
945
+ #
877
946
  # @param parent [String]
878
947
  # Required. The resource name of the service that this endpoint provides.
879
948
  # @param endpoint_id [String]
@@ -884,10 +953,9 @@ module Google
884
953
  # character must be a lowercase letter, and all following characters must
885
954
  # be a dash, lowercase letter, or digit, except the last character, which
886
955
  # cannot be a dash.
887
- # @param endpoint [Google::Cloud::ServiceDirectory::V1beta1::Endpoint | Hash]
956
+ # @param endpoint [Google::Cloud::ServiceDirectory::V1beta1::Endpoint, Hash]
888
957
  # Required. A endpoint with initial fields set.
889
958
  #
890
- #
891
959
  # @yield [response, operation] Access the result along with the RPC operation
892
960
  # @yieldparam response [Google::Cloud::ServiceDirectory::V1beta1::Endpoint]
893
961
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -937,12 +1005,20 @@ module Google
937
1005
  # Lists all endpoints.
938
1006
  #
939
1007
  # @overload list_endpoints(request, options = nil)
940
- # @param request [Google::Cloud::ServiceDirectory::V1beta1::ListEndpointsRequest | Hash]
941
- # Lists all endpoints.
1008
+ # Pass arguments to `list_endpoints` via a request object, either of type
1009
+ # {Google::Cloud::ServiceDirectory::V1beta1::ListEndpointsRequest} or an equivalent Hash.
1010
+ #
1011
+ # @param request [Google::Cloud::ServiceDirectory::V1beta1::ListEndpointsRequest, Hash]
1012
+ # A request object representing the call parameters. Required. To specify no
1013
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
942
1014
  # @param options [Gapic::CallOptions, Hash]
943
1015
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
944
1016
  #
945
1017
  # @overload list_endpoints(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil)
1018
+ # Pass arguments to `list_endpoints` via keyword arguments. Note that at
1019
+ # least one keyword argument is required. To specify no parameters, or to keep all
1020
+ # the default parameter values, pass an empty Hash as a request object (see above).
1021
+ #
946
1022
  # @param parent [String]
947
1023
  # Required. The resource name of the service whose endpoints we'd like to
948
1024
  # list.
@@ -980,7 +1056,6 @@ module Google
980
1056
  # @param order_by [String]
981
1057
  # Optional. The order to list result by.
982
1058
  #
983
- #
984
1059
  # @yield [response, operation] Access the result along with the RPC operation
985
1060
  # @yieldparam response [Gapic::PagedEnumerable<Google::Cloud::ServiceDirectory::V1beta1::Endpoint>]
986
1061
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -1031,16 +1106,23 @@ module Google
1031
1106
  # Gets a endpoint.
1032
1107
  #
1033
1108
  # @overload get_endpoint(request, options = nil)
1034
- # @param request [Google::Cloud::ServiceDirectory::V1beta1::GetEndpointRequest | Hash]
1035
- # Gets a endpoint.
1109
+ # Pass arguments to `get_endpoint` via a request object, either of type
1110
+ # {Google::Cloud::ServiceDirectory::V1beta1::GetEndpointRequest} or an equivalent Hash.
1111
+ #
1112
+ # @param request [Google::Cloud::ServiceDirectory::V1beta1::GetEndpointRequest, Hash]
1113
+ # A request object representing the call parameters. Required. To specify no
1114
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1036
1115
  # @param options [Gapic::CallOptions, Hash]
1037
1116
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1038
1117
  #
1039
1118
  # @overload get_endpoint(name: nil)
1119
+ # Pass arguments to `get_endpoint` via keyword arguments. Note that at
1120
+ # least one keyword argument is required. To specify no parameters, or to keep all
1121
+ # the default parameter values, pass an empty Hash as a request object (see above).
1122
+ #
1040
1123
  # @param name [String]
1041
1124
  # Required. The name of the endpoint to get.
1042
1125
  #
1043
- #
1044
1126
  # @yield [response, operation] Access the result along with the RPC operation
1045
1127
  # @yieldparam response [Google::Cloud::ServiceDirectory::V1beta1::Endpoint]
1046
1128
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -1090,18 +1172,25 @@ module Google
1090
1172
  # Updates a endpoint.
1091
1173
  #
1092
1174
  # @overload update_endpoint(request, options = nil)
1093
- # @param request [Google::Cloud::ServiceDirectory::V1beta1::UpdateEndpointRequest | Hash]
1094
- # Updates a endpoint.
1175
+ # Pass arguments to `update_endpoint` via a request object, either of type
1176
+ # {Google::Cloud::ServiceDirectory::V1beta1::UpdateEndpointRequest} or an equivalent Hash.
1177
+ #
1178
+ # @param request [Google::Cloud::ServiceDirectory::V1beta1::UpdateEndpointRequest, Hash]
1179
+ # A request object representing the call parameters. Required. To specify no
1180
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1095
1181
  # @param options [Gapic::CallOptions, Hash]
1096
1182
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1097
1183
  #
1098
1184
  # @overload update_endpoint(endpoint: nil, update_mask: nil)
1099
- # @param endpoint [Google::Cloud::ServiceDirectory::V1beta1::Endpoint | Hash]
1185
+ # Pass arguments to `update_endpoint` via keyword arguments. Note that at
1186
+ # least one keyword argument is required. To specify no parameters, or to keep all
1187
+ # the default parameter values, pass an empty Hash as a request object (see above).
1188
+ #
1189
+ # @param endpoint [Google::Cloud::ServiceDirectory::V1beta1::Endpoint, Hash]
1100
1190
  # Required. The updated endpoint.
1101
- # @param update_mask [Google::Protobuf::FieldMask | Hash]
1191
+ # @param update_mask [Google::Protobuf::FieldMask, Hash]
1102
1192
  # Required. List of fields to be updated in this request.
1103
1193
  #
1104
- #
1105
1194
  # @yield [response, operation] Access the result along with the RPC operation
1106
1195
  # @yieldparam response [Google::Cloud::ServiceDirectory::V1beta1::Endpoint]
1107
1196
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -1151,16 +1240,23 @@ module Google
1151
1240
  # Deletes a endpoint.
1152
1241
  #
1153
1242
  # @overload delete_endpoint(request, options = nil)
1154
- # @param request [Google::Cloud::ServiceDirectory::V1beta1::DeleteEndpointRequest | Hash]
1155
- # Deletes a endpoint.
1243
+ # Pass arguments to `delete_endpoint` via a request object, either of type
1244
+ # {Google::Cloud::ServiceDirectory::V1beta1::DeleteEndpointRequest} or an equivalent Hash.
1245
+ #
1246
+ # @param request [Google::Cloud::ServiceDirectory::V1beta1::DeleteEndpointRequest, Hash]
1247
+ # A request object representing the call parameters. Required. To specify no
1248
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1156
1249
  # @param options [Gapic::CallOptions, Hash]
1157
1250
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1158
1251
  #
1159
1252
  # @overload delete_endpoint(name: nil)
1253
+ # Pass arguments to `delete_endpoint` via keyword arguments. Note that at
1254
+ # least one keyword argument is required. To specify no parameters, or to keep all
1255
+ # the default parameter values, pass an empty Hash as a request object (see above).
1256
+ #
1160
1257
  # @param name [String]
1161
1258
  # Required. The name of the endpoint to delete.
1162
1259
  #
1163
- #
1164
1260
  # @yield [response, operation] Access the result along with the RPC operation
1165
1261
  # @yieldparam response [Google::Protobuf::Empty]
1166
1262
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -1210,17 +1306,26 @@ module Google
1210
1306
  # Gets the IAM Policy for a resource (namespace or service only).
1211
1307
  #
1212
1308
  # @overload get_iam_policy(request, options = nil)
1213
- # @param request [Google::Iam::V1::GetIamPolicyRequest | Hash]
1214
- # Gets the IAM Policy for a resource (namespace or service only).
1309
+ # Pass arguments to `get_iam_policy` via a request object, either of type
1310
+ # {Google::Iam::V1::GetIamPolicyRequest} or an equivalent Hash.
1311
+ #
1312
+ # @param request [Google::Iam::V1::GetIamPolicyRequest, Hash]
1313
+ # A request object representing the call parameters. Required. To specify no
1314
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1215
1315
  # @param options [Gapic::CallOptions, Hash]
1216
1316
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1217
1317
  #
1218
- # @overload get_iam_policy(resource: nil)
1318
+ # @overload get_iam_policy(resource: nil, options: nil)
1319
+ # Pass arguments to `get_iam_policy` via keyword arguments. Note that at
1320
+ # least one keyword argument is required. To specify no parameters, or to keep all
1321
+ # the default parameter values, pass an empty Hash as a request object (see above).
1322
+ #
1219
1323
  # @param resource [String]
1220
1324
  # REQUIRED: The resource for which the policy is being requested.
1221
- # `resource` is usually specified as a path. For example, a Project
1222
- # resource is specified as `projects/{project}`.
1223
- #
1325
+ # See the operation documentation for the appropriate value for this field.
1326
+ # @param options [Google::Iam::V1::GetPolicyOptions, Hash]
1327
+ # OPTIONAL: A `GetPolicyOptions` object for specifying options to
1328
+ # `GetIamPolicy`. This field is only used by Cloud IAM.
1224
1329
  #
1225
1330
  # @yield [response, operation] Access the result along with the RPC operation
1226
1331
  # @yieldparam response [Google::Iam::V1::Policy]
@@ -1271,23 +1376,29 @@ module Google
1271
1376
  # Sets the IAM Policy for a resource (namespace or service only).
1272
1377
  #
1273
1378
  # @overload set_iam_policy(request, options = nil)
1274
- # @param request [Google::Iam::V1::SetIamPolicyRequest | Hash]
1275
- # Sets the IAM Policy for a resource (namespace or service only).
1379
+ # Pass arguments to `set_iam_policy` via a request object, either of type
1380
+ # {Google::Iam::V1::SetIamPolicyRequest} or an equivalent Hash.
1381
+ #
1382
+ # @param request [Google::Iam::V1::SetIamPolicyRequest, Hash]
1383
+ # A request object representing the call parameters. Required. To specify no
1384
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1276
1385
  # @param options [Gapic::CallOptions, Hash]
1277
1386
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1278
1387
  #
1279
1388
  # @overload set_iam_policy(resource: nil, policy: nil)
1389
+ # Pass arguments to `set_iam_policy` via keyword arguments. Note that at
1390
+ # least one keyword argument is required. To specify no parameters, or to keep all
1391
+ # the default parameter values, pass an empty Hash as a request object (see above).
1392
+ #
1280
1393
  # @param resource [String]
1281
1394
  # REQUIRED: The resource for which the policy is being specified.
1282
- # `resource` is usually specified as a path. For example, a Project
1283
- # resource is specified as `projects/{project}`.
1284
- # @param policy [Google::Iam::V1::Policy | Hash]
1395
+ # See the operation documentation for the appropriate value for this field.
1396
+ # @param policy [Google::Iam::V1::Policy, Hash]
1285
1397
  # REQUIRED: The complete policy to be applied to the `resource`. The size of
1286
1398
  # the policy is limited to a few 10s of KB. An empty policy is a
1287
1399
  # valid policy but certain Cloud Platform services (such as Projects)
1288
1400
  # might reject them.
1289
1401
  #
1290
- #
1291
1402
  # @yield [response, operation] Access the result along with the RPC operation
1292
1403
  # @yieldparam response [Google::Iam::V1::Policy]
1293
1404
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -1337,23 +1448,29 @@ module Google
1337
1448
  # Tests IAM permissions for a resource (namespace or service only).
1338
1449
  #
1339
1450
  # @overload test_iam_permissions(request, options = nil)
1340
- # @param request [Google::Iam::V1::TestIamPermissionsRequest | Hash]
1341
- # Tests IAM permissions for a resource (namespace or service only).
1451
+ # Pass arguments to `test_iam_permissions` via a request object, either of type
1452
+ # {Google::Iam::V1::TestIamPermissionsRequest} or an equivalent Hash.
1453
+ #
1454
+ # @param request [Google::Iam::V1::TestIamPermissionsRequest, Hash]
1455
+ # A request object representing the call parameters. Required. To specify no
1456
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1342
1457
  # @param options [Gapic::CallOptions, Hash]
1343
1458
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1344
1459
  #
1345
1460
  # @overload test_iam_permissions(resource: nil, permissions: nil)
1461
+ # Pass arguments to `test_iam_permissions` via keyword arguments. Note that at
1462
+ # least one keyword argument is required. To specify no parameters, or to keep all
1463
+ # the default parameter values, pass an empty Hash as a request object (see above).
1464
+ #
1346
1465
  # @param resource [String]
1347
1466
  # REQUIRED: The resource for which the policy detail is being requested.
1348
- # `resource` is usually specified as a path. For example, a Project
1349
- # resource is specified as `projects/{project}`.
1467
+ # See the operation documentation for the appropriate value for this field.
1350
1468
  # @param permissions [Array<String>]
1351
1469
  # The set of permissions to check for the `resource`. Permissions with
1352
1470
  # wildcards (such as '*' or 'storage.*') are not allowed. For more
1353
1471
  # information see
1354
1472
  # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
1355
1473
  #
1356
- #
1357
1474
  # @yield [response, operation] Access the result along with the RPC operation
1358
1475
  # @yieldparam response [Google::Iam::V1::TestIamPermissionsResponse]
1359
1476
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -1671,13 +1788,3 @@ module Google
1671
1788
  end
1672
1789
  end
1673
1790
  end
1674
-
1675
- # rubocop:disable Lint/HandleExceptions
1676
-
1677
- # Once client is loaded, load helpers.rb if it exists.
1678
- begin
1679
- require "google/cloud/service_directory/v1beta1/registration_service/helpers"
1680
- rescue LoadError
1681
- end
1682
-
1683
- # rubocop:enable Lint/HandleExceptions
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module ServiceDirectory
23
23
  module V1beta1
24
- VERSION = "0.2.1"
24
+ VERSION = "0.3.0"
25
25
  end
26
26
  end
27
27
  end
@@ -24,8 +24,7 @@ module Google
24
24
  # @!attribute [rw] resource
25
25
  # @return [String]
26
26
  # REQUIRED: The resource for which the policy is being specified.
27
- # `resource` is usually specified as a path. For example, a Project
28
- # resource is specified as `projects/{project}`.
27
+ # See the operation documentation for the appropriate value for this field.
29
28
  # @!attribute [rw] policy
30
29
  # @return [Google::Iam::V1::Policy]
31
30
  # REQUIRED: The complete policy to be applied to the `resource`. The size of
@@ -41,8 +40,11 @@ module Google
41
40
  # @!attribute [rw] resource
42
41
  # @return [String]
43
42
  # REQUIRED: The resource for which the policy is being requested.
44
- # `resource` is usually specified as a path. For example, a Project
45
- # resource is specified as `projects/{project}`.
43
+ # See the operation documentation for the appropriate value for this field.
44
+ # @!attribute [rw] options
45
+ # @return [Google::Iam::V1::GetPolicyOptions]
46
+ # OPTIONAL: A `GetPolicyOptions` object for specifying options to
47
+ # `GetIamPolicy`. This field is only used by Cloud IAM.
46
48
  class GetIamPolicyRequest
47
49
  include Google::Protobuf::MessageExts
48
50
  extend Google::Protobuf::MessageExts::ClassMethods
@@ -52,8 +54,7 @@ module Google
52
54
  # @!attribute [rw] resource
53
55
  # @return [String]
54
56
  # REQUIRED: The resource for which the policy detail is being requested.
55
- # `resource` is usually specified as a path. For example, a Project
56
- # resource is specified as `projects/{project}`.
57
+ # See the operation documentation for the appropriate value for this field.
57
58
  # @!attribute [rw] permissions
58
59
  # @return [Array<String>]
59
60
  # The set of permissions to check for the `resource`. Permissions with
@@ -0,0 +1,40 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2020 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Iam
22
+ module V1
23
+ # Encapsulates settings provided to GetIamPolicy.
24
+ # @!attribute [rw] requested_policy_version
25
+ # @return [Integer]
26
+ # Optional. The policy format version to be returned.
27
+ #
28
+ # Valid values are 0, 1, and 3. Requests specifying an invalid value will be
29
+ # rejected.
30
+ #
31
+ # Requests for policies with any conditional bindings must specify version 3.
32
+ # Policies without any conditional bindings may specify any valid value or
33
+ # leave the field unset.
34
+ class GetPolicyOptions
35
+ include Google::Protobuf::MessageExts
36
+ extend Google::Protobuf::MessageExts::ClassMethods
37
+ end
38
+ end
39
+ end
40
+ end
@@ -24,40 +24,79 @@ module Google
24
24
  # specify access control policies for Cloud Platform resources.
25
25
  #
26
26
  #
27
- # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
28
- # `members` to a `role`, where the members can be user accounts, Google groups,
29
- # Google domains, and service accounts. A `role` is a named list of permissions
30
- # defined by IAM.
27
+ # A `Policy` is a collection of `bindings`. A `binding` binds one or more
28
+ # `members` to a single `role`. Members can be user accounts, service accounts,
29
+ # Google groups, and domains (such as G Suite). A `role` is a named list of
30
+ # permissions (defined by IAM or configured by users). A `binding` can
31
+ # optionally specify a `condition`, which is a logic expression that further
32
+ # constrains the role binding based on attributes about the request and/or
33
+ # target resource.
31
34
  #
32
- # **Example**
35
+ # **JSON Example**
33
36
  #
34
37
  # {
35
38
  # "bindings": [
36
39
  # {
37
- # "role": "roles/owner",
40
+ # "role": "roles/resourcemanager.organizationAdmin",
38
41
  # "members": [
39
42
  # "user:mike@example.com",
40
43
  # "group:admins@example.com",
41
44
  # "domain:google.com",
42
- # "serviceAccount:my-other-app@appspot.gserviceaccount.com",
45
+ # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
43
46
  # ]
44
47
  # },
45
48
  # {
46
- # "role": "roles/viewer",
47
- # "members": ["user:sean@example.com"]
49
+ # "role": "roles/resourcemanager.organizationViewer",
50
+ # "members": ["user:eve@example.com"],
51
+ # "condition": {
52
+ # "title": "expirable access",
53
+ # "description": "Does not grant access after Sep 2020",
54
+ # "expression": "request.time <
55
+ # timestamp('2020-10-01T00:00:00.000Z')",
56
+ # }
48
57
  # }
49
58
  # ]
50
59
  # }
51
60
  #
61
+ # **YAML Example**
62
+ #
63
+ # bindings:
64
+ # - members:
65
+ # - user:mike@example.com
66
+ # - group:admins@example.com
67
+ # - domain:google.com
68
+ # - serviceAccount:my-project-id@appspot.gserviceaccount.com
69
+ # role: roles/resourcemanager.organizationAdmin
70
+ # - members:
71
+ # - user:eve@example.com
72
+ # role: roles/resourcemanager.organizationViewer
73
+ # condition:
74
+ # title: expirable access
75
+ # description: Does not grant access after Sep 2020
76
+ # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
77
+ #
52
78
  # For a description of IAM and its features, see the
53
- # [IAM developer's guide](https://cloud.google.com/iam).
79
+ # [IAM developer's guide](https://cloud.google.com/iam/docs).
54
80
  # @!attribute [rw] version
55
81
  # @return [Integer]
56
- # Version of the `Policy`. The default version is 0.
82
+ # Specifies the format of the policy.
83
+ #
84
+ # Valid values are 0, 1, and 3. Requests specifying an invalid value will be
85
+ # rejected.
86
+ #
87
+ # Operations affecting conditional bindings must specify version 3. This can
88
+ # be either setting a conditional policy, modifying a conditional binding,
89
+ # or removing a binding (conditional or unconditional) from the stored
90
+ # conditional policy.
91
+ # Operations on non-conditional policies may specify any valid value or
92
+ # leave the field unset.
93
+ #
94
+ # If no etag is provided in the call to `setIamPolicy`, version compliance
95
+ # checks against the stored policy is skipped.
57
96
  # @!attribute [rw] bindings
58
97
  # @return [Array<Google::Iam::V1::Binding>]
59
- # Associates a list of `members` to a `role`.
60
- # Multiple `bindings` must not be specified for the same `role`.
98
+ # Associates a list of `members` to a `role`. Optionally may specify a
99
+ # `condition` that determines when binding is in effect.
61
100
  # `bindings` with no members will result in an error.
62
101
  # @!attribute [rw] etag
63
102
  # @return [String]
@@ -70,7 +109,9 @@ module Google
70
109
  # ensure that their change will be applied to the same version of the policy.
71
110
  #
72
111
  # If no `etag` is provided in the call to `setIamPolicy`, then the existing
73
- # policy is overwritten blindly.
112
+ # policy is overwritten. Due to blind-set semantics of an etag-less policy,
113
+ # 'setIamPolicy' will not fail even if the incoming policy version does not
114
+ # meet the requirements for modifying the stored policy.
74
115
  class Policy
75
116
  include Google::Protobuf::MessageExts
76
117
  extend Google::Protobuf::MessageExts::ClassMethods
@@ -81,7 +122,6 @@ module Google
81
122
  # @return [String]
82
123
  # Role that is assigned to `members`.
83
124
  # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
84
- # Required
85
125
  # @!attribute [rw] members
86
126
  # @return [Array<String>]
87
127
  # Specifies the identities requesting access for a Cloud Platform resource.
@@ -94,7 +134,7 @@ module Google
94
134
  # who is authenticated with a Google account or a service account.
95
135
  #
96
136
  # * `user:{emailid}`: An email address that represents a specific Google
97
- # account. For example, `alice@gmail.com` or `joe@example.com`.
137
+ # account. For example, `alice@example.com` .
98
138
  #
99
139
  #
100
140
  # * `serviceAccount:{emailid}`: An email address that represents a service
@@ -103,8 +143,15 @@ module Google
103
143
  # * `group:{emailid}`: An email address that represents a Google group.
104
144
  # For example, `admins@example.com`.
105
145
  #
106
- # * `domain:{domain}`: A Google Apps domain name that represents all the
146
+ #
147
+ # * `domain:{domain}`: The G Suite domain (primary) that represents all the
107
148
  # users of that domain. For example, `google.com` or `example.com`.
149
+ # @!attribute [rw] condition
150
+ # @return [Google::Type::Expr]
151
+ # The condition that is associated with this binding.
152
+ # NOTE: An unsatisfied condition will not allow user access via current
153
+ # binding. Different bindings, including their conditions, are examined
154
+ # independently.
108
155
  class Binding
109
156
  include Google::Protobuf::MessageExts
110
157
  extend Google::Protobuf::MessageExts::ClassMethods
@@ -114,6 +161,9 @@ module Google
114
161
  # @!attribute [rw] binding_deltas
115
162
  # @return [Array<Google::Iam::V1::BindingDelta>]
116
163
  # The delta for Bindings between two policies.
164
+ # @!attribute [rw] audit_config_deltas
165
+ # @return [Array<Google::Iam::V1::AuditConfigDelta>]
166
+ # The delta for AuditConfigs between two policies.
117
167
  class PolicyDelta
118
168
  include Google::Protobuf::MessageExts
119
169
  extend Google::Protobuf::MessageExts::ClassMethods
@@ -135,6 +185,9 @@ module Google
135
185
  # A single identity requesting access for a Cloud Platform resource.
136
186
  # Follows the same format of Binding.members.
137
187
  # Required
188
+ # @!attribute [rw] condition
189
+ # @return [Google::Type::Expr]
190
+ # The condition that is associated with this binding.
138
191
  class BindingDelta
139
192
  include Google::Protobuf::MessageExts
140
193
  extend Google::Protobuf::MessageExts::ClassMethods
@@ -151,6 +204,45 @@ module Google
151
204
  REMOVE = 2
152
205
  end
153
206
  end
207
+
208
+ # One delta entry for AuditConfig. Each individual change (only one
209
+ # exempted_member in each entry) to a AuditConfig will be a separate entry.
210
+ # @!attribute [rw] action
211
+ # @return [Google::Iam::V1::AuditConfigDelta::Action]
212
+ # The action that was performed on an audit configuration in a policy.
213
+ # Required
214
+ # @!attribute [rw] service
215
+ # @return [String]
216
+ # Specifies a service that was configured for Cloud Audit Logging.
217
+ # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
218
+ # `allServices` is a special value that covers all services.
219
+ # Required
220
+ # @!attribute [rw] exempted_member
221
+ # @return [String]
222
+ # A single identity that is exempted from "data access" audit
223
+ # logging for the `service` specified above.
224
+ # Follows the same format of Binding.members.
225
+ # @!attribute [rw] log_type
226
+ # @return [String]
227
+ # Specifies the log_type that was be enabled. ADMIN_ACTIVITY is always
228
+ # enabled, and cannot be configured.
229
+ # Required
230
+ class AuditConfigDelta
231
+ include Google::Protobuf::MessageExts
232
+ extend Google::Protobuf::MessageExts::ClassMethods
233
+
234
+ # The type of action performed on an audit configuration in a policy.
235
+ module Action
236
+ # Unspecified.
237
+ ACTION_UNSPECIFIED = 0
238
+
239
+ # Addition of an audit configuration.
240
+ ADD = 1
241
+
242
+ # Removal of an audit configuration.
243
+ REMOVE = 2
244
+ end
245
+ end
154
246
  end
155
247
  end
156
248
  end
@@ -0,0 +1,52 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2020 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Type
22
+ # Represents an expression text. Example:
23
+ #
24
+ # title: "User account presence"
25
+ # description: "Determines whether the request has a user account"
26
+ # expression: "size(request.user) > 0"
27
+ # @!attribute [rw] expression
28
+ # @return [String]
29
+ # Textual representation of an expression in
30
+ # Common Expression Language syntax.
31
+ #
32
+ # The application context of the containing message determines which
33
+ # well-known feature set of CEL is supported.
34
+ # @!attribute [rw] title
35
+ # @return [String]
36
+ # An optional title for the expression, i.e. a short string describing
37
+ # its purpose. This can be used e.g. in UIs which allow to enter the
38
+ # expression.
39
+ # @!attribute [rw] description
40
+ # @return [String]
41
+ # An optional description of the expression. This is a longer text which
42
+ # describes the expression, e.g. when hovered over it in a UI.
43
+ # @!attribute [rw] location
44
+ # @return [String]
45
+ # An optional string indicating the location of the expression for error
46
+ # reporting, e.g. a file name and a position in the file.
47
+ class Expr
48
+ include Google::Protobuf::MessageExts
49
+ extend Google::Protobuf::MessageExts::ClassMethods
50
+ end
51
+ end
52
+ end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-service_directory-v1beta1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.1
4
+ version: 0.3.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-04-01 00:00:00.000000000 Z
11
+ date: 2020-04-14 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
@@ -42,16 +42,22 @@ dependencies:
42
42
  name: grpc-google-iam-v1
43
43
  requirement: !ruby/object:Gem::Requirement
44
44
  requirements:
45
- - - "~>"
45
+ - - ">="
46
+ - !ruby/object:Gem::Version
47
+ version: 0.6.10
48
+ - - "<"
46
49
  - !ruby/object:Gem::Version
47
- version: 0.6.9
50
+ version: '2.0'
48
51
  type: :runtime
49
52
  prerelease: false
50
53
  version_requirements: !ruby/object:Gem::Requirement
51
54
  requirements:
52
- - - "~>"
55
+ - - ">="
56
+ - !ruby/object:Gem::Version
57
+ version: 0.6.10
58
+ - - "<"
53
59
  - !ruby/object:Gem::Version
54
- version: 0.6.9
60
+ version: '2.0'
55
61
  - !ruby/object:Gem::Dependency
56
62
  name: google-style
57
63
  requirement: !ruby/object:Gem::Requirement
@@ -175,9 +181,11 @@ files:
175
181
  - proto_docs/google/cloud/servicedirectory/v1beta1/registration_service.rb
176
182
  - proto_docs/google/cloud/servicedirectory/v1beta1/service.rb
177
183
  - proto_docs/google/iam/v1/iam_policy.rb
184
+ - proto_docs/google/iam/v1/options.rb
178
185
  - proto_docs/google/iam/v1/policy.rb
179
186
  - proto_docs/google/protobuf/empty.rb
180
187
  - proto_docs/google/protobuf/field_mask.rb
188
+ - proto_docs/google/type/expr.rb
181
189
  homepage: https://github.com/googleapis/google-cloud-ruby
182
190
  licenses:
183
191
  - Apache-2.0