Cloud Asset V1 API - Class Google::Cloud::Asset::V1::AssetService::Client (v0.19.0)

Stay organized with collections Save and categorize content based on your preferences.

Reference documentation and code samples for the Cloud Asset V1 API class Google::Cloud::Asset::V1::AssetService::Client.

Client for the AssetService service.

Asset service definition.

Inherits

  • Object

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the AssetService Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Example
# Modify the configuration for all AssetService clients
::Google::Cloud::Asset::V1::AssetService::Client.configure do |config|
  config.timeout = 10.0
end

#analyze_iam_policy

def analyze_iam_policy(request, options = nil) -> ::Google::Cloud::Asset::V1::AnalyzeIamPolicyResponse
def 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.

Overloads
def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def 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) — Required. The request query.
  • saved_analysis_query (::String) — Optional. The name of a saved query, which must be in the format of:

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

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

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

  • execution_timeout (::Google::Protobuf::Duration, ::Hash) — 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
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/asset/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Asset::V1::AssetService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Asset::V1::AnalyzeIamPolicyRequest.new

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

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

#analyze_iam_policy_longrunning

def analyze_iam_policy_longrunning(request, options = nil) -> ::Gapic::Operation
def 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.

Overloads
def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def 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) — Required. The request query.
  • saved_analysis_query (::String) — Optional. The name of a saved query, which must be in the format of:

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

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

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

  • output_config (::Google::Cloud::Asset::V1::IamPolicyAnalysisOutputConfig, ::Hash) — 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.
Example

Basic example

require "google/cloud/asset/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Asset::V1::AssetService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Asset::V1::AnalyzeIamPolicyLongrunningRequest.new

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

# The returned object is of type Gapic::Operation. You can use this
# object to check the status of an operation, cancel it, or wait
# for results. Here is how to block until completion:
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "Error!"
end

#analyze_move

def analyze_move(request, options = nil) -> ::Google::Cloud::Asset::V1::AnalyzeMoveResponse
def 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.

Overloads
def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def 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) — Required. Name of the resource to perform the analysis against. Only GCP Project are supported as of today. Hence, this can only be Project ID (such as "projects/my-project-id") or a Project Number (such as "projects/12345").
  • destination_parent (::String) — Required. Name of the GCP Folder or Organization to reparent the target resource. The analysis will be performed against hypothetically moving the resource to this specified desitination parent. This can only be a Folder number (such as "folders/123") or an Organization number (such as "organizations/123").
  • view (::Google::Cloud::Asset::V1::AnalyzeMoveRequest::AnalysisView) — 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
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/asset/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Asset::V1::AssetService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Asset::V1::AnalyzeMoveRequest.new

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

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

#batch_get_assets_history

def batch_get_assets_history(request, options = nil) -> ::Google::Cloud::Asset::V1::BatchGetAssetsHistoryResponse
def 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.

Overloads
def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def 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) — 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>) — 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) — Optional. The content type.
  • read_time_window (::Google::Cloud::Asset::V1::TimeWindow, ::Hash) — 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>) —

    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
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/asset/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Asset::V1::AssetService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Asset::V1::BatchGetAssetsHistoryRequest.new

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

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

#batch_get_effective_iam_policies

def batch_get_effective_iam_policies(request, options = nil) -> ::Google::Cloud::Asset::V1::BatchGetEffectiveIamPoliciesResponse
def batch_get_effective_iam_policies(scope: nil, names: nil) -> ::Google::Cloud::Asset::V1::BatchGetEffectiveIamPoliciesResponse

Gets effective IAM policies for a batch of resources.

Overloads
def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def 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) — 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>) — Required. The names refer to the full_resource_names of searchable asset types. A maximum of 20 resources' effective policies can be retrieved in a batch.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/asset/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Asset::V1::AssetService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Asset::V1::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

#configure

def 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 Client.configure.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter

#create_feed

