Class ListPartitionCursorsRequest (1.13.6)

public final class ListPartitionCursorsRequest extends GeneratedMessageV3 implements ListPartitionCursorsRequestOrBuilder

Request for ListPartitionCursors.

Protobuf type google.cloud.pubsublite.v1.ListPartitionCursorsRequest

Static Fields

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
Type Description
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ListPartitionCursorsRequest getDefaultInstance()
Returns
Type Description
ListPartitionCursorsRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ListPartitionCursorsRequest.Builder newBuilder()
Returns
Type Description
ListPartitionCursorsRequest.Builder

newBuilder(ListPartitionCursorsRequest prototype)

public static ListPartitionCursorsRequest.Builder newBuilder(ListPartitionCursorsRequest prototype)
Parameter
Name Description
prototype ListPartitionCursorsRequest
Returns
Type Description
ListPartitionCursorsRequest.Builder

parseDelimitedFrom(InputStream input)

public static ListPartitionCursorsRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListPartitionCursorsRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListPartitionCursorsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListPartitionCursorsRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ListPartitionCursorsRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ListPartitionCursorsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ListPartitionCursorsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListPartitionCursorsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ListPartitionCursorsRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ListPartitionCursorsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ListPartitionCursorsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListPartitionCursorsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ListPartitionCursorsRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ListPartitionCursorsRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ListPartitionCursorsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListPartitionCursorsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ListPartitionCursorsRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListPartitionCursorsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListPartitionCursorsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListPartitionCursorsRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ListPartitionCursorsRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ListPartitionCursorsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ListPartitionCursorsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListPartitionCursorsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ListPartitionCursorsRequest> parser()
Returns
Type Description
Parser<ListPartitionCursorsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ListPartitionCursorsRequest getDefaultInstanceForType()
Returns
Type Description
ListPartitionCursorsRequest

getPageSize()

public 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
Type Description
int

The pageSize.

getPageToken()

public 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
Type Description
String

The pageToken.

getPageTokenBytes()

public 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
Type Description
ByteString

The bytes for pageToken.

getParent()

public 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
Type Description
String

The parent.

getParentBytes()

public 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
Type Description
ByteString

The bytes for parent.

getParserForType()

public Parser<ListPartitionCursorsRequest> getParserForType()
Returns
Type Description
Parser<ListPartitionCursorsRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ListPartitionCursorsRequest.Builder newBuilderForType()
Returns
Type Description
ListPartitionCursorsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ListPartitionCursorsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ListPartitionCursorsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ListPartitionCursorsRequest.Builder toBuilder()
Returns
Type Description
ListPartitionCursorsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException