Package com.google.storage.control.v2

Interface ListFoldersRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ListFoldersRequest, ListFoldersRequest.Builder
public interface ListFoldersRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getParent

      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) = { ... }
      Returns:
      The parent.

    • getParentBytes

      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) = { ... }
      Returns:
      The bytes for parent.

    • getPageSize

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

    • getPageToken

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

    • getPageTokenBytes

      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];
      Returns:
      The bytes for pageToken.

    • getPrefix

      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];
      Returns:
      The prefix.

    • getPrefixBytes

      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];
      Returns:
      The bytes for prefix.

    • getDelimiter

      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];
      Returns:
      The delimiter.

    • getDelimiterBytes

      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];
      Returns:
      The bytes for delimiter.

    • getLexicographicStart

      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];
      Returns:
      The lexicographicStart.

    • getLexicographicStartBytes

      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];
      Returns:
      The bytes for lexicographicStart.

    • getLexicographicEnd

      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];
      Returns:
      The lexicographicEnd.

    • getLexicographicEndBytes

      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];
      Returns:
      The bytes for lexicographicEnd.

    • getRequestId

      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) = { ... }
      Returns:
      The requestId.

    • getRequestIdBytes

      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) = { ... }
      Returns:
      The bytes for requestId.