Package com.google.storage.v2

Class ListObjectsRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.storage.v2.ListObjectsRequest
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ListObjectsRequestOrBuilder, Serializable
public final class ListObjectsRequest extends com.google.protobuf.GeneratedMessageV3 implements ListObjectsRequestOrBuilder
 Request message for ListObjects.
Protobuf type google.storage.v2.ListObjectsRequest
See Also:

  • Field Details

    • PARENT_FIELD_NUMBER

      public static final int PARENT_FIELD_NUMBER
      See Also:

    • PAGE_SIZE_FIELD_NUMBER

      public static final int PAGE_SIZE_FIELD_NUMBER
      See Also:

    • PAGE_TOKEN_FIELD_NUMBER

      public static final int PAGE_TOKEN_FIELD_NUMBER
      See Also:

    • DELIMITER_FIELD_NUMBER

      public static final int DELIMITER_FIELD_NUMBER
      See Also:

    • INCLUDE_TRAILING_DELIMITER_FIELD_NUMBER

      public static final int INCLUDE_TRAILING_DELIMITER_FIELD_NUMBER
      See Also:

    • PREFIX_FIELD_NUMBER

      public static final int PREFIX_FIELD_NUMBER
      See Also:

    • VERSIONS_FIELD_NUMBER

      public static final int VERSIONS_FIELD_NUMBER
      See Also:

    • READ_MASK_FIELD_NUMBER

      public static final int READ_MASK_FIELD_NUMBER
      See Also:

    • LEXICOGRAPHIC_START_FIELD_NUMBER

      public static final int LEXICOGRAPHIC_START_FIELD_NUMBER
      See Also:

    • LEXICOGRAPHIC_END_FIELD_NUMBER

      public static final int LEXICOGRAPHIC_END_FIELD_NUMBER
      See Also:

    • SOFT_DELETED_FIELD_NUMBER

      public static final int SOFT_DELETED_FIELD_NUMBER
      See Also:

    • INCLUDE_FOLDERS_AS_PREFIXES_FIELD_NUMBER

      public static final int INCLUDE_FOLDERS_AS_PREFIXES_FIELD_NUMBER
      See Also:

    • MATCH_GLOB_FIELD_NUMBER

      public static final int MATCH_GLOB_FIELD_NUMBER
      See Also:

  • Method Details

    • 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 bucket in which to look for objects.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getParent in interface ListObjectsRequestOrBuilder
      Returns:
      The parent.

    • getParentBytes

      public com.google.protobuf.ByteString getParentBytes()
       Required. Name of the bucket in which to look for objects.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getParentBytes in interface ListObjectsRequestOrBuilder
      Returns:
      The bytes for parent.

    • getPageSize

      public int getPageSize()
       Optional. Maximum number of `items` plus `prefixes` to return
 in a single page of responses. As duplicate `prefixes` are
 omitted, fewer total results may be returned than requested. The service
 will use this parameter or 1,000 items, whichever is smaller.
      int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPageSize in interface ListObjectsRequestOrBuilder
      Returns:
      The pageSize.

    • getPageToken

      public String getPageToken()
       Optional. A previously-returned page token representing part of the larger
 set of results to view.
      string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPageToken in interface ListObjectsRequestOrBuilder
      Returns:
      The pageToken.

    • getPageTokenBytes

      public com.google.protobuf.ByteString getPageTokenBytes()
       Optional. A previously-returned page token representing part of the larger
 set of results to view.
      string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPageTokenBytes in interface ListObjectsRequestOrBuilder
      Returns:
      The bytes for pageToken.

    • getDelimiter

      public String getDelimiter()
       Optional. If set, returns results in a directory-like mode. `items` will
 contain only objects whose names, aside from the `prefix`, do not contain
 `delimiter`. Objects whose names, aside from the `prefix`, contain
 `delimiter` will have their name, truncated after the `delimiter`, returned
 in `prefixes`. Duplicate `prefixes` are omitted.
      string delimiter = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDelimiter in interface ListObjectsRequestOrBuilder
      Returns:
      The delimiter.

    • getDelimiterBytes

      public com.google.protobuf.ByteString getDelimiterBytes()
       Optional. If set, returns results in a directory-like mode. `items` will
 contain only objects whose names, aside from the `prefix`, do not contain
 `delimiter`. Objects whose names, aside from the `prefix`, contain
 `delimiter` will have their name, truncated after the `delimiter`, returned
 in `prefixes`. Duplicate `prefixes` are omitted.
      string delimiter = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDelimiterBytes in interface ListObjectsRequestOrBuilder
      Returns:
      The bytes for delimiter.

    • getIncludeTrailingDelimiter

      public boolean getIncludeTrailingDelimiter()
       Optional. If true, objects that end in exactly one instance of `delimiter`
 will have their metadata included in `items` in addition to
 `prefixes`.
      bool include_trailing_delimiter = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getIncludeTrailingDelimiter in interface ListObjectsRequestOrBuilder
      Returns:
      The includeTrailingDelimiter.

    • getPrefix

      public String getPrefix()
       Optional. Filter results to objects whose names begin with this prefix.
      string prefix = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPrefix in interface ListObjectsRequestOrBuilder
      Returns:
      The prefix.

    • getPrefixBytes

      public com.google.protobuf.ByteString getPrefixBytes()
       Optional. Filter results to objects whose names begin with this prefix.
      string prefix = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPrefixBytes in interface ListObjectsRequestOrBuilder
      Returns:
      The bytes for prefix.

    • getVersions

      public boolean getVersions()
       Optional. If `true`, lists all versions of an object as distinct results.
 For more information, see
 [Object
 Versioning](https://cloud.google.com/storage/docs/object-versioning).
      bool versions = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getVersions in interface ListObjectsRequestOrBuilder
      Returns:
      The versions.

    • hasReadMask

      public boolean hasReadMask()
       Mask specifying which fields to read from each result.
 If no mask is specified, will default to all fields except items.acl and
 items.owner.
 * may be used to mean "all fields".
      optional .google.protobuf.FieldMask read_mask = 8;
      Specified by:
      hasReadMask in interface ListObjectsRequestOrBuilder
      Returns:
      Whether the readMask field is set.

    • getReadMask

      public com.google.protobuf.FieldMask getReadMask()
       Mask specifying which fields to read from each result.
 If no mask is specified, will default to all fields except items.acl and
 items.owner.
 * may be used to mean "all fields".
      optional .google.protobuf.FieldMask read_mask = 8;
      Specified by:
      getReadMask in interface ListObjectsRequestOrBuilder
      Returns:
      The readMask.

    • getReadMaskOrBuilder

      public com.google.protobuf.FieldMaskOrBuilder getReadMaskOrBuilder()
       Mask specifying which fields to read from each result.
 If no mask is specified, will default to all fields except items.acl and
 items.owner.
 * may be used to mean "all fields".
      optional .google.protobuf.FieldMask read_mask = 8;
      Specified by:
      getReadMaskOrBuilder in interface ListObjectsRequestOrBuilder

    • getLexicographicStart

      public String getLexicographicStart()
       Optional. Filter results to objects whose names are lexicographically equal
 to or after lexicographic_start. If lexicographic_end is also set, the
 objects listed have names between lexicographic_start (inclusive) and
 lexicographic_end (exclusive).
      string lexicographic_start = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLexicographicStart in interface ListObjectsRequestOrBuilder
      Returns:
      The lexicographicStart.

    • getLexicographicStartBytes

      public com.google.protobuf.ByteString getLexicographicStartBytes()
       Optional. Filter results to objects whose names are lexicographically equal
 to or after lexicographic_start. If lexicographic_end is also set, the
 objects listed have names between lexicographic_start (inclusive) and
 lexicographic_end (exclusive).
      string lexicographic_start = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLexicographicStartBytes in interface ListObjectsRequestOrBuilder
      Returns:
      The bytes for lexicographicStart.

    • getLexicographicEnd

      public String getLexicographicEnd()
       Optional. Filter results to objects whose names are lexicographically
 before lexicographic_end. If lexicographic_start is also set, the objects
 listed have names between lexicographic_start (inclusive) and
 lexicographic_end (exclusive).
      string lexicographic_end = 11 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLexicographicEnd in interface ListObjectsRequestOrBuilder
      Returns:
      The lexicographicEnd.

    • getLexicographicEndBytes

      public com.google.protobuf.ByteString getLexicographicEndBytes()
       Optional. Filter results to objects whose names are lexicographically
 before lexicographic_end. If lexicographic_start is also set, the objects
 listed have names between lexicographic_start (inclusive) and
 lexicographic_end (exclusive).
      string lexicographic_end = 11 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLexicographicEndBytes in interface ListObjectsRequestOrBuilder
      Returns:
      The bytes for lexicographicEnd.

    • getSoftDeleted

      public boolean getSoftDeleted()
       Optional. If true, only list all soft-deleted versions of the object.
 Soft delete policy is required to set this option.
      bool soft_deleted = 12 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSoftDeleted in interface ListObjectsRequestOrBuilder
      Returns:
      The softDeleted.

    • getIncludeFoldersAsPrefixes

      public boolean getIncludeFoldersAsPrefixes()
       Optional. If true, will also include folders and managed folders (besides
 objects) in the returned `prefixes`. Requires `delimiter` to be set to '/'.
      bool include_folders_as_prefixes = 13 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getIncludeFoldersAsPrefixes in interface ListObjectsRequestOrBuilder
      Returns:
      The includeFoldersAsPrefixes.

    • getMatchGlob

      public String getMatchGlob()
       Optional. Filter results to objects and prefixes that match this glob
 pattern. See [List Objects Using
 Glob](https://cloud.google.com/storage/docs/json_api/v1/objects/list#list-objects-and-prefixes-using-glob)
 for the full syntax.
      string match_glob = 14 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getMatchGlob in interface ListObjectsRequestOrBuilder
      Returns:
      The matchGlob.

    • getMatchGlobBytes

      public com.google.protobuf.ByteString getMatchGlobBytes()
       Optional. Filter results to objects and prefixes that match this glob
 pattern. See [List Objects Using
 Glob](https://cloud.google.com/storage/docs/json_api/v1/objects/list#list-objects-and-prefixes-using-glob)
 for the full syntax.
      string match_glob = 14 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getMatchGlobBytes in interface ListObjectsRequestOrBuilder
      Returns:
      The bytes for matchGlob.

    • 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 ListObjectsRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static ListObjectsRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ListObjectsRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ListObjectsRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ListObjectsRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ListObjectsRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static ListObjectsRequest.Builder newBuilder()

    • newBuilder

      public static ListObjectsRequest.Builder newBuilder(ListObjectsRequest prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static ListObjectsRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<ListObjectsRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<ListObjectsRequest> 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 ListObjectsRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder