Package com.google.cloud.asset.v1

Class ListAssetsRequest

  • All Implemented Interfaces:
    ListAssetsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class ListAssetsRequest
extends com.google.protobuf.GeneratedMessageV3
implements ListAssetsRequestOrBuilder
     ListAssets request.
    Protobuf type google.cloud.asset.v1.ListAssetsRequest
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ListAssetsRequest.Builder
      ListAssets request.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getParent

        public 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) = { ... }
        Specified by:
        getParent in interface ListAssetsRequestOrBuilder
        Returns:
        The parent.

      • getParentBytes

        public 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) = { ... }
        Specified by:
        getParentBytes in interface ListAssetsRequestOrBuilder
        Returns:
        The bytes for parent.

      • hasReadTime

        public 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;
        Specified by:
        hasReadTime in interface ListAssetsRequestOrBuilder
        Returns:
        Whether the readTime field is set.

      • getReadTime

        public 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;
        Specified by:
        getReadTime in interface ListAssetsRequestOrBuilder
        Returns:
        The readTime.

      • getReadTimeOrBuilder

        public 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;
        Specified by:
        getReadTimeOrBuilder in interface ListAssetsRequestOrBuilder

      • getAssetTypesList

        public com.google.protobuf.ProtocolStringList 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;
        Specified by:
        getAssetTypesList in interface ListAssetsRequestOrBuilder
        Returns:
        A list containing the assetTypes.

      • getAssetTypesCount

        public 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;
        Specified by:
        getAssetTypesCount in interface ListAssetsRequestOrBuilder
        Returns:
        The count of assetTypes.

      • getAssetTypes

        public 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;
        Specified by:
        getAssetTypes in interface ListAssetsRequestOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The assetTypes at the given index.

      • getAssetTypesBytes

        public 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;
        Specified by:
        getAssetTypesBytes in interface ListAssetsRequestOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the assetTypes at the given index.

      • getContentTypeValue

        public 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;
        Specified by:
        getContentTypeValue in interface ListAssetsRequestOrBuilder
        Returns:
        The enum numeric value on the wire for contentType.

      • getContentType

        public 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;
        Specified by:
        getContentType in interface ListAssetsRequestOrBuilder
        Returns:
        The contentType.

      • getPageSize

        public 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;
        Specified by:
        getPageSize in interface ListAssetsRequestOrBuilder
        Returns:
        The pageSize.

      • getPageToken

        public 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;
        Specified by:
        getPageToken in interface ListAssetsRequestOrBuilder
        Returns:
        The pageToken.

      • getPageTokenBytes

        public 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;
        Specified by:
        getPageTokenBytes in interface ListAssetsRequestOrBuilder
        Returns:
        The bytes for pageToken.

      • getRelationshipTypesList

        public com.google.protobuf.ProtocolStringList 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;
        Specified by:
        getRelationshipTypesList in interface ListAssetsRequestOrBuilder
        Returns:
        A list containing the relationshipTypes.

      • getRelationshipTypesCount

        public 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;
        Specified by:
        getRelationshipTypesCount in interface ListAssetsRequestOrBuilder
        Returns:
        The count of relationshipTypes.

      • getRelationshipTypes

        public 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;
        Specified by:
        getRelationshipTypes in interface ListAssetsRequestOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The relationshipTypes at the given index.

      • getRelationshipTypesBytes

        public 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;
        Specified by:
        getRelationshipTypesBytes in interface ListAssetsRequestOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the relationshipTypes at the given index.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static ListAssetsRequest parseFrom​(ByteBuffer data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ListAssetsRequest parseFrom​(ByteBuffer data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ListAssetsRequest parseFrom​(com.google.protobuf.ByteString data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ListAssetsRequest parseFrom​(com.google.protobuf.ByteString data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ListAssetsRequest parseFrom​(byte[] data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ListAssetsRequest parseFrom​(byte[] data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ListAssetsRequest parseFrom​(com.google.protobuf.CodedInputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws IOException
        Throws:
        IOException

      • newBuilderForType

        public ListAssetsRequest.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public ListAssetsRequest.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected ListAssetsRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<ListAssetsRequest> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public ListAssetsRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder