google-cloud-asset-v1 0.2.0 → 0.2.1

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: e4cf188086cd7f80f9cf6ac3cfd9087be5e9f1e3c99d561755f5c6be11964a4a
4
- data.tar.gz: ebf6196b50e1bfe2742f4f25cb56fc5f9f94a5ea0e7a7255b88c2da7ec64eb5d
3
+ metadata.gz: fbb4372d981825e8ce3c0a7f02a6fb309b80d5eb0461a19cfe96f6993582a5f1
4
+ data.tar.gz: 021a0bc123388102bae0d73a8c633af50850e73a4663db5096941e30cdbfc758
5
5
  SHA512:
6
- metadata.gz: 30c335c506ddcc5be42c1058459df6173be542f1b55b1484992ddc694b1d4417b945a8b210f45e2fe2601858090682588feec9c1d470ea666fa6945689d6c073
7
- data.tar.gz: d0b11a7c2f908675d474bb85099597e70f51b6a3f3d0cc2793dd3e936c57ad5ccff4ff9a6ce478c8be79b1116bd39a9ea2eab6666955db93886ad93f5c65cd3c
6
+ metadata.gz: 005d22cb6b6d3e92d266862a0e320a39693dd6c5a6fd2836a402c8e46a9af925b67a48e7078466634fd5230b639b643578d64667cbe91ca26d3bfcd0876da57d
7
+ data.tar.gz: b1e71821afea9caea0d4ab1e97cbb4c97cca95ae4f35d21fe3bd7e5c25c876e3e818b729b4a588c85d413c89cc6d0eef98af8744b40e9c6791034f1d505d3f20
data/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # Cloud Asset V1
1
+ # Ruby Client for the Cloud Asset V1 API
2
2
 
3
3
  API Client library for the Cloud Asset V1 API
4
4
 
