Class: Google::Cloud::Asset::V1::AssetService::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/asset/v1/asset_service/client.rb

Overview

Client for the AssetService service.

Asset service definition.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#feed_path, #folder_path, #organization_path, #project_path, #saved_query_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new AssetService client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::Asset::V1::AssetService::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Asset::V1::AssetService::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the AssetService client.

Yield Parameters:



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/google/cloud/asset/v1/asset_service/client.rb', line 157

def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/cloud/asset/v1/asset_service_services_pb"

  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
                           !@config.endpoint.split(".").first.include?("-")
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @operations_client = Operations.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @config.endpoint
  end

  @asset_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::Asset::V1::AssetService::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Instance Attribute Details

#operations_client ⇒ ::Google::Cloud::Asset::V1::AssetService::Operations (readonly)

Get the associated client for long-running operations.

Returns:



204
205
206
 
# File 'lib/google/cloud/asset/v1/asset_service/client.rb', line 204

def operations_client
  @operations_client
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the AssetService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all AssetService clients
::Google::Cloud::Asset::V1::AssetService::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/google/cloud/asset/v1/asset_service/client.rb', line 56

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Asset", "V1"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.rpcs.export_assets.timeout = 60.0

    default_config.rpcs.list_assets.timeout = 60.0
    default_config.rpcs.list_assets.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.batch_get_assets_history.timeout = 60.0
    default_config.rpcs.batch_get_assets_history.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.create_feed.timeout = 60.0

    default_config.rpcs.get_feed.timeout = 60.0
    default_config.rpcs.get_feed.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.list_feeds.timeout = 60.0
    default_config.rpcs.list_feeds.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.update_feed.timeout = 60.0

    default_config.rpcs.delete_feed.timeout = 60.0
    default_config.rpcs.delete_feed.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.search_all_resources.timeout = 30.0
    default_config.rpcs.search_all_resources.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.search_all_iam_policies.timeout = 30.0
    default_config.rpcs.search_all_iam_policies.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.analyze_iam_policy.timeout = 300.0
    default_config.rpcs.analyze_iam_policy.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.analyze_iam_policy_longrunning.timeout = 60.0

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#analyze_iam_policy(request, options = nil) ⇒ ::Google::Cloud::Asset::V1::AnalyzeIamPolicyResponse #analyze_iam_policy(analysis_query: nil, saved_analysis_query: nil, execution_timeout: nil) ⇒ ::Google::Cloud::Asset::V1::AnalyzeIamPolicyResponse

Analyzes IAM policies to answer which identities have what accesses on which resources.

Examples:

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

Overloads:

  • #analyze_iam_policy(request, options = nil) ⇒ ::Google::Cloud::Asset::V1::AnalyzeIamPolicyResponse

    Pass arguments to analyze_iam_policy via a request object, either of type Google::Cloud::Asset::V1::AnalyzeIamPolicyRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Asset::V1::AnalyzeIamPolicyRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #analyze_iam_policy(analysis_query: nil, saved_analysis_query: nil, execution_timeout: nil) ⇒ ::Google::Cloud::Asset::V1::AnalyzeIamPolicyResponse

    Pass arguments to analyze_iam_policy via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • analysis_query (::Google::Cloud::Asset::V1::IamPolicyAnalysisQuery, ::Hash) (defaults to: nil) —

      Required. The request query.

    • saved_analysis_query (::String) (defaults to: nil) —

      Optional. The name of a saved query, which must be in the format of:

      • projects/project_number/savedQueries/saved_query_id
      • folders/folder_number/savedQueries/saved_query_id
      • organizations/organization_number/savedQueries/saved_query_id

      If both analysis_query and saved_analysis_query are provided, they will be merged together with the saved_analysis_query as base and the analysis_query as overrides. For more details of the merge behavior, please refer to the MergeFrom page.

      Note that you cannot override primitive fields with default value, such as 0 or empty string, etc., because we use proto3, which doesn't support field presence yet.

    • execution_timeout (::Google::Protobuf::Duration, ::Hash) (defaults to: nil) —

      Optional. Amount of time executable has to complete. See JSON representation of Duration.

      If this field is set with a value less than the RPC deadline, and the execution of your query hasn't finished in the specified execution timeout, you will get a response with partial result. Otherwise, your query's execution will continue until the RPC deadline. If it's not finished until then, you will get a DEADLINE_EXCEEDED error.

      Default is empty.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
 
# File 'lib/google/cloud/asset/v1/asset_service/client.rb', line 1582

def analyze_iam_policy request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Asset::V1::AnalyzeIamPolicyRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.analyze_iam_policy.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Asset::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  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

  options.apply_defaults timeout:      @config.rpcs.analyze_iam_policy.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.analyze_iam_policy.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @asset_service_stub.call_rpc :analyze_iam_policy, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#analyze_iam_policy_longrunning(request, options = nil) ⇒ ::Gapic::Operation #analyze_iam_policy_longrunning(analysis_query: nil, saved_analysis_query: nil, output_config: nil) ⇒ ::Gapic::Operation

Analyzes IAM policies asynchronously to answer which identities have what accesses on which resources, and writes the analysis results to a Google Cloud Storage or a BigQuery destination. For Cloud Storage destination, the output format is the JSON format that represents a AnalyzeIamPolicyResponse. This method implements the google.longrunning.Operation, which allows you to track the operation status. We recommend intervals of at least 2 seconds with exponential backoff retry to poll the operation result. The metadata contains the metadata for the long-running operation.

Examples:

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

Overloads:

  • #analyze_iam_policy_longrunning(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to analyze_iam_policy_longrunning via a request object, either of type Google::Cloud::Asset::V1::AnalyzeIamPolicyLongrunningRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Asset::V1::AnalyzeIamPolicyLongrunningRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #analyze_iam_policy_longrunning(analysis_query: nil, saved_analysis_query: nil, output_config: nil) ⇒ ::Gapic::Operation

    Pass arguments to analyze_iam_policy_longrunning via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • analysis_query (::Google::Cloud::Asset::V1::IamPolicyAnalysisQuery, ::Hash) (defaults to: nil) —

      Required. The request query.

    • saved_analysis_query (::String) (defaults to: nil) —

      Optional. The name of a saved query, which must be in the format of:

      • projects/project_number/savedQueries/saved_query_id
      • folders/folder_number/savedQueries/saved_query_id
      • organizations/organization_number/savedQueries/saved_query_id

      If both analysis_query and saved_analysis_query are provided, they will be merged together with the saved_analysis_query as base and the analysis_query as overrides. For more details of the merge behavior, please refer to the MergeFrom doc.

      Note that you cannot override primitive fields with default value, such as 0 or empty string, etc., because we use proto3, which doesn't support field presence yet.

    • output_config (::Google::Cloud::Asset::V1::IamPolicyAnalysisOutputConfig, ::Hash) (defaults to: nil) —

      Required. Output configuration indicating where the results will be output to.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
 
# File 'lib/google/cloud/asset/v1/asset_service/client.rb', line 1703

def analyze_iam_policy_longrunning request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Asset::V1::AnalyzeIamPolicyLongrunningRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.analyze_iam_policy_longrunning.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Asset::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  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

  options.apply_defaults timeout:      @config.rpcs.analyze_iam_policy_longrunning.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.analyze_iam_policy_longrunning.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @asset_service_stub.call_rpc :analyze_iam_policy_longrunning, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#analyze_move(request, options = nil) ⇒ ::Google::Cloud::Asset::V1::AnalyzeMoveResponse #analyze_move(resource: nil, destination_parent: nil, view: nil) ⇒ ::Google::Cloud::Asset::V1::AnalyzeMoveResponse

Analyze moving a resource to a specified destination without kicking off the actual move. The analysis is best effort depending on the user's permissions of viewing different hierarchical policies and configurations. The policies and configuration are subject to change before the actual resource migration takes place.

Examples:

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

Overloads:

  • #analyze_move(request, options = nil) ⇒ ::Google::Cloud::Asset::V1::AnalyzeMoveResponse

    Pass arguments to analyze_move via a request object, either of type Google::Cloud::Asset::V1::AnalyzeMoveRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Asset::V1::AnalyzeMoveRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #analyze_move(resource: nil, destination_parent: nil, view: nil) ⇒ ::Google::Cloud::Asset::V1::AnalyzeMoveResponse

    Pass arguments to analyze_move via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • resource (::String) (defaults to: nil) —

      Required. Name of the resource to perform the analysis against. Only GCP Project are supported as of today. Hence, this can only be Project ID (such as "projects/my-project-id") or a Project Number (such as "projects/12345").

    • destination_parent (::String) (defaults to: nil) —

      Required. Name of the GCP Folder or Organization to reparent the target resource. The analysis will be performed against hypothetically moving the resource to this specified desitination parent. This can only be a Folder number (such as "folders/123") or an Organization number (such as "organizations/123").

    • view (::Google::Cloud::Asset::V1::AnalyzeMoveRequest::AnalysisView) (defaults to: nil) —

      Analysis view indicating what information should be included in the analysis response. If unspecified, the default view is FULL.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
 
# File 'lib/google/cloud/asset/v1/asset_service/client.rb', line 1805

def analyze_move request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Asset::V1::AnalyzeMoveRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.analyze_move.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Asset::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  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

  options.apply_defaults timeout:      @config.rpcs.analyze_move.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.analyze_move.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @asset_service_stub.call_rpc :analyze_move, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#batch_get_assets_history(request, options = nil) ⇒ ::Google::Cloud::Asset::V1::BatchGetAssetsHistoryResponse #batch_get_assets_history(parent: nil, asset_names: nil, content_type: nil, read_time_window: nil, relationship_types: nil) ⇒ ::Google::Cloud::Asset::V1::BatchGetAssetsHistoryResponse

Batch gets the update history of assets that overlap a time window. For IAM_POLICY content, this API outputs history when the asset and its attached IAM POLICY both exist. This can create gaps in the output history. Otherwise, this API outputs history with asset in both non-delete or deleted status. If a specified asset does not exist, this API returns an INVALID_ARGUMENT error.

Examples:

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

Overloads:

  • #batch_get_assets_history(request, options = nil) ⇒ ::Google::Cloud::Asset::V1::BatchGetAssetsHistoryResponse

    Pass arguments to batch_get_assets_history via a request object, either of type BatchGetAssetsHistoryRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Asset::V1::BatchGetAssetsHistoryRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #batch_get_assets_history(parent: nil, asset_names: nil, content_type: nil, read_time_window: nil, relationship_types: nil) ⇒ ::Google::Cloud::Asset::V1::BatchGetAssetsHistoryResponse

    Pass arguments to batch_get_assets_history via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The relative name of the root asset. It can only be an organization number (such as "organizations/123"), a project ID (such as "projects/my-project-id")", or a project number (such as "projects/12345").

    • asset_names (::Array<::String>) (defaults to: nil) —

      A list of the full names of the assets. See: https://cloud.google.com/asset-inventory/docs/resource-name-format Example:

      //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1.

      The request becomes a no-op if the asset name list is empty, and the max size of the asset name list is 100 in one request.

    • content_type (::Google::Cloud::Asset::V1::ContentType) (defaults to: nil) —

      Optional. The content type.

    • read_time_window (::Google::Cloud::Asset::V1::TimeWindow, ::Hash) (defaults to: nil) —

      Optional. The time window for the asset history. Both start_time and end_time are optional and if set, it must be after the current time minus 35 days. If end_time is not set, it is default to current timestamp. If start_time is not set, the snapshot of the assets at end_time will be returned. The returned results contain all temporal assets whose time window overlap with read_time_window.

    • relationship_types (::Array<::String>) (defaults to: nil) —

      Optional. A list of relationship types to output, for example: INSTANCE_TO_INSTANCEGROUP. This field should only be specified if content_type=RELATIONSHIP.

      • If specified: it outputs specified relationships' history on the [asset_names]. It returns an error if any of the [relationship_types] doesn't belong to the supported relationship types of the [asset_names] or if any of the [asset_names]'s types doesn't belong to the source types of the [relationship_types].
      • Otherwise: it outputs the supported relationships' history on the [asset_names] or returns an error if any of the [asset_names]'s types has no relationship support. See Introduction to Cloud Asset Inventory for all supported asset types and relationship types.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
 
