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:



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/google/cloud/asset/v1/asset_service/client.rb', line 216

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.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_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
    config.universe_domain = @config.universe_domain
  end

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

Instance Attribute Details

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

Get the associated client for long-running operations.

Returns:



268
269
270
 
# File 'lib/google/cloud/asset/v1/asset_service/client.rb', line 268

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:



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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/google/cloud/asset/v1/asset_service/client.rb', line 62

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.rpcs.query_assets.timeout = 200.0
    default_config.rpcs.query_assets.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.create_saved_query.timeout = 60.0

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

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

    default_config.rpcs.update_saved_query.timeout = 60.0

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

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

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

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

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

    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, 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.



1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
 
# File 'lib/google/cloud/asset/v1/asset_service/client.rb', line 1685

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, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  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 it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
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, 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.



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
1845
1846
1847
1848
 
# File 'lib/google/cloud/asset/v1/asset_service/client.rb', line 1807

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, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  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 Google Cloud projects are supported as of today. Hence, this can only be a 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 Google Cloud 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.



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
1947
1948
1949
1950
 
# File 'lib/google/cloud/asset/v1/asset_service/client.rb', line 1910

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, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  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

#analyze_org_policies(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Asset::V1::AnalyzeOrgPoliciesResponse::OrgPolicyResult> #analyze_org_policies(scope: nil, constraint: nil, filter: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Asset::V1::AnalyzeOrgPoliciesResponse::OrgPolicyResult>

Analyzes organization policies under a scope.

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

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Asset::V1::AnalyzeOrgPoliciesResponse::OrgPolicyResult.
  p item
end

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Asset::V1::AnalyzeOrgPoliciesRequest, ::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_org_policies(scope: nil, constraint: nil, filter: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Asset::V1::AnalyzeOrgPoliciesResponse::OrgPolicyResult>

    Pass arguments to analyze_org_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. The organization to scope the request. Only organization policies within the scope will be analyzed.

      • organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456")
    • constraint (::String) (defaults to: nil) —

      Required. The name of the constraint to analyze organization policies for. The response only contains analyzed organization policies for the provided constraint.

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

      The expression to filter AnalyzeOrgPoliciesResponse.org_policy_results. Filtering is currently available for bare literal values and the following fields:

      • consolidated_policy.attached_resource
      • consolidated_policy.rules.enforce

      When filtering by a specific field, the only supported operator is =. For example, filtering by consolidated_policy.attached_resource="//cloudresourcemanager.googleapis.com/folders/001" will return all the Organization Policy results attached to "folders/001".

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

      The maximum number of items to return per page. If unspecified, AnalyzeOrgPoliciesResponse.org_policy_results will contain 20 items with a maximum of 200.

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

      The pagination token to retrieve the next page.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
 
# File 'lib/google/cloud/asset/v1/asset_service/client.rb', line 2769

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

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

  # 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_org_policies.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  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.analyze_org_policies.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.analyze_org_policies.retry_policy

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

  @asset_service_stub.call_rpc :analyze_org_policies, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @asset_service_stub, :analyze_org_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

#analyze_org_policy_governed_assets(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Asset::V1::AnalyzeOrgPolicyGovernedAssetsResponse::GovernedAsset> #analyze_org_policy_governed_assets(scope: nil, constraint: nil, filter: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Asset::V1::AnalyzeOrgPolicyGovernedAssetsResponse::GovernedAsset>

Analyzes organization policies governed assets (Google Cloud resources or policies) under a scope. This RPC supports custom constraints and the following canned constraints:

  • constraints/ainotebooks.accessMode
  • constraints/ainotebooks.disableFileDownloads
  • constraints/ainotebooks.disableRootAccess
  • constraints/ainotebooks.disableTerminal
  • constraints/ainotebooks.environmentOptions
  • constraints/ainotebooks.requireAutoUpgradeSchedule
  • constraints/ainotebooks.restrictVpcNetworks
  • constraints/compute.disableGuestAttributesAccess
  • constraints/compute.disableInstanceDataAccessApis
  • constraints/compute.disableNestedVirtualization
  • constraints/compute.disableSerialPortAccess
  • constraints/compute.disableSerialPortLogging
  • constraints/compute.disableVpcExternalIpv6
  • constraints/compute.requireOsLogin
  • constraints/compute.requireShieldedVm
  • constraints/compute.restrictLoadBalancerCreationForTypes
  • constraints/compute.restrictProtocolForwardingCreationForTypes
  • constraints/compute.restrictXpnProjectLienRemoval
  • constraints/compute.setNewProjectDefaultToZonalDNSOnly
  • constraints/compute.skipDefaultNetworkCreation
  • constraints/compute.trustedImageProjects
  • constraints/compute.vmCanIpForward
  • constraints/compute.vmExternalIpAccess
  • constraints/gcp.detailedAuditLoggingMode
  • constraints/gcp.resourceLocations
  • constraints/iam.allowedPolicyMemberDomains
  • constraints/iam.automaticIamGrantsForDefaultServiceAccounts
  • constraints/iam.disableServiceAccountCreation
  • constraints/iam.disableServiceAccountKeyCreation
  • constraints/iam.disableServiceAccountKeyUpload
  • constraints/iam.restrictCrossProjectServiceAccountLienRemoval
  • constraints/iam.serviceAccountKeyExpiryHours
  • constraints/resourcemanager.accessBoundaries
  • constraints/resourcemanager.allowedExportDestinations
  • constraints/sql.restrictAuthorizedNetworks
  • constraints/sql.restrictNoncompliantDiagnosticDataAccess
  • constraints/sql.restrictNoncompliantResourceCreation
  • constraints/sql.restrictPublicIp
  • constraints/storage.publicAccessPrevention
  • constraints/storage.restrictAuthTypes
  • constraints/storage.uniformBucketLevelAccess

This RPC only returns either resources of types supported by search APIs or IAM policies.

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

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Asset::V1::AnalyzeOrgPolicyGovernedAssetsResponse::GovernedAsset.
  p item
end

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Asset::V1::AnalyzeOrgPolicyGovernedAssetsRequest, ::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_org_policy_governed_assets(scope: nil, constraint: nil, filter: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Asset::V1::AnalyzeOrgPolicyGovernedAssetsResponse::GovernedAsset>

    Pass arguments to analyze_org_policy_governed_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:

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

      Required. The organization to scope the request. Only organization policies within the scope will be analyzed. The output assets will also be limited to the ones governed by those in-scope organization policies.

      • organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456")
    • constraint (::String) (defaults to: nil) —

      Required. The name of the constraint to analyze governed assets for. The analysis only contains analyzed organization policies for the provided constraint.

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

      The expression to filter AnalyzeOrgPolicyGovernedAssetsResponse.governed_assets.

      For governed resources, filtering is currently available for bare literal values and the following fields:

      • governed_resource.project
      • governed_resource.folders
      • consolidated_policy.rules.enforce When filtering by governed_resource.project or consolidated_policy.rules.enforce, the only supported operator is =. When filtering by governed_resource.folders, the supported operators are = and :. For example, filtering by governed_resource.project="projects/12345678" will return all the governed resources under "projects/12345678", including the project itself if applicable.

      For governed IAM policies, filtering is currently available for bare literal values and the following fields:

      • governed_iam_policy.project
      • governed_iam_policy.folders
      • consolidated_policy.rules.enforce When filtering by governed_iam_policy.project or consolidated_policy.rules.enforce, the only supported operator is =. When filtering by governed_iam_policy.folders, the supported operators are = and :. For example, filtering by governed_iam_policy.folders:"folders/12345678" will return all the governed IAM policies under "folders/001".
    • page_size (::Integer) (defaults to: nil) —

      The maximum number of items to return per page. If unspecified, AnalyzeOrgPolicyGovernedAssetsResponse.governed_assets will contain 100 items with a maximum of 200.

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

      The pagination token to retrieve the next page.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
 
# File 'lib/google/cloud/asset/v1/asset_service/client.rb', line 3070

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

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

  # 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_org_policy_governed_assets.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  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.analyze_org_policy_governed_assets.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.analyze_org_policy_governed_assets.retry_policy

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

  @asset_service_stub.call_rpc :analyze_org_policy_governed_assets, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @asset_service_stub, :analyze_org_policy_governed_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

#analyze_org_policy_governed_containers(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Asset::V1::AnalyzeOrgPolicyGovernedContainersResponse::GovernedContainer> #analyze_org_policy_governed_containers(scope: nil, constraint: nil, filter: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Asset::V1::AnalyzeOrgPolicyGovernedContainersResponse::GovernedContainer>

Analyzes organization policies governed containers (projects, folders or organization) under a scope.

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

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Asset::V1::AnalyzeOrgPolicyGovernedContainersResponse::GovernedContainer.
  p item
end

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Asset::V1::AnalyzeOrgPolicyGovernedContainersRequest, ::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_org_policy_governed_containers(scope: nil, constraint: nil, filter: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Asset::V1::AnalyzeOrgPolicyGovernedContainersResponse::GovernedContainer>

    Pass arguments to analyze_org_policy_governed_containers 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. The organization to scope the request. Only organization policies within the scope will be analyzed. The output containers will also be limited to the ones governed by those in-scope organization policies.

      • organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456")
    • constraint (::String) (defaults to: nil) —

      Required. The name of the constraint to analyze governed containers for. The analysis only contains organization policies for the provided constraint.

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

      The expression to filter AnalyzeOrgPolicyGovernedContainersResponse.governed_containers. Filtering is currently available for bare literal values and the following fields:

      • parent
      • consolidated_policy.rules.enforce

      When filtering by a specific field, the only supported operator is =. For example, filtering by parent="//cloudresourcemanager.googleapis.com/folders/001" will return all the containers under "folders/001".

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

      The maximum number of items to return per page. If unspecified, AnalyzeOrgPolicyGovernedContainersResponse.governed_containers will contain 100 items with a maximum of 200.

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

      The pagination token to retrieve the next page.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
 
# File 'lib/google/cloud/asset/v1/asset_service/client.rb', line 2888

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

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

  # 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_org_policy_governed_containers.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  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.analyze_org_policy_governed_containers.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.analyze_org_policy_governed_containers.retry_policy

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

  @asset_service_stub.call_rpc :analyze_org_policy_governed_containers, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @asset_service_stub, :analyze_org_policy_governed_containers, 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

#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.



660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
 
# File 'lib/google/cloud/asset/v1/asset_service/client.rb', line 660

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, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  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 the asset types supported by search APIs. 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.



2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
 
# File 'lib/google/cloud/asset/v1/asset_service/client.rb', line 2654

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, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  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:



186
187
188
189
 
# File 'lib/google/cloud/asset/v1/asset_service/client.rb', line 186

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.



759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
 
# File 'lib/google/cloud/asset/v1/asset_service/client.rb', line 759

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, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  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.



2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
 
# File 'lib/google/cloud/asset/v1/asset_service/client.rb', line 2164

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, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  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.



1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
 
# File 'lib/google/cloud/asset/v1/asset_service/client.rb', line 1119

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, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  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.



2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
 
# File 'lib/google/cloud/asset/v1/asset_service/client.rb', line 2552

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, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  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 it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
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.



383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
 
# File 'lib/google/cloud/asset/v1/asset_service/client.rb', line 383

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, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  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.



848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
 
# File 'lib/google/cloud/asset/v1/asset_service/client.rb', line 848

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, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  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.



2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
 
# File 'lib/google/cloud/asset/v1/asset_service/client.rb', line 2254

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, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  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 elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Asset::V1::Asset.
  p item
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.



530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
 
# File 'lib/google/cloud/asset/v1/asset_service/client.rb', line 530

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, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  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.



936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
 
# File 'lib/google/cloud/asset/v1/asset_service/client.rb', line 936

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, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  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 elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Asset::V1::SavedQuery.
  p item
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.



2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
 
# File 'lib/google/cloud/asset/v1/asset_service/client.rb', line 2365

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, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  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

#query_assets(request, options = nil) ⇒ ::Google::Cloud::Asset::V1::QueryAssetsResponse #query_assets(parent: nil, statement: nil, job_reference: nil, page_size: nil, page_token: nil, timeout: nil, read_time_window: nil, read_time: nil, output_config: nil) ⇒ ::Google::Cloud::Asset::V1::QueryAssetsResponse

Issue a job that queries assets using a SQL statement compatible with BigQuery SQL.

If the query execution finishes within timeout and there's no pagination, the full query results will be returned in the QueryAssetsResponse.

Otherwise, full query results can be obtained by issuing extra requests with the job_reference from the a previous QueryAssets call.

Note, the query result has approximately 10 GB limitation enforced by BigQuery. Queries return larger results will result in errors.

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

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

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

Overloads:

  • #query_assets(request, options = nil) ⇒ ::Google::Cloud::Asset::V1::QueryAssetsResponse

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

    Parameters:

    • request (::Google::Cloud::Asset::V1::QueryAssetsRequest, ::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.

  • #query_assets(parent: nil, statement: nil, job_reference: nil, page_size: nil, page_token: nil, timeout: nil, read_time_window: nil, read_time: nil, output_config: nil) ⇒ ::Google::Cloud::Asset::V1::QueryAssetsResponse

    Pass arguments to query_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").

      Only assets belonging to the parent will be returned.

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

      Optional. A SQL statement that's compatible with BigQuery SQL.

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

      Optional. Reference to the query job, which is from the QueryAssetsResponse of previous QueryAssets call.

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

      Optional. The maximum number of rows to return in the results. Responses are limited to 10 MB and 1000 rows.

      By default, the maximum row count is 1000. When the byte or row count limit is reached, the rest of the query results will be paginated.

      The field will be ignored when [output_config] is specified.

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

      Optional. A page token received from previous QueryAssets.

      The field will be ignored when [output_config] is specified.

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

      Optional. Specifies the maximum amount of time that the client is willing to wait for the query to complete. By default, this limit is 5 min for the first query, and 1 minute for the following queries. If the query is complete, the done field in the QueryAssetsResponse is true, otherwise false.

      Like BigQuery jobs.query API The call is not guaranteed to wait for the specified timeout; it typically returns after around 200 seconds (200,000 milliseconds), even if the query is not complete.

      The field will be ignored when [output_config] is specified.

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

      Optional. [start_time] is required. [start_time] must be less than [end_time] Defaults [end_time] to now if [start_time] is set and [end_time] isn't. Maximum permitted time range is 7 days.

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

      Optional. Queries cloud assets as they appeared at the specified point in time.

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

      Optional. Destination where the query results will be saved.

      When this field is specified, the query results won't be saved in the [QueryAssetsResponse.query_result]. Instead [QueryAssetsResponse.output_config] will be set.

      Meanwhile, [QueryAssetsResponse.job_reference] will be set and can be used to check the status of the query job when passed to a following [QueryAssets] API call.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
 
# File 'lib/google/cloud/asset/v1/asset_service/client.rb', line 2061

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

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

  # 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.query_assets.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  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.query_assets.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.query_assets.retry_policy

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

  @asset_service_stub.call_rpc :query_assets, 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

#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 elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Asset::V1::IamPolicySearchResult.
  p item
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 IAM policy binding, including its principals, roles, and IAM conditions. The returned IAM policies will only contain the bindings that match your query. To learn more about the IAM policy structure, see the IAM policy documentation.

      Examples:

      • policy:amy@gmail.com to find IAM policy bindings that specify user "amy@gmail.com".
      • 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 or a negative value, 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 asset types supported by search APIs

      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.



1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
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
 
# File 'lib/google/cloud/asset/v1/asset_service/client.rb', line 1568

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, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  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 Google 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 elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Asset::V1::ResourceSearchResult.
  p item
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 Google Cloud resources whose name contains Important as a word.
      • name=Important to find the Google Cloud resource whose name is exactly Important.
      • displayName:Impor* to find Google Cloud resources whose display name contains Impor as a prefix of any word in the field.
      • location:us-west* to find Google Cloud resources whose location contains both us and west as prefixes.
      • labels:prod to find Google Cloud resources whose labels contain prod as a key or value.
      • labels.env:prod to find Google Cloud resources that have a label env and its value is prod.
      • labels.env:* to find Google Cloud resources that have a label env.
      • tagKeys:env to find Google Cloud resources that have directly attached tags where the TagKey.namespacedName contains env.
      • tagValues:prod* to find Google Cloud resources that have directly attached tags where the TagValue.namespacedName contains a word prefixed by prod.
      • tagValueIds=tagValues/123 to find Google Cloud resources that have directly attached tags where the TagValue.name is exactly tagValues/123.
      • effectiveTagKeys:env to find Google Cloud resources that have directly attached or inherited tags where the TagKey.namespacedName contains env.
      • effectiveTagValues:prod* to find Google Cloud resources that have directly attached or inherited tags where the TagValue.namespacedName contains a word prefixed by prod.
      • effectiveTagValueIds=tagValues/123 to find Google Cloud resources that have directly attached or inherited tags where the TagValue.name is exactly tagValues/123.
      • kmsKey:key to find Google Cloud resources encrypted with a customer-managed encryption key whose name contains key as a word. This field is deprecated. Use the kmsKeys field to retrieve Cloud KMS key information.
      • kmsKeys:key to find Google Cloud resources encrypted with customer-managed encryption keys whose name contains the word key.
      • relationships:instance-group-1 to find Google Cloud resources that have relationships with instance-group-1 in the related resource name.
      • relationships:INSTANCE_TO_INSTANCEGROUP to find Compute Engine instances that have relationships of type INSTANCE_TO_INSTANCEGROUP.
      • relationships.INSTANCE_TO_INSTANCEGROUP:instance-group-1 to find Compute Engine instances that have relationships with instance-group-1 in the Compute Engine instance group resource name, for relationship type INSTANCE_TO_INSTANCEGROUP.
      • sccSecurityMarks.key=value to find Cloud resources that are attached with security marks whose key is key and value is value.
      • sccSecurityMarks.key:* to find Cloud resources that are attached with security marks whose key is key.
      • state:ACTIVE to find Google Cloud resources whose state contains ACTIVE as a word.
      • NOT state:ACTIVE to find Google Cloud resources whose state doesn't contain ACTIVE as a word.
      • createTime<1609459200 to find Google 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 Google 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 Google Cloud resources that contain Important as a word in any of the searchable fields.
      • Impor* to find Google 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 Google 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 asset types supported by search APIs.

      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 or a negative value, 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 the following fields in the response are sortable:

      • name
      • assetType
      • project
      • displayName
      • description
      • location
      • createTime
      • updateTime
      • state
      • parentFullResourceName
      • parentAssetType
    • read_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      Optional. A comma-separated list of fields that you want returned in the results. The following fields are returned by default if not specified:

      • name
      • assetType
      • project
      • folders
      • organization
      • displayName
      • description
      • location
      • labels
      • tags
      • effectiveTags
      • networkTags
      • kmsKeys
      • createTime
      • updateTime
      • state
      • additionalAttributes
      • parentFullResourceName
      • parentAssetType

      Some fields of large size, such as versionedResources, attachedResources, effectiveTags etc., are not returned by default, but you can specify them in the read_mask parameter if you want to include them. If "*" is specified, all available fields are returned. Examples: "name,location", "name,versionedResources", "*". 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.



1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
 
# File 'lib/google/cloud/asset/v1/asset_service/client.rb', line 1380

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, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  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

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


196
197
198
 
# File 'lib/google/cloud/asset/v1/asset_service/client.rb', line 196

def universe_domain
  @asset_service_stub.universe_domain
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.



1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
 
# File 'lib/google/cloud/asset/v1/asset_service/client.rb', line 1030

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, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  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.



2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
 
# File 'lib/google/cloud/asset/v1/asset_service/client.rb', line 2461

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, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  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