Google Cloud Asset V1 Client - Class ListAssetsRequest (2.0.1)

Reference documentation and code samples for the Google Cloud Asset V1 Client class ListAssetsRequest.

ListAssets request.

Generated from protobuf message google.cloud.asset.v1.ListAssetsRequest

Namespace

Google \ Cloud \ Asset \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ parent
string

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

↳ read_time
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.

↳ asset_types
array

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
int

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

↳ page_size
int

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

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.

↳ relationship_types
array

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.

getParent

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

Returns
Type
Description
string

setParent

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

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getReadTime

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
Type
Description

hasReadTime

clearReadTime

setReadTime

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.

Parameter
Name
Description
Returns
Type
Description
$this

getAssetTypes

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
Type
Description

setAssetTypes

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.
Parameter
Name
Description
var
string[]
Returns
Type
Description
$this

getContentType

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

Returns
Type
Description
int

setContentType

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

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getPageSize

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

Returns
Type
Description
int

setPageSize

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

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getPageToken

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
Type
Description
string

setPageToken

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.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getRelationshipTypes

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
Type
Description

setRelationshipTypes

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.
Parameter
Name
Description
var
string[]
Returns
Type
Description
$this

static::build

Parameter
Name
Description
parent
string

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

Returns
Type
Description
Create a Mobile Website
View Site in Mobile | Classic
Share by: