Package com.google.cloud.asset.v1

Interface ListAssetsRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    ListAssetsRequest, ListAssetsRequest.Builder
    public interface ListAssetsRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getAssetTypes​(int index)
      A list of asset types to take a snapshot for.
      com.google.protobuf.ByteString getAssetTypesBytes​(int index)
      A list of asset types to take a snapshot for.
      int getAssetTypesCount()
      A list of asset types to take a snapshot for.
      List<String> getAssetTypesList()
      A list of asset types to take a snapshot for.
      ContentType getContentType()
      Asset content type.
      int getContentTypeValue()
      Asset content type.
      int getPageSize()
      The maximum number of assets to be returned in a single response.
      String getPageToken()
      The `next_page_token` returned from the previous `ListAssetsResponse`, or unspecified for the first `ListAssetsRequest`.
      com.google.protobuf.ByteString getPageTokenBytes()
      The `next_page_token` returned from the previous `ListAssetsResponse`, or unspecified for the first `ListAssetsRequest`.
      String getParent()
      Required.
      com.google.protobuf.ByteString getParentBytes()
      Required.
      com.google.protobuf.Timestamp getReadTime()
      Timestamp to take an asset snapshot.
      com.google.protobuf.TimestampOrBuilder getReadTimeOrBuilder()
      Timestamp to take an asset snapshot.
      String getRelationshipTypes​(int index)
      A list of relationship types to output, for example: `INSTANCE_TO_INSTANCEGROUP`.
      com.google.protobuf.ByteString getRelationshipTypesBytes​(int index)
      A list of relationship types to output, for example: `INSTANCE_TO_INSTANCEGROUP`.
      int getRelationshipTypesCount()
      A list of relationship types to output, for example: `INSTANCE_TO_INSTANCEGROUP`.
      List<String> getRelationshipTypesList()
      A list of relationship types to output, for example: `INSTANCE_TO_INSTANCEGROUP`.
      boolean hasReadTime()
      Timestamp to take an asset snapshot.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getParent

        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:
        The parent.

      • getParentBytes

        com.google.protobuf.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:
        The bytes for parent.

      • hasReadTime

        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:
        Whether the readTime field is set.

      • getReadTime

        com.google.protobuf.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:
        The readTime.

      • getReadTimeOrBuilder

        com.google.protobuf.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;

      • getAssetTypesList

        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](https://github.com/google/re2/wiki/Syntax) 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](https://cloud.google.com/asset-inventory/docs/overview)
 for all supported asset types.
        repeated string asset_types = 3;
        Returns:
        A list containing the assetTypes.

      • getAssetTypesCount

        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](https://github.com/google/re2/wiki/Syntax) 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](https://cloud.google.com/asset-inventory/docs/overview)
 for all supported asset types.
        repeated string asset_types = 3;
        Returns:
        The count of assetTypes.

      • getAssetTypes

        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](https://github.com/google/re2/wiki/Syntax) 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](https://cloud.google.com/asset-inventory/docs/overview)
 for all supported asset types.
        repeated string asset_types = 3;
        Parameters:
        index - The index of the element to return.
        Returns:
        The assetTypes at the given index.

      • getAssetTypesBytes

        com.google.protobuf.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](https://github.com/google/re2/wiki/Syntax) 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](https://cloud.google.com/asset-inventory/docs/overview)
 for all supported asset types.
        repeated string asset_types = 3;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the assetTypes at the given index.

      • getContentTypeValue

        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:
        The enum numeric value on the wire for contentType.

      • getContentType

        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:
        The contentType.

      • getPageSize

        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:
        The pageSize.

      • getPageToken

        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:
        The pageToken.

      • getPageTokenBytes

        com.google.protobuf.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:
        The bytes for pageToken.

      • getRelationshipTypesList

        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](https://cloud.google.com/asset-inventory/docs/overview)
 for all supported asset types and relationship types.
        repeated string relationship_types = 7;
        Returns:
        A list containing the relationshipTypes.

      • getRelationshipTypesCount

        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](https://cloud.google.com/asset-inventory/docs/overview)
 for all supported asset types and relationship types.
        repeated string relationship_types = 7;
        Returns:
        The count of relationshipTypes.

      • getRelationshipTypes

        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](https://cloud.google.com/asset-inventory/docs/overview)
 for all supported asset types and relationship types.
        repeated string relationship_types = 7;
        Parameters:
        index - The index of the element to return.
        Returns:
        The relationshipTypes at the given index.

      • getRelationshipTypesBytes

        com.google.protobuf.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](https://cloud.google.com/asset-inventory/docs/overview)
 for all supported asset types and relationship types.
        repeated string relationship_types = 7;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the relationshipTypes at the given index.