@@ -12,6 +12,53 @@ https://github.com/googleapis/google-cloud-ruby
12
12
  $ gem install google-cloud-asset-v1
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/asset/v1"
27
+
28
+ client = Google::Cloud::Asset::V1::AssetService::Client.new
29
+ request = my_create_request
30
+ response = client.export_assets request
31
+ ```
32
+
33
+ View the [Client Library Documentation](https://googleapis.dev/ruby/google-cloud-asset-v1/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/asset/v1/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/asset/v1"
@@ -17,3 +17,19 @@
17
17
  # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
18
 
19
19
  require "google/cloud/asset/v1/asset_service"
20
+ require "google/cloud/asset/v1/version"
21
+
22
+ module Google
23
+ module Cloud
24
+ module Asset
25
+ ##
26
+ # To load this package, including all its services, and instantiate a client:
27
+ #
28
+ # require "google/cloud/asset/v1"
29
+ # client = Google::Cloud::Asset::V1::AssetService::Client.new
30
+ #
31
+ module V1
32
+ end
33
+ end
34
+ end
35
+ end
@@ -16,6 +16,35 @@
16
16
 
17
17
  # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
18
 
19
- require "google/cloud/asset/v1/asset_service/client"
20
- require "google/cloud/asset/v1/asset_service/operations"
19
+ require "gapic/common"
20
+ require "gapic/config"
21
+ require "gapic/config/method"
22
+
23
+ require "google/cloud/asset/v1/version"
24
+
21
25
  require "google/cloud/asset/v1/asset_service/credentials"
26
+ require "google/cloud/asset/v1/asset_service/paths"
27
+ require "google/cloud/asset/v1/asset_service/operations"
28
+ require "google/cloud/asset/v1/asset_service/client"
29
+
30
+ module Google
31
+ module Cloud
32
+ module Asset
33
+ module V1
34
+ ##
35
+ # Asset service definition.
36
+ #
37
+ # To load this service and instantiate a client:
38
+ #
39
+ # require "google/cloud/asset/v1/asset_service"
40
+ # client = Google::Cloud::Asset::V1::AssetService::Client.new
41
+ #
42
+ module AssetService
43
+ end
44
+ end
45
+ end
46
+ end
47
+ end
48
+
49
+ helper_path = ::File.join __dir__, "asset_service", "helpers.rb"
50
+ require "google/cloud/asset/v1/asset_service/helpers" if ::File.file? helper_path
@@ -16,16 +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/asset/v1/version"
25
20
  require "google/cloud/asset/v1/asset_service_pb"
26
- require "google/cloud/asset/v1/asset_service/credentials"
27
- require "google/cloud/asset/v1/asset_service/paths"
28
- require "google/cloud/asset/v1/asset_service/operations"
29
21
 
30
22
  module Google
31
23
  module Cloud
@@ -172,21 +164,26 @@ module Google
172
164
  # to keep track of the export.
173
165
  #
174
166
  # @overload export_assets(request, options = nil)
175
- # @param request [Google::Cloud::Asset::V1::ExportAssetsRequest | Hash]
176
- # Exports assets with time and resource types to a given Cloud Storage
177
- # location. The output format is newline-delimited JSON.
178
- # This API implements the {Google::Longrunning::Operation google.longrunning.Operation} API allowing you
179
- # to keep track of the export.
167
+ # Pass arguments to `export_assets` via a request object, either of type
168
+ # {Google::Cloud::Asset::V1::ExportAssetsRequest} or an equivalent Hash.
169
+ #
170
+ # @param request [Google::Cloud::Asset::V1::ExportAssetsRequest, Hash]
171
+ # A request object representing the call parameters. Required. To specify no
172
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
180
173
  # @param options [Gapic::CallOptions, Hash]
181
174
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
182
175
  #
183
176
  # @overload export_assets(parent: nil, read_time: nil, asset_types: nil, content_type: nil, output_config: nil)
177
+ # Pass arguments to `export_assets` via keyword arguments. Note that at
178
+ # least one keyword argument is required. To specify no parameters, or to keep all
179
+ # the default parameter values, pass an empty Hash as a request object (see above).
180
+ #
184
181
  # @param parent [String]
185
182
  # Required. The relative name of the root asset. This can only be an
186
183
  # organization number (such as "organizations/123"), a project ID (such as
187
184
  # "projects/my-project-id"), or a project number (such as "projects/12345"),
188
185
  # or a folder number (such as "folders/123").
189
- # @param read_time [Google::Protobuf::Timestamp | Hash]
186
+ # @param read_time [Google::Protobuf::Timestamp, Hash]
190
187
  # Timestamp to take an asset snapshot. This can only be set to a timestamp
191
188
  # between the current time and the current time minus 35 days (inclusive).
192
189
  # If not specified, the current time will be used. Due to delays in resource
@@ -201,11 +198,10 @@ module Google
201
198
  # @param content_type [Google::Cloud::Asset::V1::ContentType]
202
199
  # Asset content type. If not specified, no content but the asset name will be
203
200
  # returned.
204
- # @param output_config [Google::Cloud::Asset::V1::OutputConfig | Hash]
201
+ # @param output_config [Google::Cloud::Asset::V1::OutputConfig, Hash]
205
202
  # Required. Output configuration indicating where the results will be output
206
203
  # to. All results will be in newline delimited JSON format.
207
204
  #
208
- #
209
205
  # @yield [response, operation] Access the result along with the RPC operation
210
206
  # @yieldparam response [Gapic::Operation]
211
207
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -262,18 +258,20 @@ module Google
262
258
  # error.
263
259
  #
264
260
  # @overload batch_get_assets_history(request, options = nil)
265
- # @param request [Google::Cloud::Asset::V1::BatchGetAssetsHistoryRequest | Hash]
266
- # Batch gets the update history of assets that overlap a time window.
267
- # For RESOURCE content, this API outputs history with asset in both
268
- # non-delete or deleted status.
269
- # For IAM_POLICY content, this API outputs history when the asset and its
270
- # attached IAM POLICY both exist. This can create gaps in the output history.
271
- # If a specified asset does not exist, this API returns an INVALID_ARGUMENT
272
- # error.
261
+ # Pass arguments to `batch_get_assets_history` via a request object, either of type
262
+ # {Google::Cloud::Asset::V1::BatchGetAssetsHistoryRequest} or an equivalent Hash.
263
+ #
264
+ # @param request [Google::Cloud::Asset::V1::BatchGetAssetsHistoryRequest, Hash]
265
+ # A request object representing the call parameters. Required. To specify no
266
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
273
267
  # @param options [Gapic::CallOptions, Hash]
274
268
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
275
269
  #
276
270
  # @overload batch_get_assets_history(parent: nil, asset_names: nil, content_type: nil, read_time_window: nil)
271
+ # Pass arguments to `batch_get_assets_history` via keyword arguments. Note that at
272
+ # least one keyword argument is required. To specify no parameters, or to keep all
273
+ # the default parameter values, pass an empty Hash as a request object (see above).
274
+ #
277
275
  # @param parent [String]
278
276
  # Required. The relative name of the root asset. It can only be an
279
277
  # organization number (such as "organizations/123"), a project ID (such as
@@ -291,7 +289,7 @@ module Google
291
289
  # size of the asset name list is 100 in one request.
292
290
  # @param content_type [Google::Cloud::Asset::V1::ContentType]
293
291
  # Optional. The content type.
294
- # @param read_time_window [Google::Cloud::Asset::V1::TimeWindow | Hash]
292
+ # @param read_time_window [Google::Cloud::Asset::V1::TimeWindow, Hash]
295
293
  # Optional. The time window for the asset history. Both start_time and
296
294
  # end_time are optional and if set, it must be after the current time minus
297
295
  # 35 days. If end_time is not set, it is default to current timestamp.
@@ -299,7 +297,6 @@ module Google
299
297
  # returned. The returned results contain all temporal assets whose time
300
298
  # window overlap with read_time_window.
301
299
  #
302
- #
303
300
  # @yield [response, operation] Access the result along with the RPC operation
304
301
  # @yieldparam response [Google::Cloud::Asset::V1::BatchGetAssetsHistoryResponse]
305
302
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -350,13 +347,20 @@ module Google
350
347
  # asset updates.
351
348
  #
352
349
  # @overload create_feed(request, options = nil)
353
- # @param request [Google::Cloud::Asset::V1::CreateFeedRequest | Hash]
354
- # Creates a feed in a parent project/folder/organization to listen to its
355
- # asset updates.
350
+ # Pass arguments to `create_feed` via a request object, either of type
351
+ # {Google::Cloud::Asset::V1::CreateFeedRequest} or an equivalent Hash.
352
+ #
353
+ # @param request [Google::Cloud::Asset::V1::CreateFeedRequest, Hash]
354
+ # A request object representing the call parameters. Required. To specify no
355
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
356
356
  # @param options [Gapic::CallOptions, Hash]
357
357
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
358
358
  #
359
359
  # @overload create_feed(parent: nil, feed_id: nil, feed: nil)
360
+ # Pass arguments to `create_feed` via keyword arguments. Note that at
361
+ # least one keyword argument is required. To specify no parameters, or to keep all
362
+ # the default parameter values, pass an empty Hash as a request object (see above).
363
+ #
360
364
  # @param parent [String]
361
365
  # Required. The name of the project/folder/organization where this feed
362
366
  # should be created in. It can only be an organization number (such as
@@ -366,14 +370,13 @@ module Google
366
370
  # @param feed_id [String]
367
371
  # Required. This is the client-assigned asset feed identifier and it needs to
368
372
  # be unique under a specific parent project/folder/organization.
369
- # @param feed [Google::Cloud::Asset::V1::Feed | Hash]
373
+ # @param feed [Google::Cloud::Asset::V1::Feed, Hash]
370
374
  # Required. The feed details. The field `name` must be empty and it will be generated
371
375
  # in the format of:
372
376
  # projects/project_number/feeds/feed_id
373
377
  # folders/folder_number/feeds/feed_id
374
378
  # organizations/organization_number/feeds/feed_id
375
379
  #
376
- #
377
380
  # @yield [response, operation] Access the result along with the RPC operation
378
381
  # @yieldparam response [Google::Cloud::Asset::V1::Feed]
379
382
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -423,19 +426,26 @@ module Google
423
426
  # Gets details about an asset feed.
424
427
  #
425
428
  # @overload get_feed(request, options = nil)
426
- # @param request [Google::Cloud::Asset::V1::GetFeedRequest | Hash]
427
- # Gets details about an asset feed.
429
+ # Pass arguments to `get_feed` via a request object, either of type
430
+ # {Google::Cloud::Asset::V1::GetFeedRequest} or an equivalent Hash.
431
+ #
432
+ # @param request [Google::Cloud::Asset::V1::GetFeedRequest, Hash]
433
+ # A request object representing the call parameters. Required. To specify no
434
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
428
435
  # @param options [Gapic::CallOptions, Hash]
429
436
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
430
437
  #
431
438
  # @overload get_feed(name: nil)
439
+ # Pass arguments to `get_feed` via keyword arguments. Note that at
440
+ # least one keyword argument is required. To specify no parameters, or to keep all
441
+ # the default parameter values, pass an empty Hash as a request object (see above).
442
+ #
432
443
  # @param name [String]
433
444
  # Required. The name of the Feed and it must be in the format of:
434
445
  # projects/project_number/feeds/feed_id
435
446
  # folders/folder_number/feeds/feed_id
436
447
  # organizations/organization_number/feeds/feed_id
437
448
  #
438
- #
439
449
  # @yield [response, operation] Access the result along with the RPC operation
440
450
  # @yieldparam response [Google::Cloud::Asset::V1::Feed]
441
451
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -485,18 +495,25 @@ module Google
485
495
  # Lists all asset feeds in a parent project/folder/organization.
486
496
  #
487
497
  # @overload list_feeds(request, options = nil)
488
- # @param request [Google::Cloud::Asset::V1::ListFeedsRequest | Hash]
489
- # Lists all asset feeds in a parent project/folder/organization.
498
+ # Pass arguments to `list_feeds` via a request object, either of type
499
+ # {Google::Cloud::Asset::V1::ListFeedsRequest} or an equivalent Hash.
500
+ #
501
+ # @param request [Google::Cloud::Asset::V1::ListFeedsRequest, Hash]
502
+ # A request object representing the call parameters. Required. To specify no
503
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
490
504
  # @param options [Gapic::CallOptions, Hash]
491
505
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
492
506
  #
493
507
  # @overload list_feeds(parent: nil)
508
+ # Pass arguments to `list_feeds` via keyword arguments. Note that at
509
+ # least one keyword argument is required. To specify no parameters, or to keep all
510
+ # the default parameter values, pass an empty Hash as a request object (see above).
511
+ #
494
512
  # @param parent [String]
495
513
  # Required. The parent project/folder/organization whose feeds are to be
496
514
  # listed. It can only be using project/folder/organization number (such as
497
515
  # "folders/12345")", or a project ID (such as "projects/my-project-id").
498
516
  #
499
- #
500
517
  # @yield [response, operation] Access the result along with the RPC operation
501
518
  # @yieldparam response [Google::Cloud::Asset::V1::ListFeedsResponse]
502
519
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -546,24 +563,31 @@ module Google
546
563
  # Updates an asset feed configuration.
547
564
  #
548
565
  # @overload update_feed(request, options = nil)
549
- # @param request [Google::Cloud::Asset::V1::UpdateFeedRequest | Hash]
550
- # Updates an asset feed configuration.
566
+ # Pass arguments to `update_feed` via a request object, either of type
567
+ # {Google::Cloud::Asset::V1::UpdateFeedRequest} or an equivalent Hash.
568
+ #
569
+ # @param request [Google::Cloud::Asset::V1::UpdateFeedRequest, Hash]
570
+ # A request object representing the call parameters. Required. To specify no
571
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
551
572
  # @param options [Gapic::CallOptions, Hash]
552
573
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
553
574
  #
554
575
  # @overload update_feed(feed: nil, update_mask: nil)
555
- # @param feed [Google::Cloud::Asset::V1::Feed | Hash]
576
+ # Pass arguments to `update_feed` via keyword arguments. Note that at
577
+ # least one keyword argument is required. To specify no parameters, or to keep all
578
+ # the default parameter values, pass an empty Hash as a request object (see above).
579
+ #
580
+ # @param feed [Google::Cloud::Asset::V1::Feed, Hash]
556
581
  # Required. The new values of feed details. It must match an existing feed and the
557
582
  # field `name` must be in the format of:
558
583
  # projects/project_number/feeds/feed_id or
559
584
  # folders/folder_number/feeds/feed_id or
560
585
  # organizations/organization_number/feeds/feed_id.
561
- # @param update_mask [Google::Protobuf::FieldMask | Hash]
586
+ # @param update_mask [Google::Protobuf::FieldMask, Hash]
562
587
  # Required. Only updates the `feed` fields indicated by this mask.
563
588
  # The field mask must not be empty, and it must not contain fields that
564
589
  # are immutable or only set by the server.
565
590
  #
566
- #
567
591
  # @yield [response, operation] Access the result along with the RPC operation
568
592
  # @yieldparam response [Google::Cloud::Asset::V1::Feed]
569
593
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -613,19 +637,26 @@ module Google
613
637
  # Deletes an asset feed.
614
638
  #
615
639
  # @overload delete_feed(request, options = nil)
616
- # @param request [Google::Cloud::Asset::V1::DeleteFeedRequest | Hash]
617
- # Deletes an asset feed.
640
+ # Pass arguments to `delete_feed` via a request object, either of type
641
+ # {Google::Cloud::Asset::V1::DeleteFeedRequest} or an equivalent Hash.
642
+ #
643
+ # @param request [Google::Cloud::Asset::V1::DeleteFeedRequest, Hash]
644
+ # A request object representing the call parameters. Required. To specify no
645
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
618
646
  # @param options [Gapic::CallOptions, Hash]
619
647
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
620
648
  #
621
649
  # @overload delete_feed(name: nil)
650
+ # Pass arguments to `delete_feed` via keyword arguments. Note that at
651
+ # least one keyword argument is required. To specify no parameters, or to keep all
652
+ # the default parameter values, pass an empty Hash as a request object (see above).
653
+ #
622
654
  # @param name [String]
623
655
  # Required. The name of the feed and it must be in the format of:
624
656
  # projects/project_number/feeds/feed_id
625
657
  # folders/folder_number/feeds/feed_id
626
658
  # organizations/organization_number/feeds/feed_id
627
659
  #
628
- #
629
660
  # @yield [response, operation] Access the result along with the RPC operation
630
661
  # @yieldparam response [Google::Protobuf::Empty]
631
662
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -866,13 +897,3 @@ module Google
866
897
  end
867
898
  end
868
899
  end
869
-
870
- # rubocop:disable Lint/HandleExceptions
871
-
872
- # Once client is loaded, load helpers.rb if it exists.
873
- begin
874
- require "google/cloud/asset/v1/asset_service/helpers"
875
- rescue LoadError
876
- end
877
-
878
- # rubocop:enable Lint/HandleExceptions
@@ -16,11 +16,7 @@
16
16
 
17
17
  # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
18
 
19
- require "gapic/common"
20
19
  require "gapic/operation"
21
-
22
- require "google/cloud/asset/v1/version"
23
- require "google/cloud/asset/v1/asset_service/client"
24
20
  require "google/longrunning/operations_pb"
25
21
 
26
22
  module Google
@@ -109,16 +105,20 @@ module Google
109
105
  # to use different resource name schemes, such as `users/*/operations`.
110
106
  #
111
107
  # @overload list_operations(request, options = nil)
112
- # @param request [Google::Longrunning::ListOperationsRequest | Hash]
113
- # Lists operations that match the specified filter in the request. If the
114
- # server doesn't support this method, it returns `UNIMPLEMENTED`.
108
+ # Pass arguments to `list_operations` via a request object, either of type
109
+ # {Google::Longrunning::ListOperationsRequest} or an equivalent Hash.
115
110
  #
116
- # NOTE: the `name` binding below allows API services to override the binding
117
- # to use different resource name schemes, such as `users/*/operations`.
111
+ # @param request [Google::Longrunning::ListOperationsRequest, Hash]
112
+ # A request object representing the call parameters. Required. To specify no
113
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
118
114
  # @param options [Gapic::CallOptions, Hash]
119
115
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
120
116
  #
121
117
  # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil)
118
+ # Pass arguments to `list_operations` via keyword arguments. Note that at
119
+ # least one keyword argument is required. To specify no parameters, or to keep all
120
+ # the default parameter values, pass an empty Hash as a request object (see above).
121
+ #
122
122
  # @param name [String]
123
123
  # The name of the operation collection.
124
124
  # @param filter [String]
@@ -128,7 +128,6 @@ module Google
128
128
  # @param page_token [String]
129
129
  # The standard list page token.
130
130
  #
131
- #
132
131
  # @yield [response, operation] Access the result along with the RPC operation
133
132
  # @yieldparam response [Gapic::PagedEnumerable<Gapic::Operation>]
134
133
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -182,18 +181,23 @@ module Google
182
181
  # service.
183
182
  #
184
183
  # @overload get_operation(request, options = nil)
185
- # @param request [Google::Longrunning::GetOperationRequest | Hash]
186
- # Gets the latest state of a long-running operation. Clients can use this
187
- # method to poll the operation result at intervals as recommended by the API
188
- # service.
184
+ # Pass arguments to `get_operation` via a request object, either of type
185
+ # {Google::Longrunning::GetOperationRequest} or an equivalent Hash.
186
+ #
187
+ # @param request [Google::Longrunning::GetOperationRequest, Hash]
188
+ # A request object representing the call parameters. Required. To specify no
189
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
189
190
  # @param options [Gapic::CallOptions, Hash]
190
191
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
191
192
  #
192
193
  # @overload get_operation(name: nil)
194
+ # Pass arguments to `get_operation` via keyword arguments. Note that at
195
+ # least one keyword argument is required. To specify no parameters, or to keep all
196
+ # the default parameter values, pass an empty Hash as a request object (see above).
197
+ #
193
198
  # @param name [String]
194
199
  # The name of the operation resource.
195
200
  #
196
- #
197
201
  # @yield [response, operation] Access the result along with the RPC operation
198
202
  # @yieldparam response [Gapic::Operation]
199
203
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -247,19 +251,23 @@ module Google
247
251
  # `google.rpc.Code.UNIMPLEMENTED`.
248
252
  #
249
253
  # @overload delete_operation(request, options = nil)
250
- # @param request [Google::Longrunning::DeleteOperationRequest | Hash]
251
- # Deletes a long-running operation. This method indicates that the client is
252
- # no longer interested in the operation result. It does not cancel the
253
- # operation. If the server doesn't support this method, it returns
254
- # `google.rpc.Code.UNIMPLEMENTED`.
254
+ # Pass arguments to `delete_operation` via a request object, either of type
255
+ # {Google::Longrunning::DeleteOperationRequest} or an equivalent Hash.
256
+ #
257
+ # @param request [Google::Longrunning::DeleteOperationRequest, Hash]
258
+ # A request object representing the call parameters. Required. To specify no
259
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
255
260
  # @param options [Gapic::CallOptions, Hash]
256
261
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
257
262
  #
258
263
  # @overload delete_operation(name: nil)
264
+ # Pass arguments to `delete_operation` via keyword arguments. Note that at
265
+ # least one keyword argument is required. To specify no parameters, or to keep all
266
+ # the default parameter values, pass an empty Hash as a request object (see above).
267
+ #
259
268
  # @param name [String]
260
269
  # The name of the operation resource to be deleted.
261
270
  #
262
- #
263
271
  # @yield [response, operation] Access the result along with the RPC operation
264
272
  # @yieldparam response [Google::Protobuf::Empty]
265
273
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -318,25 +326,23 @@ module Google
318
326
  # corresponding to `Code.CANCELLED`.
319
327
  #
320
328
  # @overload cancel_operation(request, options = nil)
321
- # @param request [Google::Longrunning::CancelOperationRequest | Hash]
322
- # Starts asynchronous cancellation on a long-running operation. The server
323
- # makes a best effort to cancel the operation, but success is not
324
- # guaranteed. If the server doesn't support this method, it returns
325
- # `google.rpc.Code.UNIMPLEMENTED`. Clients can use
326
- # Operations.GetOperation or
327
- # other methods to check whether the cancellation succeeded or whether the
328
- # operation completed despite cancellation. On successful cancellation,
329
- # the operation is not deleted; instead, it becomes an operation with
330
- # an {Google::Longrunning::Operation#error Operation.error} value with a {Google::Rpc::Status#code google.rpc.Status.code} of 1,
331
- # corresponding to `Code.CANCELLED`.
329
+ # Pass arguments to `cancel_operation` via a request object, either of type
330
+ # {Google::Longrunning::CancelOperationRequest} or an equivalent Hash.
331
+ #
332
+ # @param request [Google::Longrunning::CancelOperationRequest, Hash]
333
+ # A request object representing the call parameters. Required. To specify no
334
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
332
335
  # @param options [Gapic::CallOptions, Hash]
333
336
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
334
337
  #
335
338
  # @overload cancel_operation(name: nil)
339
+ # Pass arguments to `cancel_operation` via keyword arguments. Note that at
340
+ # least one keyword argument is required. To specify no parameters, or to keep all
341
+ # the default parameter values, pass an empty Hash as a request object (see above).
342
+ #
336
343
  # @param name [String]
337
344
  # The name of the operation resource to be cancelled.
338
345
  #
339
- #
340
346
  # @yield [response, operation] Access the result along with the RPC operation
341
347
  # @yieldparam response [Google::Protobuf::Empty]
342
348
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Asset
23
23
  module V1
24
- VERSION = "0.2.0"
24
+ VERSION = "0.2.1"
25
25
  end
26
26
  end
27
27
  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
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-asset-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.0
4
+ version: 0.2.1
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-02 00:00:00.000000000 Z
11
+ date: 2020-04-13 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