google-cloud-asset-v1 0.17.1 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1cd6a10198e7c8942faca2e416d6bc3c449f7b4fc159f0705e00a169066c3c34
-  data.tar.gz: 18089d8f4e01d9b022aa623189c4b3f78f62a6bd2583f9e15bc6a3ae581f8538
+  metadata.gz: bb87f312f0649e08fc189ce1185589c939c2feb882acea539a06aa3045ba8107
+  data.tar.gz: 0df3f4f6144da7524fcdca365682ce57dd2542fbdfb19b033b0ef6af3e9539f5
 SHA512:
-  metadata.gz: c9fe6cf47912dd3e42dfddbd150e1215c338d68eeb54655ec8f4d1db2d6ebbcb7cf15c5cd02cd9db3259b5454b69ac80e8633bc8c9bde358ea29fd0f90627b81
-  data.tar.gz: ee9126e92de46728147734b0aa925f554c2330a0c1b5e601ac00a3ab5f4ffe87d2b258acea008ad9a7a46dc1f8e9d2ddb27dc7a83c01066a9f298d1fb336ffc7
+  metadata.gz: 92639139d95fce94242059edc246e04c13e29f30a3a166e93c70d205228f33a8a6c91ed370d22a9de281d331d457f7132dc048cc1baaac5e43d3bff06a9bc2b5
+  data.tar.gz: 8385d7723fa7f9ab8bdba5a3da3ded075d91c9811f109b420f0e4b1f01ff732d37d2e4c02d3b19e266d52d7db74c14419c41303b27eaaf3b7bfcf1a8acc4ab87

data/.yardopts

@@ -1,5 +1,5 @@
 --no-private
---title=Cloud Asset V1 API
+--title="Cloud Asset V1 API"
 --exclude _pb\.rb$
 --markup markdown
 --markup-provider redcarpet

data/AUTHENTICATION.md

@@ -120,15 +120,6 @@ To configure your system for this, simply:
 **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
 *should* only be used during development.
 
-[gce-how-to]: https://cloud.google.com/compute/docs/authentication#using
-[dev-console]: https://console.cloud.google.com/project
-
-[enable-apis]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/enable-apis.png
-
-[create-new-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account.png
-[create-new-service-account-existing-keys]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account-existing-keys.png
-[reuse-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/reuse-service-account.png
-
 ## Creating a Service Account
 
 Google Cloud requires **Service Account Credentials** to
@@ -139,31 +130,22 @@ If you are not running this client within
 [Google Cloud Platform environments](#google-cloud-platform-environments), you
 need a Google Developers service account.
 
-1. Visit the [Google Developers Console][dev-console].
+1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
 2. Create a new project or click on an existing project.
-3. Activate the slide-out navigation tray and select **API Manager**. From
+3. Activate the menu in the upper left and select **APIs & Services**. From
    here, you will enable the APIs that your application requires.
 
-   ![Enable the APIs that your application requires][enable-apis]
-
    *Note: You may need to enable billing in order to use these services.*
 
 4. Select **Credentials** from the side navigation.
 
-   You should see a screen like one of the following.
-
-   ![Create a new service account][create-new-service-account]
-
-   ![Create a new service account With Existing Keys][create-new-service-account-existing-keys]
-
-   Find the "Add credentials" drop down and select "Service account" to be
-   guided through downloading a new JSON key file.
+   Find the "Create credentials" drop down near the top of the page, and select
+   "Service account" to be guided through downloading a new JSON key file.
 
    If you want to re-use an existing service account, you can easily generate a
-   new key file. Just select the account you wish to re-use, and click "Generate
-   new JSON key":
-
-   ![Re-use an existing service account][reuse-service-account]
+   new key file. Just select the account you wish to re-use, click the pencil
+   tool on the right side to edit the service account, select the **Keys** tab,
+   and then select **Add Key**.
 
    The key file you download will be used by this library to authenticate API
    requests and should be stored in a secure location.

data/README.md

@@ -37,7 +37,7 @@ request = ::Google::Cloud::Asset::V1::ExportAssetsRequest.new # (request fields
 response = client.export_assets request
 ```
 
-View the [Client Library Documentation](https://googleapis.dev/ruby/google-cloud-asset-v1/latest)
+View the [Client Library Documentation](https://cloud.google.com/ruby/docs/reference/google-cloud-asset-v1/latest)
 for class and method documentation.
 
 See also the [Product Documentation](https://cloud.google.com/asset-inventory/)

data/lib/google/cloud/asset/v1/asset_service/client.rb

@@ -183,6 +183,7 @@ module Google
 
               @operations_client = Operations.new do |config|
                 config.credentials = credentials
+                config.quota_project = @quota_project_id
                 config.endpoint = @config.endpoint
               end
 
@@ -291,6 +292,28 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/asset/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Asset::V1::AssetService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Asset::V1::ExportAssetsRequest.new
+            #
+            #   # Call the export_assets method.
+            #   result = client.export_assets request
+            #
+            #   # The returned object is of type Gapic::Operation. You can use this
+            #   # object to check the status of an operation, cancel it, or wait
+            #   # for results. Here is how to block until completion:
+            #   result.wait_until_done! timeout: 60
+            #   if result.response?
+            #     p result.response
+            #   else
+            #     puts "Error!"
+            #   end
+            #
             def export_assets request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -308,9 +331,11 @@ module Google
                 gapic_version: ::Google::Cloud::Asset::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "parent" => request.parent
-              }
+              header_params = {}
+              if request.parent
+                header_params["parent"] = request.parent
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -415,6 +440,27 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/asset/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Asset::V1::AssetService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Asset::V1::ListAssetsRequest.new
+            #
+            #   # Call the list_assets method.
+            #   result = client.list_assets request
+            #
+            #   # The returned object is of type Gapic::PagedEnumerable. You can
+            #   # iterate over all elements by calling #each, and the enumerable
+            #   # will lazily make API calls to fetch subsequent pages. Other
+            #   # methods are also available for managing paging directly.
+            #   result.each do |response|
+            #     # Each element is of type ::Google::Cloud::Asset::V1::Asset.
+            #     p response
+            #   end
+            #
             def list_assets request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -432,9 +478,11 @@ module Google
                 gapic_version: ::Google::Cloud::Asset::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "parent" => request.parent
-              }
+              header_params = {}
+              if request.parent
+                header_params["parent"] = request.parent
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -527,6 +575,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/asset/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Asset::V1::AssetService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Asset::V1::BatchGetAssetsHistoryRequest.new
+            #
+            #   # Call the batch_get_assets_history method.
+            #   result = client.batch_get_assets_history request
+            #
+            #   # The returned object is of type Google::Cloud::Asset::V1::BatchGetAssetsHistoryResponse.
+            #   p result
+            #
             def batch_get_assets_history request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -544,9 +607,11 @@ module Google
                 gapic_version: ::Google::Cloud::Asset::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "parent" => request.parent
-              }
+              header_params = {}
+              if request.parent
+                header_params["parent"] = request.parent
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -609,6 +674,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/asset/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Asset::V1::AssetService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Asset::V1::CreateFeedRequest.new
+            #
+            #   # Call the create_feed method.
+            #   result = client.create_feed request
+            #
+            #   # The returned object is of type Google::Cloud::Asset::V1::Feed.
+            #   p result
+            #
             def create_feed request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -626,9 +706,11 @@ module Google
                 gapic_version: ::Google::Cloud::Asset::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "parent" => request.parent
-              }
+              header_params = {}
+              if request.parent
+                header_params["parent"] = request.parent
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -680,6 +762,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/asset/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Asset::V1::AssetService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Asset::V1::GetFeedRequest.new
+            #
+            #   # Call the get_feed method.
+            #   result = client.get_feed request
+            #
+            #   # The returned object is of type Google::Cloud::Asset::V1::Feed.
+            #   p result
+            #
             def get_feed request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -697,9 +794,11 @@ module Google
                 gapic_version: ::Google::Cloud::Asset::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -750,6 +849,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/asset/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Asset::V1::AssetService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Asset::V1::ListFeedsRequest.new
+            #
+            #   # Call the list_feeds method.
+            #   result = client.list_feeds request
+            #
+            #   # The returned object is of type Google::Cloud::Asset::V1::ListFeedsResponse.
+            #   p result
+            #
             def list_feeds request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -767,9 +881,11 @@ module Google
                 gapic_version: ::Google::Cloud::Asset::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "parent" => request.parent
-              }
+              header_params = {}
+              if request.parent
+                header_params["parent"] = request.parent
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -826,6 +942,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/asset/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Asset::V1::AssetService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Asset::V1::UpdateFeedRequest.new
+            #
+            #   # Call the update_feed method.
+            #   result = client.update_feed request
+            #
+            #   # The returned object is of type Google::Cloud::Asset::V1::Feed.
+            #   p result
+            #
             def update_feed request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -843,9 +974,11 @@ module Google
                 gapic_version: ::Google::Cloud::Asset::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "feed.name" => request.feed.name
-              }
+              header_params = {}
+              if request.feed&.name
+                header_params["feed.name"] = request.feed.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -897,6 +1030,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/asset/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Asset::V1::AssetService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Asset::V1::DeleteFeedRequest.new
+            #
+            #   # Call the delete_feed method.
+            #   result = client.delete_feed request
+            #
+            #   # The returned object is of type Google::Protobuf::Empty.
+            #   p result
+            #
             def delete_feed request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -914,9 +1062,11 @@ module Google
                 gapic_version: ::Google::Cloud::Asset::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -1096,6 +1246,27 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/asset/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Asset::V1::AssetService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Asset::V1::SearchAllResourcesRequest.new
+            #
+            #   # Call the search_all_resources method.
+            #   result = client.search_all_resources request
+            #
+            #   # The returned object is of type Gapic::PagedEnumerable. You can
+            #   # iterate over all elements by calling #each, and the enumerable
+            #   # will lazily make API calls to fetch subsequent pages. Other
+            #   # methods are also available for managing paging directly.
+            #   result.each do |response|
+            #     # Each element is of type ::Google::Cloud::Asset::V1::ResourceSearchResult.
+            #     p response
+            #   end
+            #
             def search_all_resources request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1113,9 +1284,11 @@ module Google
                 gapic_version: ::Google::Cloud::Asset::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "scope" => request.scope
-              }
+              header_params = {}
+              if request.scope
+                header_params["scope"] = request.scope
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -1260,6 +1433,27 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/asset/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Asset::V1::AssetService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Asset::V1::SearchAllIamPoliciesRequest.new
+            #
+            #   # Call the search_all_iam_policies method.
+            #   result = client.search_all_iam_policies request
+            #
+            #   # The returned object is of type Gapic::PagedEnumerable. You can
+            #   # iterate over all elements by calling #each, and the enumerable
+            #   # will lazily make API calls to fetch subsequent pages. Other
+            #   # methods are also available for managing paging directly.
+            #   result.each do |response|
+            #     # Each element is of type ::Google::Cloud::Asset::V1::IamPolicySearchResult.
+            #     p response
+            #   end
+            #
             def search_all_iam_policies request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1277,9 +1471,11 @@ module Google
                 gapic_version: ::Google::Cloud::Asset::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "scope" => request.scope
-              }
+              header_params = {}
+              if request.scope
+                header_params["scope"] = request.scope
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -1341,6 +1537,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/asset/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Asset::V1::AssetService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Asset::V1::AnalyzeIamPolicyRequest.new
+            #
+            #   # Call the analyze_iam_policy method.
+            #   result = client.analyze_iam_policy request
+            #
+            #   # The returned object is of type Google::Cloud::Asset::V1::AnalyzeIamPolicyResponse.
+            #   p result
+            #
             def analyze_iam_policy request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1358,9 +1569,11 @@ module Google
                 gapic_version: ::Google::Cloud::Asset::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "analysis_query.scope" => request.analysis_query.scope
-              }
+              header_params = {}
+              if request.analysis_query&.scope
+                header_params["analysis_query.scope"] = request.analysis_query.scope
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -1419,6 +1632,28 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/asset/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Asset::V1::AssetService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Asset::V1::AnalyzeIamPolicyLongrunningRequest.new
+            #
+            #   # Call the analyze_iam_policy_longrunning method.
+            #   result = client.analyze_iam_policy_longrunning request
+            #
+            #   # The returned object is of type Gapic::Operation. You can use this
+            #   # object to check the status of an operation, cancel it, or wait
+            #   # for results. Here is how to block until completion:
+            #   result.wait_until_done! timeout: 60
+            #   if result.response?
+            #     p result.response
+            #   else
+            #     puts "Error!"
+            #   end
+            #
             def analyze_iam_policy_longrunning request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1436,9 +1671,11 @@ module Google
                 gapic_version: ::Google::Cloud::Asset::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "analysis_query.scope" => request.analysis_query.scope
-              }
+              header_params = {}
+              if request.analysis_query&.scope
+                header_params["analysis_query.scope"] = request.analysis_query.scope
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -1504,6 +1741,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/asset/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Asset::V1::AssetService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Asset::V1::AnalyzeMoveRequest.new
+            #
+            #   # Call the analyze_move method.
+            #   result = client.analyze_move request
+            #
+            #   # The returned object is of type Google::Cloud::Asset::V1::AnalyzeMoveResponse.
+            #   p result
+            #
             def analyze_move request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1521,9 +1773,11 @@ module Google
                 gapic_version: ::Google::Cloud::Asset::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "resource" => request.resource
-              }
+              header_params = {}
+              if request.resource
+                header_params["resource"] = request.resource
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header