Class: Google::Apis::CloudassetV1p5beta1::CloudAssetService

Inherits:
Google::Apis::Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/cloudasset_v1p5beta1/service.rb

Overview

Cloud Asset API

The Cloud Asset API manages the history and inventory of Google Cloud resources.

Examples:

require 'google/apis/cloudasset_v1p5beta1'

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

See Also:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE = 
"https://cloudasset.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ CloudAssetService

Returns a new instance of CloudAssetService.



48
49
50
51
52
53
 
# File 'lib/google/apis/cloudasset_v1p5beta1/service.rb', line 48

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-cloudasset_v1p5beta1',
        client_version: Google::Apis::CloudassetV1p5beta1::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

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.



41
42
43
 
# File 'lib/google/apis/cloudasset_v1p5beta1/service.rb', line 41

def key
  @key
end

#quota_user ⇒ String

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.



46
47
48
 
# File 'lib/google/apis/cloudasset_v1p5beta1/service.rb', line 46

def quota_user
  @quota_user
end

Instance Method Details

#list_assets(parent, asset_types: nil, content_type: nil, page_size: nil, page_token: nil, read_time: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudassetV1p5beta1::ListAssetsResponse

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

Parameters:

  • parent (String) —

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

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

    A list of asset types to take a snapshot for. For example: "compute.googleapis. com/Disk". Regular expression is also supported. For example: * "compute. googleapis.com." snapshots resources whose asset type starts with "compute. googleapis.com". * ".*Instance" snapshots resources whose asset type ends with "Instance". * ".*Instance." snapshots resources whose asset type contains " Instance". See RE2 for all supported regular expression syntax. If the regular expression does not match any supported asset type, an INVALID_ARGUMENT error will be returned. If specified, only matching assets will be returned, otherwise, it will snapshot all asset types. See Introduction to Cloud Asset Inventory for all supported asset types.

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

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

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

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

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

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

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

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

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/google/apis/cloudasset_v1p5beta1/service.rb', line 107

def list_assets(parent, asset_types: nil, content_type: nil, page_size: nil, page_token: nil, read_time: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1p5beta1/{+parent}/assets', options)
  command.response_representation = Google::Apis::CloudassetV1p5beta1::ListAssetsResponse::Representation
  command.response_class = Google::Apis::CloudassetV1p5beta1::ListAssetsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['assetTypes'] = asset_types unless asset_types.nil?
  command.query['contentType'] = content_type unless content_type.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['readTime'] = read_time unless read_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