Package com.google.storage.control.v2

Class ListFoldersRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.storage.control.v2.ListFoldersRequest
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ListFoldersRequestOrBuilder, Serializable
public final class ListFoldersRequest extends com.google.protobuf.GeneratedMessageV3 implements ListFoldersRequestOrBuilder
 Request message for ListFolders. This operation is only applicable to a
 hierarchical namespace enabled bucket.
Protobuf type google.storage.control.v2.ListFoldersRequest
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:

    • PREFIX_FIELD_NUMBER

      public static final int PREFIX_FIELD_NUMBER
      See Also:

    • DELIMITER_FIELD_NUMBER

      public static final int DELIMITER_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:

    • REQUEST_ID_FIELD_NUMBER

      public static final int REQUEST_ID_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 folders. The bucket must
 be a hierarchical namespace enabled bucket.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getParent in interface ListFoldersRequestOrBuilder
      Returns:
      The parent.

    • getParentBytes

      public com.google.protobuf.ByteString getParentBytes()
       Required. Name of the bucket in which to look for folders. The bucket must
 be a hierarchical namespace enabled bucket.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getParentBytes in interface ListFoldersRequestOrBuilder
      Returns:
      The bytes for parent.

    • getPageSize

      public int getPageSize()
       Optional. Maximum number of folders to return in a single response. 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 ListFoldersRequestOrBuilder
      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 ListFoldersRequestOrBuilder
      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 ListFoldersRequestOrBuilder
      Returns:
      The bytes for pageToken.

    • getPrefix

      public String getPrefix()
       Optional. Filter results to folders whose names begin with this prefix.
 If set, the value must either be an empty string or end with a '/'.
      string prefix = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPrefix in interface ListFoldersRequestOrBuilder
      Returns:
      The prefix.

    • getPrefixBytes

      public com.google.protobuf.ByteString getPrefixBytes()
       Optional. Filter results to folders whose names begin with this prefix.
 If set, the value must either be an empty string or end with a '/'.
      string prefix = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPrefixBytes in interface ListFoldersRequestOrBuilder
      Returns:
      The bytes for prefix.

    • getDelimiter

      public String getDelimiter()
       Optional. If set, returns results in a directory-like mode. The results
 will only include folders that either exactly match the above prefix, or
 are one level below the prefix. The only supported value is '/'.
      string delimiter = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDelimiter in interface ListFoldersRequestOrBuilder
      Returns:
      The delimiter.

    • getDelimiterBytes

      public com.google.protobuf.ByteString getDelimiterBytes()
       Optional. If set, returns results in a directory-like mode. The results
 will only include folders that either exactly match the above prefix, or
 are one level below the prefix. The only supported value is '/'.
      string delimiter = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDelimiterBytes in interface ListFoldersRequestOrBuilder
      Returns:
      The bytes for delimiter.

    • getLexicographicStart

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

    • getLexicographicStartBytes

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

    • getLexicographicEnd

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

    • getLexicographicEndBytes

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

    • getRequestId

      public String getRequestId()
       Optional. A unique identifier for this request. UUID is the recommended
 format, but other formats are still accepted.
      string request_id = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { ... }
      Specified by:
      getRequestId in interface ListFoldersRequestOrBuilder
      Returns:
      The requestId.

    • getRequestIdBytes

      public com.google.protobuf.ByteString getRequestIdBytes()
       Optional. A unique identifier for this request. UUID is the recommended
 format, but other formats are still accepted.
      string request_id = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { ... }
      Specified by:
      getRequestIdBytes in interface ListFoldersRequestOrBuilder
      Returns:
      The bytes for requestId.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static ListFoldersRequest.Builder newBuilder()

    • newBuilder

      public static ListFoldersRequest.Builder newBuilder(ListFoldersRequest prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static ListFoldersRequest getDefaultInstance()

    • parser

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

    • getParserForType

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