google-api-ruby-client/generated/google/apis/cloudasset_v1/service.rb

543 lines
31 KiB
Ruby
Raw Normal View History

# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module CloudassetV1
# Cloud Asset API
#
# The cloud asset API manages the history and inventory of cloud resources.
#
# @example
# require 'google/apis/cloudasset_v1'
#
# Cloudasset = Google::Apis::CloudassetV1 # Alias the module
# service = Cloudasset::CloudAssetService.new
#
# @see https://cloud.google.com/asset-inventory/docs/quickstart
class CloudAssetService < Google::Apis::Core::BaseService
# @return [String]
# API key. Your API key identifies your project and provides you with API access,
# quota, and reports. Required unless you provide an OAuth 2.0 token.
attr_accessor :key
# @return [String]
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
attr_accessor :quota_user
def initialize
super('https://cloudasset.googleapis.com/', '')
@batch_path = 'batch'
end
# Creates a feed in a parent project/folder/organization to listen to its
# asset updates.
# @param [String] parent
# 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").
# @param [Google::Apis::CloudassetV1::CreateFeedRequest] create_feed_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudassetV1::Feed] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudassetV1::Feed]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_feed(parent, create_feed_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}/feeds', options)
command.request_representation = Google::Apis::CloudassetV1::CreateFeedRequest::Representation
command.request_object = create_feed_request_object
command.response_representation = Google::Apis::CloudassetV1::Feed::Representation
command.response_class = Google::Apis::CloudassetV1::Feed
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes an asset feed.
# @param [String] name
# 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
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudassetV1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudassetV1::Empty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_feed(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}', options)
command.response_representation = Google::Apis::CloudassetV1::Empty::Representation
command.response_class = Google::Apis::CloudassetV1::Empty
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets details about an asset feed.
# @param [String] name
# 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
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudassetV1::Feed] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudassetV1::Feed]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_feed(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::CloudassetV1::Feed::Representation
command.response_class = Google::Apis::CloudassetV1::Feed
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists all asset feeds in a parent project/folder/organization.
# @param [String] parent
# 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").
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudassetV1::ListFeedsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudassetV1::ListFeedsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_feeds(parent, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/feeds', options)
command.response_representation = Google::Apis::CloudassetV1::ListFeedsResponse::Representation
command.response_class = Google::Apis::CloudassetV1::ListFeedsResponse
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates an asset feed configuration.
# @param [String] name
# Required. The format will be
# projects/`project_number`/feeds/`client-assigned_feed_identifier` or
# folders/`folder_number`/feeds/`client-assigned_feed_identifier` or
# organizations/`organization_number`/feeds/`client-assigned_feed_identifier`
# The client-assigned feed identifier must be unique within the parent
# project/folder/organization.
# @param [Google::Apis::CloudassetV1::UpdateFeedRequest] update_feed_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudassetV1::Feed] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudassetV1::Feed]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def patch_feed(name, update_feed_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:patch, 'v1/{+name}', options)
command.request_representation = Google::Apis::CloudassetV1::UpdateFeedRequest::Representation
command.request_object = update_feed_request_object
command.response_representation = Google::Apis::CloudassetV1::Feed::Representation
command.response_class = Google::Apis::CloudassetV1::Feed
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets the latest state of a long-running operation. Clients can use this
# method to poll the operation result at intervals as recommended by the API
# service.
# @param [String] name
# The name of the operation resource.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudassetV1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudassetV1::Operation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_operation(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::CloudassetV1::Operation::Representation
command.response_class = Google::Apis::CloudassetV1::Operation
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Batch gets the update history of assets that overlap a time window.
# For RESOURCE content, this API outputs history with asset in both
# non-delete or deleted status.
# 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.
# If a specified asset does not exist, this API returns an INVALID_ARGUMENT
# error.
# @param [String] parent
# 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").
# @param [Array<String>, String] asset_names
# 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.
# @param [String] content_type
# Optional. The content type.
# @param [String] read_time_window_end_time
Autogenerated update (2020-04-13) Delete: - cloudprivatecatalog_v1beta1 - cloudprivatecatalogproducer_v1beta1 - mirror_v1 - oauth2_v1 - proximitybeacon_v1beta1 Update: - accesscontextmanager_v1 - accesscontextmanager_v1beta - adexchangebuyer2_v2beta1 - admin_directory_v1 - adsense_v1_4 - adsensehost_v4_1 - alertcenter_v1beta1 - androiddeviceprovisioning_v1 - androidenterprise_v1 - androidmanagement_v1 - androidpublisher_v2 - androidpublisher_v3 - appengine_v1 - appengine_v1alpha - appengine_v1beta - bigquery_v2 - bigquerydatatransfer_v1 - bigqueryreservation_v1 - bigqueryreservation_v1beta1 - bigtableadmin_v1 - bigtableadmin_v2 - billingbudgets_v1beta1 - blogger_v2 - blogger_v3 - calendar_v3 - chat_v1 - cloudasset_v1 - cloudbuild_v1 - cloudbuild_v1alpha1 - cloudbuild_v1alpha2 - clouddebugger_v2 - cloudidentity_v1 - cloudidentity_v1beta1 - cloudresourcemanager_v1 - cloudsearch_v1 - cloudshell_v1 - cloudshell_v1alpha1 - cloudtasks_v2beta2 - cloudtrace_v1 - cloudtrace_v2 - cloudtrace_v2beta1 - composer_v1 - composer_v1beta1 - compute_alpha - compute_beta - compute_v1 - container_v1 - container_v1beta1 - content_v2 - content_v2_1 - customsearch_v1 - datacatalog_v1beta1 - dataflow_v1b3 - datafusion_v1beta1 - dataproc_v1 - dataproc_v1beta2 - dfareporting_v3_3 - dfareporting_v3_4 - dialogflow_v2 - dialogflow_v2beta1 - dlp_v2 - doubleclickbidmanager_v1_1 - doubleclicksearch_v2 - drive_v2 - drive_v3 - file_v1 - file_v1beta1 - firebase_v1beta1 - firebasehosting_v1beta1 - firestore_v1 - firestore_v1beta1 - games_configuration_v1configuration - games_management_v1management - games_v1 - genomics_v2alpha1 - gmail_v1 - healthcare_v1beta1 - homegraph_v1 - iap_v1 - jobs_v2 - language_v1 - language_v1beta1 - language_v1beta2 - logging_v2 - managedidentities_v1 - managedidentities_v1alpha1 - managedidentities_v1beta1 - manufacturers_v1 - ml_v1 - monitoring_v1 - monitoring_v3 - oauth2_v2 - osconfig_v1beta - people_v1 - prod_tt_sasportal_v1alpha1 - pubsub_v1 - pubsub_v1beta2 - recommender_v1beta1 - redis_v1 - redis_v1beta1 - remotebuildexecution_v1 - remotebuildexecution_v1alpha - remotebuildexecution_v2 - run_v1 - sasportal_v1alpha1 - secretmanager_v1 - secretmanager_v1beta1 - securitycenter_v1 - securitycenter_v1beta1 - securitycenter_v1p1alpha1 - securitycenter_v1p1beta1 - serviceconsumermanagement_v1 - servicecontrol_v1 - servicemanagement_v1 - servicenetworking_v1 - servicenetworking_v1beta - serviceusage_v1 - serviceusage_v1beta1 - sheets_v4 - spanner_v1 - speech_v1 - speech_v1p1beta1 - speech_v2beta1 - sql_v1beta4 - storage_v1 - storagetransfer_v1 - toolresults_v1beta3 - vault_v1 - videointelligence_v1 - videointelligence_v1beta2 - videointelligence_v1p1beta1 - videointelligence_v1p2beta1 - videointelligence_v1p3beta1 - vision_v1 - vision_v1p1beta1 - vision_v1p2beta1 - youtube_partner_v1 - youtube_v3
2020-04-13 16:49:10 +00:00
# End time of the time window (inclusive). If not specified, the current
# timestamp is used instead.
# @param [String] read_time_window_start_time
# Start time of the time window (exclusive).
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudassetV1::BatchGetAssetsHistoryResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudassetV1::BatchGetAssetsHistoryResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def batch_get_assets_history(parent, asset_names: nil, content_type: nil, read_time_window_end_time: nil, read_time_window_start_time: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}:batchGetAssetsHistory', options)
command.response_representation = Google::Apis::CloudassetV1::BatchGetAssetsHistoryResponse::Representation
command.response_class = Google::Apis::CloudassetV1::BatchGetAssetsHistoryResponse
command.params['parent'] = parent unless parent.nil?
command.query['assetNames'] = asset_names unless asset_names.nil?
command.query['contentType'] = content_type unless content_type.nil?
command.query['readTimeWindow.endTime'] = read_time_window_end_time unless read_time_window_end_time.nil?
command.query['readTimeWindow.startTime'] = read_time_window_start_time unless read_time_window_start_time.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Exports assets with time and resource types to a given Cloud Storage
# location. The output format is newline-delimited JSON. Each line represents
# a google.cloud.asset.v1.Asset in the JSON format.
# This API implements the google.longrunning.Operation API allowing 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.
# @param [String] parent
# 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").
# @param [Google::Apis::CloudassetV1::ExportAssetsRequest] export_assets_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudassetV1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudassetV1::Operation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def export_assets(parent, export_assets_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}:exportAssets', options)
command.request_representation = Google::Apis::CloudassetV1::ExportAssetsRequest::Representation
command.request_object = export_assets_request_object
command.response_representation = Google::Apis::CloudassetV1::Operation::Representation
command.response_class = Google::Apis::CloudassetV1::Operation
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Searches all the IAM policies within the given accessible scope (e.g., a
# project, a folder or an organization). Callers should have
# cloud.assets.SearchAllIamPolicies permission upon the requested scope,
# otherwise the request will be rejected.
# @param [String] scope
# Required. A scope can be a project, a folder or an organization. The search is
# limited to the IAM policies within the `scope`.
# The allowed values are:
# * projects/`PROJECT_ID`
# * projects/`PROJECT_NUMBER`
# * folders/`FOLDER_NUMBER`
# * organizations/`ORGANIZATION_NUMBER`
# @param [Fixnum] page_size
# 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.
# @param [String] page_token
# 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.
# @param [String] query
# Optional. The query statement. An empty query can be specified to search all
# the IAM
# policies within the given `scope`.
# Examples:
# * `policy : "amy@gmail.com"` to find Cloud IAM policy bindings that
# specify user "amy@gmail.com".
# * `policy : "roles/compute.admin"` to find Cloud IAM policy bindings that
# specify the Compute Admin role.
# * `policy.role.permissions : "storage.buckets.update"` to find Cloud IAM
# policy bindings that specify a role containing "storage.buckets.update"
# permission.
# * `resource : "organizations/123"` to find Cloud IAM policy bindings that
# are set on "organizations/123".
# * `(resource : ("organizations/123" OR "folders/1234") AND policy : "amy")`
# to find Cloud IAM policy bindings that are set on "organizations/123" or
# "folders/1234", and also specify user "amy".
# See [how to construct a
# query](https://cloud.google.com/asset-inventory/docs/searching-iam-policies#
# how_to_construct_a_query)
# for more details.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudassetV1::SearchAllIamPoliciesResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudassetV1::SearchAllIamPoliciesResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def search_all_iam_policies(scope, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+scope}:searchAllIamPolicies', options)
command.response_representation = Google::Apis::CloudassetV1::SearchAllIamPoliciesResponse::Representation
command.response_class = Google::Apis::CloudassetV1::SearchAllIamPoliciesResponse
command.params['scope'] = scope unless scope.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['query'] = query unless query.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Searches all the resources within the given accessible scope (e.g., a
# project, a folder or an organization). Callers should have
# cloud.assets.SearchAllResources permission upon the requested scope,
# otherwise the request will be rejected.
# @param [String] scope
# Required. A scope can be a project, a folder or an organization. The search is
# limited to the resources within the `scope`.
# The allowed values are:
# * projects/`PROJECT_ID`
# * projects/`PROJECT_NUMBER`
# * folders/`FOLDER_NUMBER`
# * organizations/`ORGANIZATION_NUMBER`
# @param [Array<String>, String] asset_types
# Optional. A list of asset types that this request searches for. If empty, it
# will
# search all the [searchable asset
# types](https://cloud.google.com/asset-inventory/docs/supported-asset-types#
# searchable_asset_types).
# @param [String] order_by
# 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". See [supported resource metadata
# fields](https://cloud.google.com/asset-inventory/docs/searching-resources#
# query_on_resource_metadata_fields)
# for more details.
# @param [Fixnum] page_size
# 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.
# @param [String] page_token
# 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.
# @param [String] query
# Optional. The query statement. An empty query can be specified to search all
# the
# resources of certain `asset_types` within the given `scope`.
# Examples:
# * `name : "Important"` to find Cloud resources whose name contains
# "Important" as a word.
# * `displayName : "Impor*"` to find Cloud resources whose display name
# contains "Impor" as a word prefix.
# * `description : "*por*"` to find Cloud resources whose description
# contains "por" as a substring.
# * `location : "us-west*"` to find Cloud resources whose location is
# prefixed with "us-west".
# * `labels : "prod"` to find Cloud resources whose labels contain "prod" as
# a key or value.
# * `labels.env : "prod"` to find Cloud resources which have a label "env"
# and its value is "prod".
# * `labels.env : *` to find Cloud resources which have a label "env".
# * `"Important"` to find Cloud resources which contain "Important" as a word
# in any of the searchable fields.
# * `"Impor*"` to find Cloud resources which contain "Impor" as a word prefix
# in any of the searchable fields.
# * `"*por*"` to find Cloud resources which contain "por" as a substring in
# any of the searchable fields.
# * `("Important" AND location : ("us-west1" OR "global"))` to find Cloud
# resources which contain "Important" as a word in any of the searchable
# fields and are also located in the "us-west1" region or the "global"
# location.
# See [how to construct a
# query](https://cloud.google.com/asset-inventory/docs/searching-resources#
# how_to_construct_a_query)
# for more details.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudassetV1::SearchAllResourcesResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudassetV1::SearchAllResourcesResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def search_all_resources(scope, asset_types: nil, order_by: nil, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+scope}:searchAllResources', options)
command.response_representation = Google::Apis::CloudassetV1::SearchAllResourcesResponse::Representation
command.response_class = Google::Apis::CloudassetV1::SearchAllResourcesResponse
command.params['scope'] = scope unless scope.nil?
command.query['assetTypes'] = asset_types unless asset_types.nil?
command.query['orderBy'] = order_by unless order_by.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['query'] = query unless query.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
protected
def apply_command_defaults(command)
command.query['key'] = key unless key.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
end
end
end
end
end