Class ListPartitionCursorsRequest (1.12.22)

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
TypeDescription
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
TypeDescription
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ListPartitionCursorsRequest getDefaultInstance()
Returns
TypeDescription
ListPartitionCursorsRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ListPartitionCursorsRequest.Builder newBuilder()
Returns
TypeDescription
ListPartitionCursorsRequest.Builder

newBuilder(ListPartitionCursorsRequest prototype)

public static ListPartitionCursorsRequest.Builder newBuilder(ListPartitionCursorsRequest prototype)
Parameter
NameDescription
prototypeListPartitionCursorsRequest
Returns
TypeDescription
ListPartitionCursorsRequest.Builder

parseDelimitedFrom(InputStream input)

public static ListPartitionCursorsRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ListPartitionCursorsRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListPartitionCursorsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListPartitionCursorsRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ListPartitionCursorsRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ListPartitionCursorsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ListPartitionCursorsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListPartitionCursorsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ListPartitionCursorsRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ListPartitionCursorsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ListPartitionCursorsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListPartitionCursorsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ListPartitionCursorsRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ListPartitionCursorsRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ListPartitionCursorsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListPartitionCursorsRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ListPartitionCursorsRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ListPartitionCursorsRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListPartitionCursorsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListPartitionCursorsRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ListPartitionCursorsRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ListPartitionCursorsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ListPartitionCursorsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListPartitionCursorsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ListPartitionCursorsRequest> parser()
Returns
TypeDescription
Parser<ListPartitionCursorsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public ListPartitionCursorsRequest getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for parent.

getParserForType()

public Parser<ListPartitionCursorsRequest> getParserForType()
Returns
TypeDescription
Parser<ListPartitionCursorsRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ListPartitionCursorsRequest.Builder newBuilderForType()
Returns
TypeDescription
ListPartitionCursorsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ListPartitionCursorsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ListPartitionCursorsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ListPartitionCursorsRequest.Builder toBuilder()
Returns
TypeDescription
ListPartitionCursorsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException