Class: Google::Apis::CloudassetV1::CloudAssetService

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

Overview

Cloud Asset API

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

Examples:

require 'google/apis/cloudasset_v1'

Cloudasset = Google::Apis::CloudassetV1 # 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_v1/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_v1/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_v1/service.rb', line 43

def quota_user
  @quota_user
end

Instance Method Details

#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) {|result, err| ... } ⇒ Google::Apis::CloudassetV1::BatchGetAssetsHistoryResponse

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.

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>, String) (defaults to: nil)

    A list of the full names of the assets. For example: //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/ instance1. See Resource Names and Resource Name Format for more info. 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 (String) (defaults to: nil)

    Optional. The content type.

  • read_time_window_end_time (String) (defaults to: nil)

    End time of the time window (inclusive). If not specified, the current timestamp is used instead.

  • read_time_window_start_time (String) (defaults to: nil)

    Start time of the time window (exclusive).

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



302
303
304
305
306
307
308
309
310
311
312
313
314
# File 'generated/google/apis/cloudasset_v1/service.rb', line 302

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

#create_feed(parent, create_feed_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudassetV1::Feed

Creates a feed in a parent project/folder/organization to listen to its asset updates.

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").

  • create_feed_request_object (Google::Apis::CloudassetV1::CreateFeedRequest) (defaults to: nil)
  • 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:



76
77
78
79
80
81
82
83
84
85
86
# File 'generated/google/apis/cloudasset_v1/service.rb', line 76

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

#delete_feed(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudassetV1::Empty

Deletes an asset feed.

Parameters:

  • 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

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



111
112
113
114
115
116
117
118
119
# File 'generated/google/apis/cloudasset_v1/service.rb', line 111

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

#export_assets(parent, export_assets_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudassetV1::Operation

Exports assets with time and resource types to a given Cloud Storage location. The output format is newline-delimited JSON. This API implements the google.longrunning.Operation API allowing you to keep track of the export.

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").

  • export_assets_request_object (Google::Apis::CloudassetV1::ExportAssetsRequest) (defaults to: nil)
  • 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:



343
344
345
346
347
348
349
350
351
352
353
# File 'generated/google/apis/cloudasset_v1/service.rb', line 343

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

#get_feed(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudassetV1::Feed

Gets details about an asset feed.

Parameters:

  • 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

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



144
145
146
147
148
149
150
151
152
# File 'generated/google/apis/cloudasset_v1/service.rb', line 144

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

#get_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudassetV1::Operation

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.

Parameters:

  • name (String)

    The name of the operation resource.

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



246
247
248
249
250
251
252
253
254
# File 'generated/google/apis/cloudasset_v1/service.rb', line 246

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

#list_feeds(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudassetV1::ListFeedsResponse

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

Parameters:

  • 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").

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



176
177
178
179
180
181
182
183
184
# File 'generated/google/apis/cloudasset_v1/service.rb', line 176

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

#patch_feed(name, update_feed_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudassetV1::Feed

Updates an asset feed configuration.

Parameters:

  • name (String)

    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.

  • update_feed_request_object (Google::Apis::CloudassetV1::UpdateFeedRequest) (defaults to: nil)
  • 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:



212
213
214
215
216
217
218
219
220
221
222
# File 'generated/google/apis/cloudasset_v1/service.rb', line 212

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