def create_feed(request, options = nil) -> ::Google::Cloud::Asset::V1::Feed
def 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.

Overloads
def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def 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) — 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) — 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) — 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
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/asset/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Asset::V1::AssetService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Asset::V1::CreateFeedRequest.new

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

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

#create_saved_query

def create_saved_query(request, options = nil) -> ::Google::Cloud::Asset::V1::SavedQuery
def 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.

Overloads
def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def 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) — 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) — 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) — 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
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/asset/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Asset::V1::AssetService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Asset::V1::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

#delete_feed

def delete_feed(request, options = nil) -> ::Google::Protobuf::Empty
def delete_feed(name: nil) -> ::Google::Protobuf::Empty

Deletes an asset feed.

Overloads
def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def 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).
Parameter
  • name (::String) — 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
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/asset/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Asset::V1::AssetService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Asset::V1::DeleteFeedRequest.new

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

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

#delete_saved_query

def delete_saved_query(request, options = nil) -> ::Google::Protobuf::Empty
def delete_saved_query(name: nil) -> ::Google::Protobuf::Empty

Deletes a saved query.

Overloads
def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def 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).
Parameter
  • name (::String) —

    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
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/asset/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Asset::V1::AssetService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Asset::V1::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

#export_assets

def export_assets(request, options = nil) -> ::Gapic::Operation
def 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.

Overloads
def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def 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) — 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) — 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>) — 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) — Asset content type. If not specified, no content but the asset name will be returned.
  • output_config (::Google::Cloud::Asset::V1::OutputConfig, ::Hash) — Required. Output configuration indicating where the results will be output to.
  • relationship_types (::Array<::String>) —

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

Basic example

require "google/cloud/asset/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Asset::V1::AssetService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Asset::V1::ExportAssetsRequest.new

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

# The returned object is of type Gapic::Operation. You can use this
# object to check the status of an operation, cancel it, or wait
# for results. Here is how to block until completion:
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "Error!"
end

#get_feed

def get_feed(request, options = nil) -> ::Google::Cloud::Asset::V1::Feed
def get_feed(name: nil) -> ::Google::Cloud::Asset::V1::Feed

Gets details about an asset feed.

Overloads
def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def 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).
Parameter
  • name (::String) — 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
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/asset/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Asset::V1::AssetService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Asset::V1::GetFeedRequest.new

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

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

#get_saved_query

def get_saved_query(request, options = nil) -> ::Google::Cloud::Asset::V1::SavedQuery
def get_saved_query(name: nil) -> ::Google::Cloud::Asset::V1::SavedQuery

Gets details about a saved query.

Overloads
def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def 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).
Parameter
  • name (::String) —

    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
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/asset/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Asset::V1::AssetService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Asset::V1::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

#initialize

def initialize() { |config| ... } -> Client

Create a new AssetService client object.

Yields
  • (config) — Configure the AssetService client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example
# 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

#list_assets

def list_assets(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Asset::V1::Asset>
def 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.

Overloads
def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def 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) — 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) — 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>) — 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) — Asset content type. If not specified, no content but the asset name will be returned.
  • page_size (::Integer) — 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) — 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>) —

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

Basic example

require "google/cloud/asset/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Asset::V1::AssetService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Asset::V1::ListAssetsRequest.new

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

# The returned object is of type Gapic::PagedEnumerable. You can
# iterate over all elements by calling #each, and the enumerable
# will lazily make API calls to fetch subsequent pages. Other
# methods are also available for managing paging directly.
result.each do |response|
  # Each element is of type ::Google::Cloud::Asset::V1::Asset.
  p response
end

#list_feeds

def list_feeds(request, options = nil) -> ::Google::Cloud::Asset::V1::ListFeedsResponse
def list_feeds(parent: nil) -> ::Google::Cloud::Asset::V1::ListFeedsResponse

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

Overloads
def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def 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).
Parameter
  • parent (::String) — 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
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/asset/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Asset::V1::AssetService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Asset::V1::ListFeedsRequest.new

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

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

