Class: Google::Apis::CloudassetV1p1beta1::CloudAssetService

Inherits:
Google::Apis::Core::BaseService show all
Defined in:
generated/google/apis/cloudasset_v1p1beta1/service.rb

Overview

Cloud Asset API

The cloud asset API manages the history and inventory of cloud resources.

Examples:

require 'google/apis/cloudasset_v1p1beta1'

Cloudasset = Google::Apis::CloudassetV1p1beta1 # Alias the module
service = Cloudasset::CloudAssetService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Google::Apis::Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Google::Apis::Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Google::Apis::Core::Logging

#logger

Constructor Details

#initializeCloudAssetService

Returns a new instance of CloudAssetService.



45
46
47
48
# File 'generated/google/apis/cloudasset_v1p1beta1/service.rb', line 45

def initialize
  super('https://cloudasset.googleapis.com/', '')
  @batch_path = 'batch'
end

Instance Attribute Details

#keyString

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

Returns:

  • (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.



38
39
40
# File 'generated/google/apis/cloudasset_v1p1beta1/service.rb', line 38

def key
  @key
end

#quota_userString

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

Returns:

  • (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.



43
44
45
# File 'generated/google/apis/cloudasset_v1p1beta1/service.rb', line 43

def quota_user
  @quota_user
end

Instance Method Details

#search_iam_policy_all(scope, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudassetV1p1beta1::SearchAllIamPoliciesResponse

Searches all the IAM policies under a given accessible CRM scope (project/folder/organization). This RPC gives callers especially admins the ability to search all the IAM policies under a scope, even if they don't have .getIamPolicy permission of all the IAM policies. Callers should have cloud.assets.SearchAllIamPolicies permission on the requested scope, otherwise it will be rejected.

Parameters:

  • scope (String)

    Required. The relative name of an asset. The search is limited to the resources within the scope. The allowed value must be:

    • Organization number (such as "organizations/123")
    • Folder number(such as "folders/1234")
    • Project number (such as "projects/12345")
    • Project id (such as "projects/abc")
  • page_size (Fixnum) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

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

  • query (String) (defaults to: nil)

    Optional. The query statement. Examples:

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



98
99
100
101
102
103
104
105
106
107
108
109
# File 'generated/google/apis/cloudasset_v1p1beta1/service.rb', line 98

def search_iam_policy_all(scope, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1p1beta1/{+scope}/iamPolicies:searchAll', options)
  command.response_representation = Google::Apis::CloudassetV1p1beta1::SearchAllIamPoliciesResponse::Representation
  command.response_class = Google::Apis::CloudassetV1p1beta1::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

#search_resource_all(scope, asset_types: nil, order_by: nil, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudassetV1p1beta1::SearchAllResourcesResponse

Searches all the resources under a given accessible CRM scope (project/folder/organization). This RPC gives callers especially admins the ability to search all the resources under a scope, even if they don't have .get permission of all the resources. Callers should have cloud.assets.SearchAllResources permission on the requested scope, otherwise it will be rejected.

Parameters:

  • scope (String)

    Required. The relative name of an asset. The search is limited to the resources within the scope. The allowed value must be:

    • Organization number (such as "organizations/123")
    • Folder number(such as "folders/1234")
    • Project number (such as "projects/12345")
    • Project id (such as "projects/abc")
  • asset_types (Array<String>, String) (defaults to: nil)

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

  • order_by (String) (defaults to: nil)

    Optional. A comma separated list of fields specifying the sorting order of the results. The default order is ascending. Add " desc" after the field name to indicate descending order. Redundant space characters are ignored. For example, " foo , bar desc ".

  • page_size (Fixnum) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

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

  • query (String) (defaults to: nil)

    Optional. The query statement.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



165
166
167
168
169
170
171
172
173
174
175
176
177
178
# File 'generated/google/apis/cloudasset_v1p1beta1/service.rb', line 165

def search_resource_all(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, 'v1p1beta1/{+scope}/resources:searchAll', options)
  command.response_representation = Google::Apis::CloudassetV1p1beta1::SearchAllResourcesResponse::Representation
  command.response_class = Google::Apis::CloudassetV1p1beta1::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