# File 'lib/google/cloud/asset/v1/asset_service/client.rb', line 596

def batch_get_assets_history request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Asset::V1::BatchGetAssetsHistoryRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.batch_get_assets_history.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Asset::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  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

  options.apply_defaults timeout:      @config.rpcs.batch_get_assets_history.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.batch_get_assets_history.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @asset_service_stub.call_rpc :batch_get_assets_history, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#batch_get_effective_iam_policies(request, options = nil) ⇒ ::Google::Cloud::Asset::V1::BatchGetEffectiveIamPoliciesResponse #batch_get_effective_iam_policies(scope: nil, names: nil) ⇒ ::Google::Cloud::Asset::V1::BatchGetEffectiveIamPoliciesResponse

Gets effective IAM policies for a batch of resources.

Examples:

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::BatchGetEffectiveIamPoliciesRequest.new

# Call the batch_get_effective_iam_policies method.
result = client.batch_get_effective_iam_policies request

# The returned object is of type Google::Cloud::Asset::V1::BatchGetEffectiveIamPoliciesResponse.
p result

Overloads:

  • #batch_get_effective_iam_policies(request, options = nil) ⇒ ::Google::Cloud::Asset::V1::BatchGetEffectiveIamPoliciesResponse

    Pass arguments to batch_get_effective_iam_policies via a request object, either of type BatchGetEffectiveIamPoliciesRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Asset::V1::BatchGetEffectiveIamPoliciesRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #batch_get_effective_iam_policies(scope: nil, names: nil) ⇒ ::Google::Cloud::Asset::V1::BatchGetEffectiveIamPoliciesResponse

    Pass arguments to batch_get_effective_iam_policies via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • scope (::String) (defaults to: nil) —

      Required. Only IAM policies on or below the scope will be returned.

      This can only be an organization number (such as "organizations/123"), a folder number (such as "folders/123"), a project ID (such as "projects/my-project-id"), or a project number (such as "projects/12345").

      To know how to get organization id, visit here .

      To know how to get folder or project id, visit here .

    • names (::Array<::String>) (defaults to: nil) —

      Required. The names refer to the full_resource_names of searchable asset types. A maximum of 20 resources' effective policies can be retrieved in a batch.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
 
# File 'lib/google/cloud/asset/v1/asset_service/client.rb', line 2394

def batch_get_effective_iam_policies request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Asset::V1::BatchGetEffectiveIamPoliciesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.batch_get_effective_iam_policies.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Asset::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  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

  options.apply_defaults timeout:      @config.rpcs.batch_get_effective_iam_policies.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.batch_get_effective_iam_policies.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @asset_service_stub.call_rpc :batch_get_effective_iam_policies, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#configure {|config| ... } ⇒ Client::Configuration

Configure the AssetService Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



136
137
138
139
 
# File 'lib/google/cloud/asset/v1/asset_service/client.rb', line 136

def configure
  yield @config if block_given?
  @config
end

#create_feed(request, options = nil) ⇒ ::Google::Cloud::Asset::V1::Feed #create_feed(parent: nil, feed_id: nil, feed: nil) ⇒ ::Google::Cloud::Asset::V1::Feed

Creates a feed in a parent project/folder/organization to listen to its asset updates.

Examples:

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

Overloads:

  • #create_feed(request, options = nil) ⇒ ::Google::Cloud::Asset::V1::Feed

    Pass arguments to create_feed via a request object, either of type CreateFeedRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Asset::V1::CreateFeedRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #create_feed(parent: nil, feed_id: nil, feed: nil) ⇒ ::Google::Cloud::Asset::V1::Feed

    Pass arguments to create_feed via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The name of the project/folder/organization where this feed should be created in. It can only be an organization number (such as "organizations/123"), a folder number (such as "folders/123"), a project ID (such as "projects/my-project-id")", or a project number (such as "projects/12345").

    • feed_id (::String) (defaults to: nil) —

      Required. This is the client-assigned asset feed identifier and it needs to be unique under a specific parent project/folder/organization.

    • feed (::Google::Cloud::Asset::V1::Feed, ::Hash) (defaults to: nil) —

      Required. The feed details. The field name must be empty and it will be generated in the format of: projects/project_number/feeds/feed_id folders/folder_number/feeds/feed_id organizations/organization_number/feeds/feed_id

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
 
# File 'lib/google/cloud/asset/v1/asset_service/client.rb', line 694

def create_feed request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Asset::V1::CreateFeedRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_feed.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Asset::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  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

  options.apply_defaults timeout:      @config.rpcs.create_feed.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_feed.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @asset_service_stub.call_rpc :create_feed, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_saved_query(request, options = nil) ⇒ ::Google::Cloud::Asset::V1::SavedQuery #create_saved_query(parent: nil, saved_query: nil, saved_query_id: nil) ⇒ ::Google::Cloud::Asset::V1::SavedQuery

Creates a saved query in a parent project/folder/organization.

Examples:

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::CreateSavedQueryRequest.new

# Call the create_saved_query method.
result = client.create_saved_query request

# The returned object is of type Google::Cloud::Asset::V1::SavedQuery.
p result

Overloads:

  • #create_saved_query(request, options = nil) ⇒ ::Google::Cloud::Asset::V1::SavedQuery

    Pass arguments to create_saved_query via a request object, either of type CreateSavedQueryRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Asset::V1::CreateSavedQueryRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #create_saved_query(parent: nil, saved_query: nil, saved_query_id: nil) ⇒ ::Google::Cloud::Asset::V1::SavedQuery

    Pass arguments to create_saved_query via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The name of the project/folder/organization where this saved_query should be created in. It can only be an organization number (such as "organizations/123"), a folder number (such as "folders/123"), a project ID (such as "projects/my-project-id")", or a project number (such as "projects/12345").

    • saved_query (::Google::Cloud::Asset::V1::SavedQuery, ::Hash) (defaults to: nil) —

      Required. The saved_query details. The name field must be empty as it will be generated based on the parent and saved_query_id.

    • saved_query_id (::String) (defaults to: nil) —

      Required. The ID to use for the saved query, which must be unique in the specified parent. It will become the final component of the saved query's resource name.

      This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/.

      Notice that this field is required in the saved query creation, and the name field of the saved_query will be ignored.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
 
# File 'lib/google/cloud/asset/v1/asset_service/client.rb', line 1907

def create_saved_query request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Asset::V1::CreateSavedQueryRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_saved_query.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Asset::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  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

  options.apply_defaults timeout:      @config.rpcs.create_saved_query.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_saved_query.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @asset_service_stub.call_rpc :create_saved_query, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_feed(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_feed(name: nil) ⇒ ::Google::Protobuf::Empty

Deletes an asset feed.

Examples:

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

Overloads:

  • #delete_feed(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_feed via a request object, either of type DeleteFeedRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Asset::V1::DeleteFeedRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #delete_feed(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_feed via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the feed and it must be in the format of: projects/project_number/feeds/feed_id folders/folder_number/feeds/feed_id organizations/organization_number/feeds/feed_id

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
 
# File 'lib/google/cloud/asset/v1/asset_service/client.rb', line 1050

def delete_feed request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Asset::V1::DeleteFeedRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_feed.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Asset::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  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

  options.apply_defaults timeout:      @config.rpcs.delete_feed.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_feed.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @asset_service_stub.call_rpc :delete_feed, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_saved_query(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_saved_query(name: nil) ⇒ ::Google::Protobuf::Empty

Deletes a saved query.

Examples:

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::DeleteSavedQueryRequest.new

# Call the delete_saved_query method.
result = client.delete_saved_query request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

  • #delete_saved_query(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_saved_query via a request object, either of type DeleteSavedQueryRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Asset::V1::DeleteSavedQueryRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #delete_saved_query(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_saved_query via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the saved query to delete. It must be in the format of:

      • projects/project_number/savedQueries/saved_query_id
      • folders/folder_number/savedQueries/saved_query_id
      • organizations/organization_number/savedQueries/saved_query_id

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
 
# File 'lib/google/cloud/asset/v1/asset_service/client.rb', line 2293

def delete_saved_query request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Asset::V1::DeleteSavedQueryRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_saved_query.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Asset::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  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

  options.apply_defaults timeout:      @config.rpcs.delete_saved_query.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_saved_query.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @asset_service_stub.call_rpc :delete_saved_query, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#export_assets(request, options = nil) ⇒ ::Gapic::Operation #export_assets(parent: nil, read_time: nil, asset_types: nil, content_type: nil, output_config: nil, relationship_types: nil) ⇒ ::Gapic::Operation

Exports assets with time and resource types to a given Cloud Storage location/BigQuery table. For Cloud Storage location destinations, the output format is newline-delimited JSON. Each line represents a google.cloud.asset.v1.Asset in the JSON format; for BigQuery table destinations, the output table stores the fields in asset Protobuf as columns. This API implements the google.longrunning.Operation API, which allows you to keep track of the export. We recommend intervals of at least 2 seconds with exponential retry to poll the export operation result. For regular-size resource parent, the export operation usually finishes within 5 minutes.

Examples:

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

Overloads:

  • #export_assets(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to export_assets via a request object, either of type ExportAssetsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Asset::V1::ExportAssetsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #export_assets(parent: nil, read_time: nil, asset_types: nil, content_type: nil, output_config: nil, relationship_types: nil) ⇒ ::Gapic::Operation

    Pass arguments to export_assets via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The relative name of the root asset. This can only be an organization number (such as "organizations/123"), a project ID (such as "projects/my-project-id"), or a project number (such as "projects/12345"), or a folder number (such as "folders/123").

    • read_time (::Google::Protobuf::Timestamp, ::Hash) (defaults to: nil) —

      Timestamp to take an asset snapshot. This can only be set to a timestamp between the current time and the current time minus 35 days (inclusive). If not specified, the current time will be used. Due to delays in resource data collection and indexing, there is a volatile window during which running the same query may get different results.

    • asset_types (::Array<::String>) (defaults to: nil) —

      A list of asset types to take a snapshot for. For example: "compute.googleapis.com/Disk".

      Regular expressions are also supported. For example:

      • "compute.googleapis.com.*" snapshots resources whose asset type starts with "compute.googleapis.com".
      • ".*Instance" snapshots resources whose asset type ends with "Instance".
      • ".Instance." snapshots resources whose asset type contains "Instance".

      See RE2 for all supported regular expression syntax. If the regular expression does not match any supported asset type, an INVALID_ARGUMENT error will be returned.

      If specified, only matching assets will be returned, otherwise, it will snapshot all asset types. See Introduction to Cloud Asset Inventory for all supported asset types.

    • content_type (::Google::Cloud::Asset::V1::ContentType) (defaults to: nil) —

      Asset content type. If not specified, no content but the asset name will be returned.

    • output_config (::Google::Cloud::Asset::V1::OutputConfig, ::Hash) (defaults to: nil) —

      Required. Output configuration indicating where the results will be output to.

    • relationship_types (::Array<::String>) (defaults to: nil) —

      A list of relationship types to export, for example: INSTANCE_TO_INSTANCEGROUP. This field should only be specified if content_type=RELATIONSHIP.

      • If specified: it snapshots specified relationships. It returns an error if any of the [relationship_types] doesn't belong to the supported relationship types of the [asset_types] or if any of the [asset_types] doesn't belong to the source types of the [relationship_types].
      • Otherwise: it snapshots the supported relationships for all [asset_types] or returns an error if any of the [asset_types] has no relationship support. An unspecified asset types field means all supported asset_types. See Introduction to Cloud Asset Inventory for all supported asset types and relationship types.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/google/cloud/asset/v1/asset_service/client.rb', line 319

def export_assets request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Asset::V1::ExportAssetsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.export_assets.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Asset::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  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

  options.apply_defaults timeout:      @config.rpcs.export_assets.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.export_assets.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @asset_service_stub.call_rpc :export_assets, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_feed(request, options = nil) ⇒ ::Google::Cloud::Asset::V1::Feed #get_feed(name: nil) ⇒ ::Google::Cloud::Asset::V1::Feed

Gets details about an asset feed.

Examples:

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

Overloads:

  • #get_feed(request, options = nil) ⇒ ::Google::Cloud::Asset::V1::Feed

    Pass arguments to get_feed via a request object, either of type GetFeedRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Asset::V1::GetFeedRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_feed(name: nil) ⇒ ::Google::Cloud::Asset::V1::Feed

    Pass arguments to get_feed via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the Feed and it must be in the format of: projects/project_number/feeds/feed_id folders/folder_number/feeds/feed_id organizations/organization_number/feeds/feed_id

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
 
# File 'lib/google/cloud/asset/v1/asset_service/client.rb', line 782

def get_feed request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Asset::V1::GetFeedRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_feed.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Asset::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  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

  options.apply_defaults timeout:      @config.rpcs.get_feed.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_feed.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @asset_service_stub.call_rpc :get_feed, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_saved_query(request, options = nil) ⇒ ::Google::Cloud::Asset::V1::SavedQuery #get_saved_query(name: nil) ⇒ ::Google::Cloud::Asset::V1::SavedQuery

Gets details about a saved query.

Examples:

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::GetSavedQueryRequest.new

# Call the get_saved_query method.
result = client.get_saved_query request

# The returned object is of type Google::Cloud::Asset::V1::SavedQuery.
p result

Overloads:

  • #get_saved_query(request, options = nil) ⇒ ::Google::Cloud::Asset::V1::SavedQuery

    Pass arguments to get_saved_query via a request object, either of type GetSavedQueryRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Asset::V1::GetSavedQueryRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_saved_query(name: nil) ⇒ ::Google::Cloud::Asset::V1::SavedQuery

    Pass arguments to get_saved_query via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the saved query and it must be in the format of:

      • projects/project_number/savedQueries/saved_query_id
      • folders/folder_number/savedQueries/saved_query_id
      • organizations/organization_number/savedQueries/saved_query_id

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
 
# File 'lib/google/cloud/asset/v1/asset_service/client.rb', line 1996

def get_saved_query request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Asset::V1::GetSavedQueryRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_saved_query.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Asset::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  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

  options.apply_defaults timeout:      @config.rpcs.get_saved_query.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_saved_query.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @asset_service_stub.call_rpc :get_saved_query, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_assets(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Asset::V1::Asset> #list_assets(parent: nil, read_time: nil, asset_types: nil, content_type: nil, page_size: nil, page_token: nil, relationship_types: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Asset::V1::Asset>

Lists assets with time and resource types and returns paged results in response.

Examples:

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

Overloads:

  • #list_assets(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Asset::V1::Asset>

    Pass arguments to list_assets via a request object, either of type ListAssetsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Asset::V1::ListAssetsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_assets(parent: nil, read_time: nil, asset_types: nil, content_type: nil, page_size: nil, page_token: nil, relationship_types: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Asset::V1::Asset>

    Pass arguments to list_assets via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. Name of the organization, folder, or project the assets belong to. Format: "organizations/[organization-number]" (such as "organizations/123"), "projects/[project-id]" (such as "projects/my-project-id"), "projects/[project-number]" (such as "projects/12345"), or "folders/[folder-number]" (such as "folders/12345").

    • read_time (::Google::Protobuf::Timestamp, ::Hash) (defaults to: nil) —

      Timestamp to take an asset snapshot. This can only be set to a timestamp between the current time and the current time minus 35 days (inclusive). If not specified, the current time will be used. Due to delays in resource data collection and indexing, there is a volatile window during which running the same query may get different results.

    • asset_types (::Array<::String>) (defaults to: nil) —

      A list of asset types to take a snapshot for. For example: "compute.googleapis.com/Disk".

      Regular expression is also supported. For example:

      • "compute.googleapis.com.*" snapshots resources whose asset type starts with "compute.googleapis.com".
      • ".*Instance" snapshots resources whose asset type ends with "Instance".
      • ".Instance." snapshots resources whose asset type contains "Instance".

      See RE2 for all supported regular expression syntax. If the regular expression does not match any supported asset type, an INVALID_ARGUMENT error will be returned.

      If specified, only matching assets will be returned, otherwise, it will snapshot all asset types. See Introduction to Cloud Asset Inventory for all supported asset types.

    • content_type (::Google::Cloud::Asset::V1::ContentType) (defaults to: nil) —

      Asset content type. If not specified, no content but the asset name will be returned.

    • page_size (::Integer) (defaults to: nil) —

      The maximum number of assets to be returned in a single response. Default is 100, minimum is 1, and maximum is 1000.

    • page_token (::String) (defaults to: nil) —

      The next_page_token returned from the previous ListAssetsResponse, or unspecified for the first ListAssetsRequest. It is a continuation of a prior ListAssets call, and the API should return the next page of assets.

    • relationship_types (::Array<::String>) (defaults to: nil) —

      A list of relationship types to output, for example: INSTANCE_TO_INSTANCEGROUP. This field should only be specified if content_type=RELATIONSHIP.

      • If specified: it snapshots specified relationships. It returns an error if any of the [relationship_types] doesn't belong to the supported relationship types of the [asset_types] or if any of the [asset_types] doesn't belong to the source types of the [relationship_types].
      • Otherwise: it snapshots the supported relationships for all [asset_types] or returns an error if any of the [asset_types] has no relationship support. An unspecified asset types field means all supported asset_types. See Introduction to Cloud Asset Inventory for all supported asset types and relationship types.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
 
# File 'lib/google/cloud/asset/v1/asset_service/client.rb', line 467

def list_assets request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Asset::V1::ListAssetsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_assets.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Asset::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  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

  options.apply_defaults timeout:      @config.rpcs.list_assets.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_assets.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @asset_service_stub.call_rpc :list_assets, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @asset_service_stub, :list_assets, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_feeds(request, options = nil) ⇒ ::Google::Cloud::Asset::V1::ListFeedsResponse #list_feeds(parent: nil) ⇒ ::Google::Cloud::Asset::V1::ListFeedsResponse

Lists all asset feeds in a parent project/folder/organization.

Examples:

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

Overloads:

  • #list_feeds(request, options = nil) ⇒ ::Google::Cloud::Asset::V1::ListFeedsResponse

    Pass arguments to list_feeds via a request object, either of type ListFeedsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Asset::V1::ListFeedsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_feeds(parent: nil) ⇒ ::Google::Cloud::Asset::V1::ListFeedsResponse

    Pass arguments to list_feeds via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The parent project/folder/organization whose feeds are to be listed. It can only be using project/folder/organization number (such as "folders/12345")", or a project ID (such as "projects/my-project-id").

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
 
# File 'lib/google/cloud/asset/v1/asset_service/client.rb', line 869

def list_feeds request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Asset::V1::ListFeedsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_feeds.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Asset::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  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

  options.apply_defaults timeout:      @config.rpcs.list_feeds.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_feeds.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @asset_service_stub.call_rpc :list_feeds, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_saved_queries(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Asset::V1::SavedQuery> #list_saved_queries(parent: nil, filter: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Asset::V1::SavedQuery>

Lists all saved queries in a parent project/folder/organization.

Examples:

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::ListSavedQueriesRequest.new

# Call the list_saved_queries method.
result = client.list_saved_queries 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::SavedQuery.
  p response
end

Overloads:

  • #list_saved_queries(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Asset::V1::SavedQuery>

    Pass arguments to list_saved_queries via a request object, either of type ListSavedQueriesRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Asset::V1::ListSavedQueriesRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_saved_queries(parent: nil, filter: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Asset::V1::SavedQuery>

    Pass arguments to list_saved_queries via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The parent project/folder/organization whose savedQueries are to be listed. It can only be using project/folder/organization number (such as "folders/12345")", or a project ID (such as "projects/my-project-id").

    • filter (::String) (defaults to: nil) —

      Optional. The expression to filter resources. The expression is a list of zero or more restrictions combined via logical operators AND and OR. When AND and OR are both used in the expression, parentheses must be appropriately used to group the combinations. The expression may also contain regular expressions.

      See https://google.aip.dev/160 for more information on the grammar.

    • page_size (::Integer) (defaults to: nil) —

      Optional. The maximum number of saved queries to return per page. The service may return fewer than this value. If unspecified, at most 50 will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

    • page_token (::String) (defaults to: nil) —

      Optional. A page token, received from a previous ListSavedQueries call. Provide this to retrieve the subsequent page.

      When paginating, all other parameters provided to ListSavedQueries must match the call that provided the page token.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
 
# File 'lib/google/cloud/asset/v1/asset_service/client.rb', line 2108

def list_saved_queries request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Asset::V1::ListSavedQueriesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_saved_queries.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Asset::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  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

  options.apply_defaults timeout:      @config.rpcs.list_saved_queries.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_saved_queries.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @asset_service_stub.call_rpc :list_saved_queries, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @asset_service_stub, :list_saved_queries, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#search_all_iam_policies(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Asset::V1::IamPolicySearchResult> #search_all_iam_policies(scope: nil, query: nil, page_size: nil, page_token: nil, asset_types: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Asset::V1::IamPolicySearchResult>

Searches all IAM policies within the specified scope, such as a project, folder, or organization. The caller must be granted the cloudasset.assets.searchAllIamPolicies permission on the desired scope, otherwise the request will be rejected.

Examples:

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

Overloads:

  • #search_all_iam_policies(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Asset::V1::IamPolicySearchResult>

    Pass arguments to search_all_iam_policies via a request object, either of type SearchAllIamPoliciesRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Asset::V1::SearchAllIamPoliciesRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #search_all_iam_policies(scope: nil, query: nil, page_size: nil, page_token: nil, asset_types: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Asset::V1::IamPolicySearchResult>

    Pass arguments to search_all_iam_policies via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • scope (::String) (defaults to: nil) —

      Required. A scope can be a project, a folder, or an organization. The search is limited to the IAM policies within the scope. The caller must be granted the cloudasset.assets.searchAllIamPolicies permission on the desired scope.

      The allowed values are:

      • projects/{PROJECT_ID} (e.g., "projects/foo-bar")
      • projects/{PROJECT_NUMBER} (e.g., "projects/12345678")
      • folders/{FOLDER_NUMBER} (e.g., "folders/1234567")
      • organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456")
    • query (::String) (defaults to: nil) —

      Optional. The query statement. See how to construct a query for more information. If not specified or empty, it will search all the IAM policies within the specified scope. Note that the query string is compared against each Cloud IAM policy binding, including its principals, roles, and Cloud IAM conditions. The returned Cloud IAM policies will only contain the bindings that match your query. To learn more about the IAM policy structure, see IAM policy doc.

      Examples:

      • policy:[email protected] to find IAM policy bindings that specify user "[email protected]".
      • policy:roles/compute.admin to find IAM policy bindings that specify the Compute Admin role.
      • policy:comp* to find IAM policy bindings that contain "comp" as a prefix of any word in the binding.
      • policy.role.permissions:storage.buckets.update to find IAM policy bindings that specify a role containing "storage.buckets.update" permission. Note that if callers don't have iam.roles.get access to a role's included permissions, policy bindings that specify this role will be dropped from the search results.
      • policy.role.permissions:upd* to find IAM policy bindings that specify a role containing "upd" as a prefix of any word in the role permission. Note that if callers don't have iam.roles.get access to a role's included permissions, policy bindings that specify this role will be dropped from the search results.
      • resource:organizations/123456 to find IAM policy bindings that are set on "organizations/123456".
      • resource=//cloudresourcemanager.googleapis.com/projects/myproject to find IAM policy bindings that are set on the project named "myproject".
      • Important to find IAM policy bindings that contain "Important" as a word in any of the searchable fields (except for the included permissions).
      • resource:(instance1 OR instance2) policy:amy to find IAM policy bindings that are set on resources "instance1" or "instance2" and also specify user "amy".
      • roles:roles/compute.admin to find IAM policy bindings that specify the Compute Admin role.
      • memberTypes:user to find IAM policy bindings that contain the principal type "user".
    • page_size (::Integer) (defaults to: nil) —

      Optional. The page size for search result pagination. Page size is capped at 500 even if a larger value is given. If set to zero, server will pick an appropriate default. Returned results may be fewer than requested. When this happens, there could be more results as long as next_page_token is returned.

    • page_token (::String) (defaults to: nil) —

      Optional. If present, retrieve the next batch of results from the preceding call to this method. page_token must be the value of next_page_token from the previous response. The values of all other method parameters must be identical to those in the previous call.

    • asset_types (::Array<::String>) (defaults to: nil) —

      Optional. A list of asset types that the IAM policies are attached to. If empty, it will search the IAM policies that are attached to all the searchable asset types.

      Regular expressions are also supported. For example:

      • "compute.googleapis.com.*" snapshots IAM policies attached to asset type starts with "compute.googleapis.com".
      • ".*Instance" snapshots IAM policies attached to asset type ends with "Instance".
      • ".Instance." snapshots IAM policies attached to asset type contains "Instance".

      See RE2 for all supported regular expression syntax. If the regular expression does not match any supported asset type, an INVALID_ARGUMENT error will be returned.

    • order_by (::String) (defaults to: nil) —

      Optional. A comma-separated list of fields specifying the sorting order of the results. The default order is ascending. Add " DESC" after the field name to indicate descending order. Redundant space characters are ignored. Example: "assetType DESC, resource". Only singular primitive fields in the response are sortable:

      • resource
      • assetType
      • project All the other fields such as repeated fields (e.g., folders) and non-primitive fields (e.g., policy) are not supported.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
 
# File 'lib/google/cloud/asset/v1/asset_service/client.rb', line 1466

def search_all_iam_policies request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Asset::V1::SearchAllIamPoliciesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.search_all_iam_policies.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Asset::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  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

  options.apply_defaults timeout:      @config.rpcs.search_all_iam_policies.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.search_all_iam_policies.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @asset_service_stub.call_rpc :search_all_iam_policies, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @asset_service_stub, :search_all_iam_policies, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#search_all_resources(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Asset::V1::ResourceSearchResult> #search_all_resources(scope: nil, query: nil, asset_types: nil, page_size: nil, page_token: nil, order_by: nil, read_mask: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Asset::V1::ResourceSearchResult>

Searches all Cloud resources within the specified scope, such as a project, folder, or organization. The caller must be granted the cloudasset.assets.searchAllResources permission on the desired scope, otherwise the request will be rejected.

Examples:

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

Overloads:

  • #search_all_resources(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Asset::V1::ResourceSearchResult>

    Pass arguments to search_all_resources via a request object, either of type SearchAllResourcesRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Asset::V1::SearchAllResourcesRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #search_all_resources(scope: nil, query: nil, asset_types: nil, page_size: nil, page_token: nil, order_by: nil, read_mask: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Asset::V1::ResourceSearchResult>

    Pass arguments to search_all_resources via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • scope (::String) (defaults to: nil) —

      Required. A scope can be a project, a folder, or an organization. The search is limited to the resources within the scope. The caller must be granted the cloudasset.assets.searchAllResources permission on the desired scope.

      The allowed values are:

      • projects/{PROJECT_ID} (e.g., "projects/foo-bar")
      • projects/{PROJECT_NUMBER} (e.g., "projects/12345678")
      • folders/{FOLDER_NUMBER} (e.g., "folders/1234567")
      • organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456")
    • query (::String) (defaults to: nil) —

      Optional. The query statement. See how to construct a query for more information. If not specified or empty, it will search all the resources within the specified scope.

      Examples:

      • name:Important to find Cloud resources whose name contains "Important" as a word.
      • name=Important to find the Cloud resource whose name is exactly "Important".
      • displayName:Impor* to find Cloud resources whose display name contains "Impor" as a prefix of any word in the field.
      • location:us-west* to find Cloud resources whose location contains both "us" and "west" as prefixes.
      • labels:prod to find Cloud resources whose labels contain "prod" as a key or value.
      • labels.env:prod to find Cloud resources that have a label "env" and its value is "prod".
      • labels.env:* to find Cloud resources that have a label "env".
      • kmsKey:key to find Cloud resources encrypted with a customer-managed encryption key whose name contains the word "key".
      • state:ACTIVE to find Cloud resources whose state contains "ACTIVE" as a word.
      • NOT state:ACTIVE to find Cloud resources whose state doesn't contain "ACTIVE" as a word.
      • createTime<1609459200 to find Cloud resources that were created before "2021-01-01 00:00:00 UTC". 1609459200 is the epoch timestamp of "2021-01-01 00:00:00 UTC" in seconds.
      • updateTime>1609459200 to find Cloud resources that were updated after "2021-01-01 00:00:00 UTC". 1609459200 is the epoch timestamp of "2021-01-01 00:00:00 UTC" in seconds.
      • Important to find Cloud resources that contain "Important" as a word in any of the searchable fields.
      • Impor* to find Cloud resources that contain "Impor" as a prefix of any word in any of the searchable fields.
      • Important location:(us-west1 OR global) to find Cloud resources that contain "Important" as a word in any of the searchable fields and are also located in the "us-west1" region or the "global" location.
    • asset_types (::Array<::String>) (defaults to: nil) —

      Optional. A list of asset types that this request searches for. If empty, it will search all the searchable asset types.

      Regular expressions are also supported. For example:

      • "compute.googleapis.com.*" snapshots resources whose asset type starts with "compute.googleapis.com".
      • ".*Instance" snapshots resources whose asset type ends with "Instance".
      • ".Instance." snapshots resources whose asset type contains "Instance".

      See RE2 for all supported regular expression syntax. If the regular expression does not match any supported asset type, an INVALID_ARGUMENT error will be returned.

    • page_size (::Integer) (defaults to: nil) —

      Optional. The page size for search result pagination. Page size is capped at 500 even if a larger value is given. If set to zero, server will pick an appropriate default. Returned results may be fewer than requested. When this happens, there could be more results as long as next_page_token is returned.

    • page_token (::String) (defaults to: nil) —

      Optional. If present, then retrieve the next batch of results from the preceding call to this method. page_token must be the value of next_page_token from the previous response. The values of all other method parameters, must be identical to those in the previous call.

    • order_by (::String) (defaults to: nil) —

      Optional. A comma-separated list of fields specifying the sorting order of the results. The default order is ascending. Add " DESC" after the field name to indicate descending order. Redundant space characters are ignored. Example: "location DESC, name". Only singular primitive fields in the response are sortable:

      • name
      • assetType
      • project
      • displayName
      • description
      • location
      • kmsKey
      • createTime
      • updateTime
      • state
      • parentFullResourceName
      • parentAssetType

      All the other fields such as repeated fields (e.g., networkTags), map fields (e.g., labels) and struct fields (e.g., additionalAttributes) are not supported.

    • read_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      Optional. A comma-separated list of fields specifying which fields to be returned in ResourceSearchResult. Only '' or combination of top level fields can be specified. Field names of both snake_case and camelCase are supported. Examples: `"","name,location","name,versionedResources"`.

      The read_mask paths must be valid field paths listed but not limited to (both snake_case and camelCase are supported):

      • name
      • assetType
      • project
      • displayName
      • description
      • location
      • tagKeys
      • tagValues
      • tagValueIds
      • labels
      • networkTags
      • kmsKey
      • createTime
      • updateTime
      • state
      • additionalAttributes
      • versionedResources

      If read_mask is not specified, all fields except versionedResources will be returned. If only '*' is specified, all fields including versionedResources will be returned. Any invalid field path will trigger INVALID_ARGUMENT error.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
 
# File 'lib/google/cloud/asset/v1/asset_service/client.rb', line 1277

def search_all_resources request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Asset::V1::SearchAllResourcesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.search_all_resources.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Asset::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  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

  options.apply_defaults timeout:      @config.rpcs.search_all_resources.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.search_all_resources.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @asset_service_stub.call_rpc :search_all_resources, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @asset_service_stub, :search_all_resources, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_feed(request, options = nil) ⇒ ::Google::Cloud::Asset::V1::Feed #update_feed(feed: nil, update_mask: nil) ⇒ ::Google::Cloud::Asset::V1::Feed

Updates an asset feed configuration.

Examples:

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

Overloads:

  • #update_feed(request, options = nil) ⇒ ::Google::Cloud::Asset::V1::Feed

    Pass arguments to update_feed via a request object, either of type UpdateFeedRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Asset::V1::UpdateFeedRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #update_feed(feed: nil, update_mask: nil) ⇒ ::Google::Cloud::Asset::V1::Feed

    Pass arguments to update_feed via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • feed (::Google::Cloud::Asset::V1::Feed, ::Hash) (defaults to: nil) —

      Required. The new values of feed details. It must match an existing feed and the field name must be in the format of: projects/project_number/feeds/feed_id or folders/folder_number/feeds/feed_id or organizations/organization_number/feeds/feed_id.

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      Required. Only updates the feed fields indicated by this mask. The field mask must not be empty, and it must not contain fields that are immutable or only set by the server.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
 
# File 'lib/google/cloud/asset/v1/asset_service/client.rb', line 962

def update_feed request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Asset::V1::UpdateFeedRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_feed.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Asset::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  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

  options.apply_defaults timeout:      @config.rpcs.update_feed.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_feed.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @asset_service_stub.call_rpc :update_feed, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_saved_query(request, options = nil) ⇒ ::Google::Cloud::Asset::V1::SavedQuery #update_saved_query(saved_query: nil, update_mask: nil) ⇒ ::Google::Cloud::Asset::V1::SavedQuery

Updates a saved query.

Examples:

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::UpdateSavedQueryRequest.new

# Call the update_saved_query method.
result = client.update_saved_query request

# The returned object is of type Google::Cloud::Asset::V1::SavedQuery.
p result

Overloads:

  • #update_saved_query(request, options = nil) ⇒ ::Google::Cloud::Asset::V1::SavedQuery

    Pass arguments to update_saved_query via a request object, either of type UpdateSavedQueryRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Asset::V1::UpdateSavedQueryRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #update_saved_query(saved_query: nil, update_mask: nil) ⇒ ::Google::Cloud::Asset::V1::SavedQuery

    Pass arguments to update_saved_query via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • saved_query (::Google::Cloud::Asset::V1::SavedQuery, ::Hash) (defaults to: nil) —

      Required. The saved query to update.

      The saved query's name field is used to identify the one to update, which has format as below:

      • projects/project_number/savedQueries/saved_query_id
      • folders/folder_number/savedQueries/saved_query_id
      • organizations/organization_number/savedQueries/saved_query_id
    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      Required. The list of fields to update.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
 
# File 'lib/google/cloud/asset/v1/asset_service/client.rb', line 2203

def update_saved_query request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Asset::V1::UpdateSavedQueryRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_saved_query.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Asset::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.saved_query&.name
    header_params["saved_query.name"] = request.saved_query.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_saved_query.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_saved_query.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @asset_service_stub.call_rpc :update_saved_query, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end