#list_saved_queries

def list_saved_queries(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Asset::V1::SavedQuery>
def 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.

Overloads
def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def 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) — 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) — 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) — 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) — 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.
Example

Basic example

require "google/cloud/asset/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Asset::V1::AssetService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Asset::V1::ListSavedQueriesRequest.new

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

# The returned object is of type Gapic::PagedEnumerable. You can
# iterate over all elements by calling #each, and the enumerable
# will lazily make API calls to fetch subsequent pages. Other
# methods are also available for managing paging directly.
result.each do |response|
  # Each element is of type ::Google::Cloud::Asset::V1::SavedQuery.
  p response
end

#operations_client

def operations_client() -> ::Google::Cloud::Asset::V1::AssetService::Operations

Get the associated client for long-running operations.

#search_all_iam_policies

def search_all_iam_policies(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Asset::V1::IamPolicySearchResult>
def 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.

Overloads
def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def 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) —

    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) —

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

    Examples:

    • policy: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) — Optional. The page size for search result pagination. Page size is capped at 500 even if a larger value is given. If set to zero, server will pick an appropriate default. Returned results may be fewer than requested. When this happens, there could be more results as long as next_page_token is returned.
  • page_token (::String) — 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>) — Optional. A list of asset types that the IAM policies are attached to. If empty, it will search the IAM policies that are attached to all the searchable asset types.

    Regular expressions are also supported. For example:

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

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

  • order_by (::String) —

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

Basic example

require "google/cloud/asset/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Asset::V1::AssetService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Asset::V1::SearchAllIamPoliciesRequest.new

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

# The returned object is of type Gapic::PagedEnumerable. You can
# iterate over all elements by calling #each, and the enumerable
# will lazily make API calls to fetch subsequent pages. Other
# methods are also available for managing paging directly.
result.each do |response|
  # Each element is of type ::Google::Cloud::Asset::V1::IamPolicySearchResult.
  p response
end

#search_all_resources

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

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

Overloads
def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def 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) —

    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) —

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

    Examples:

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

    Regular expressions are also supported. For example:

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

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

  • page_size (::Integer) — Optional. The page size for search result pagination. Page size is capped at 500 even if a larger value is given. If set to zero, server will pick an appropriate default. Returned results may be fewer than requested. When this happens, there could be more results as long as next_page_token is returned.
  • page_token (::String) — 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) — Optional. A comma-separated list of fields specifying the sorting order of the results. The default order is ascending. Add " DESC" after the field name to indicate descending order. Redundant space characters are ignored. Example: "location DESC, name". Only singular primitive fields in the response are sortable:

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

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

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

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

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

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

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/asset/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Asset::V1::AssetService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Asset::V1::SearchAllResourcesRequest.new

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

# The returned object is of type Gapic::PagedEnumerable. You can
# iterate over all elements by calling #each, and the enumerable
# will lazily make API calls to fetch subsequent pages. Other
# methods are also available for managing paging directly.
result.each do |response|
  # Each element is of type ::Google::Cloud::Asset::V1::ResourceSearchResult.
  p response
end

#update_feed

def update_feed(request, options = nil) -> ::Google::Cloud::Asset::V1::Feed
def update_feed(feed: nil, update_mask: nil) -> ::Google::Cloud::Asset::V1::Feed

Updates an asset feed configuration.

Overloads
def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def 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) — 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) — 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
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/asset/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Asset::V1::AssetService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Asset::V1::UpdateFeedRequest.new

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

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

#update_saved_query

def update_saved_query(request, options = nil) -> ::Google::Cloud::Asset::V1::SavedQuery
def update_saved_query(saved_query: nil, update_mask: nil) -> ::Google::Cloud::Asset::V1::SavedQuery

Updates a saved query.

Overloads
def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def 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) —

    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) — Required. The list of fields to update.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/asset/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Asset::V1::AssetService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Asset::V1::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