Class: Google::Cloud::Asset::V1::ListAssetsRequest

Inherits:

Object

• Object
• Google::Cloud::Asset::V1::ListAssetsRequest

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/asset/v1/asset_service.rb

Overview

ListAssets request.

Instance Attribute Summary

• #asset_types ⇒ ::Array<::String>

  A list of asset types to take a snapshot for.

• #content_type ⇒ ::Google::Cloud::Asset::V1::ContentType

  Asset content type.

• #page_size ⇒ ::Integer

  The maximum number of assets to be returned in a single response.

• #page_token ⇒ ::String

  The next_page_token returned from the previous ListAssetsResponse, or unspecified for the first ListAssetsRequest.

• #parent ⇒ ::String

  Required.

• #read_time ⇒ ::Google::Protobuf::Timestamp

  Timestamp to take an asset snapshot.

• #relationship_types ⇒ ::Array<::String>

  A list of relationship types to output, for example: INSTANCE_TO_INSTANCEGROUP.

Instance Attribute Details

#asset_types ⇒ ::Array<::String>

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

Returns:

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

# File 'proto_docs/google/cloud/asset/v1/asset_service.rb', line 182

class ListAssetsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#content_type ⇒ ::Google::Cloud::Asset::V1::ContentType

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

Returns:

• (::Google::Cloud::Asset::V1::ContentType) —

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

# File 'proto_docs/google/cloud/asset/v1/asset_service.rb', line 182

class ListAssetsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_size ⇒ ::Integer

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

Returns:

• (::Integer) —

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

# File 'proto_docs/google/cloud/asset/v1/asset_service.rb', line 182

class ListAssetsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_token ⇒ ::String

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

Returns:

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

# File 'proto_docs/google/cloud/asset/v1/asset_service.rb', line 182

class ListAssetsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#parent ⇒ ::String

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

Returns:

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

# File 'proto_docs/google/cloud/asset/v1/asset_service.rb', line 182

class ListAssetsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#read_time ⇒ ::Google::Protobuf::Timestamp

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

Returns:

• (::Google::Protobuf::Timestamp) —

  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.

# File 'proto_docs/google/cloud/asset/v1/asset_service.rb', line 182

class ListAssetsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#relationship_types ⇒ ::Array<::String>

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

Returns:

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

# File 'proto_docs/google/cloud/asset/v1/asset_service.rb', line 182

class ListAssetsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end