Package com.google.storage.v2

Interface ListBucketsRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ListBucketsRequest, ListBucketsRequest.Builder
@Generated public interface ListBucketsRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getPageSize()
    Optional.
    String
    getPageToken()
    Optional.
    com.google.protobuf.ByteString
    getPageTokenBytes()
    Optional.
    String
    getParent()
    Required.
    com.google.protobuf.ByteString
    getParentBytes()
    Required.
    String
    getPrefix()
    Optional.
    com.google.protobuf.ByteString
    getPrefixBytes()
    Optional.
    com.google.protobuf.FieldMask
    getReadMask()
    Mask specifying which fields to read from each result.
    com.google.protobuf.FieldMaskOrBuilder
    getReadMaskOrBuilder()
    Mask specifying which fields to read from each result.
    boolean
    getReturnPartialSuccess()
    Optional.
    boolean
    hasReadMask()
    Mask specifying which fields to read from each result.

    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 Details

    • getParent

      String getParent()
       Required. The project whose buckets we are listing.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The parent.

    • getParentBytes

      com.google.protobuf.ByteString getParentBytes()
       Required. The project whose buckets we are listing.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for parent.

    • getPageSize

      int getPageSize()
       Optional. Maximum number of buckets to return in a single response. The
 service uses this parameter or `1,000` items, whichever is smaller. If
 `acl` is present in the `read_mask`, the service uses this parameter of
 `200` 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 buckets whose names begin with this prefix.
      string prefix = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The prefix.

    • getPrefixBytes

      com.google.protobuf.ByteString getPrefixBytes()
       Optional. Filter results to buckets whose names begin with this prefix.
      string prefix = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for prefix.

    • hasReadMask

      boolean hasReadMask()
       Mask specifying which fields to read from each result.
 If no mask is specified, it defaults to all fields except `items.
 owner`, `items.acl`, and `items.default_object_acl`.
 `*` might be used to mean "all fields".
      optional .google.protobuf.FieldMask read_mask = 5;
      Returns:
      Whether the readMask field is set.

    • getReadMask

      com.google.protobuf.FieldMask getReadMask()
       Mask specifying which fields to read from each result.
 If no mask is specified, it defaults to all fields except `items.
 owner`, `items.acl`, and `items.default_object_acl`.
 `*` might be used to mean "all fields".
      optional .google.protobuf.FieldMask read_mask = 5;
      Returns:
      The readMask.

    • getReadMaskOrBuilder

      com.google.protobuf.FieldMaskOrBuilder getReadMaskOrBuilder()
       Mask specifying which fields to read from each result.
 If no mask is specified, it defaults to all fields except `items.
 owner`, `items.acl`, and `items.default_object_acl`.
 `*` might be used to mean "all fields".
      optional .google.protobuf.FieldMask read_mask = 5;

    • getReturnPartialSuccess

      boolean getReturnPartialSuccess()
       Optional. Allows listing of buckets, even if there are buckets that are
 unreachable.
      bool return_partial_success = 9 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The returnPartialSuccess.