Interface ListAssetsRequestOrBuilder (3.28.0) 

public interface ListAssetsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAssetTypes(int index)

public abstract String getAssetTypes(int index)

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.

repeated string asset_types = 3;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The assetTypes at the given index.

getAssetTypesBytes(int index)

public abstract ByteString getAssetTypesBytes(int index)

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.

repeated string asset_types = 3;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the assetTypes at the given index.

getAssetTypesCount()

public abstract int getAssetTypesCount()

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.

repeated string asset_types = 3;

Returns
Type Description
int

The count of assetTypes.

getAssetTypesList()

public abstract List<String> getAssetTypesList()

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.

repeated string asset_types = 3;

Returns
Type Description
List<String>

A list containing the assetTypes.

getContentType()

public abstract ContentType getContentType()

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

.google.cloud.asset.v1.ContentType content_type = 4;

Returns
Type Description
ContentType

The contentType.

getContentTypeValue()

public abstract int getContentTypeValue()

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

.google.cloud.asset.v1.ContentType content_type = 4;

Returns
Type Description
int

The enum numeric value on the wire for contentType.

getPageSize()

public abstract int getPageSize()

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

int32 page_size = 5;

Returns
Type Description
int

The pageSize.

getPageToken()

public abstract String 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.

string page_token = 6;

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()

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.

string page_token = 6;

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public abstract String 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").

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public abstract ByteString getParentBytes()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

getReadTime()

public abstract Timestamp 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.

.google.protobuf.Timestamp read_time = 2;

Returns
Type Description
Timestamp

The readTime.

getReadTimeOrBuilder()

public abstract TimestampOrBuilder getReadTimeOrBuilder()

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.

.google.protobuf.Timestamp read_time = 2;

Returns
Type Description
TimestampOrBuilder

getRelationshipTypes(int index)

public abstract String getRelationshipTypes(int index)

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.

repeated string relationship_types = 7;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The relationshipTypes at the given index.

getRelationshipTypesBytes(int index)

public abstract ByteString getRelationshipTypesBytes(int index)

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.

repeated string relationship_types = 7;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the relationshipTypes at the given index.

getRelationshipTypesCount()

public abstract int getRelationshipTypesCount()

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.

repeated string relationship_types = 7;

Returns
Type Description
int

The count of relationshipTypes.

getRelationshipTypesList()

public abstract List<String> getRelationshipTypesList()

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.

repeated string relationship_types = 7;

Returns
Type Description
List<String>

A list containing the relationshipTypes.

hasReadTime()

public abstract boolean hasReadTime()

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.

.google.protobuf.Timestamp read_time = 2;

Returns
Type Description
boolean

Whether the readTime field is set.