google-cloud-asset-v1 0.15.0 → 0.17.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe4cb183d47d24ad9e43d0e891edf702ca9fa3d1208f1d59ea304c3afa9ec580
-  data.tar.gz: 153470a82f027869dbf0a6efae2633c471ea63e873f07ee79265153bdb1a290b
+  metadata.gz: 80c338a70895248ed872bed101cf42c8c182e6f0c57b5ce95df4e93bc4eb0a5c
+  data.tar.gz: abff9123e9030366be31b5ae21006e4e4405d5ee6552394d4c2ef815c13b08ce
 SHA512:
-  metadata.gz: f3a92efbe9930cb0e62d26963e50baa9a7b1f0c33e82ea05103f1154485003bae40459ac9c96efb8c0c6ac02ae09661754e0cf0f271e4d9c83707857d2e68a01
-  data.tar.gz: e5be3acdae9470c8e543a9caeb544e8b3f63c22a7afc5d35bba90ac0f98331696a6e3451c9313e41e584ea254d72d53bc30c7341218482d24a9a90394359f0ec
+  metadata.gz: d17ba0f63f8db767f4dde084d776844da803e6e6f1fff05be828f132df0947a82aecb2641dc4a647b3794153571b93817f85f93cb65993fa684400281f472dc6
+  data.tar.gz: 424cb7e826e94b5fbbbd37383605314c1f0393b009fd2b477b9076a13d1788d65e89c4696c5d9d23cc4ee58584637eed4bae18fd7ffb44fb3eec1f0982b3da24

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

@@ -291,6 +291,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 +330,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 +439,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 +477,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 +574,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 +606,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 +673,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 +705,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 +761,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 +793,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 +848,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 +880,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 +941,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 +973,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 +1029,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 +1061,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 +1245,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 +1283,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 +1432,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 +1470,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 +1536,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 +1568,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 +1631,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 +1670,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 +1740,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 +1772,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