Package com.google.cloud.pubsublite.proto

Interface ListPartitionCursorsRequestOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getPageSize()
    The maximum number of cursors to return.
    String
    getPageToken()
    A page token, received from a previous `ListPartitionCursors` call.
    com.google.protobuf.ByteString
    getPageTokenBytes()
    A page token, received from a previous `ListPartitionCursors` call.
    String
    getParent()
    Required.
    com.google.protobuf.ByteString
    getParentBytes()
    Required.

    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 subscription for which to retrieve cursors.
 Structured like
 `projects/{project_number}/locations/{location}/subscriptions/{subscription_id}`.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The parent.

    • getParentBytes

      com.google.protobuf.ByteString getParentBytes()
       Required. The subscription for which to retrieve cursors.
 Structured like
 `projects/{project_number}/locations/{location}/subscriptions/{subscription_id}`.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for parent.

    • getPageSize

      int getPageSize()
       The maximum number of cursors to return. The service may return fewer than
 this value.
 If unset or zero, all cursors for the parent will be returned.
      int32 page_size = 2;
      Returns:
      The pageSize.

    • getPageToken

      String getPageToken()
       A page token, received from a previous `ListPartitionCursors` call.
 Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to `ListPartitionCursors`
 must match the call that provided the page token.
      string page_token = 3;
      Returns:
      The pageToken.

    • getPageTokenBytes

      com.google.protobuf.ByteString getPageTokenBytes()
       A page token, received from a previous `ListPartitionCursors` call.
 Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to `ListPartitionCursors`
 must match the call that provided the page token.
      string page_token = 3;
      Returns:
      The bytes for pageToken.