Class InitialSubscribeRequest (1.14.4)

public final class InitialSubscribeRequest extends GeneratedMessageV3 implements InitialSubscribeRequestOrBuilder

The first request that must be sent on a newly-opened stream. The client must wait for the response before sending subsequent requests on the stream.

Protobuf type google.cloud.pubsublite.v1.InitialSubscribeRequest

Static Fields

INITIAL_LOCATION_FIELD_NUMBER

public static final int INITIAL_LOCATION_FIELD_NUMBER
Field Value
Type Description
int

PARTITION_FIELD_NUMBER

public static final int PARTITION_FIELD_NUMBER
Field Value
Type Description
int

SUBSCRIPTION_FIELD_NUMBER

public static final int SUBSCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static InitialSubscribeRequest getDefaultInstance()
Returns
Type Description
InitialSubscribeRequest

getDescriptor()

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

newBuilder()

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

newBuilder(InitialSubscribeRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public InitialSubscribeRequest getDefaultInstanceForType()
Returns
Type Description
InitialSubscribeRequest

getInitialLocation()

public SeekRequest getInitialLocation()

Optional. Initial target location within the message backlog. If not set, messages will be delivered from the commit cursor for the given subscription and partition.

.google.cloud.pubsublite.v1.SeekRequest initial_location = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SeekRequest

The initialLocation.

getInitialLocationOrBuilder()

public SeekRequestOrBuilder getInitialLocationOrBuilder()

Optional. Initial target location within the message backlog. If not set, messages will be delivered from the commit cursor for the given subscription and partition.

.google.cloud.pubsublite.v1.SeekRequest initial_location = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SeekRequestOrBuilder

getParserForType()

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

getPartition()

public long getPartition()

The partition from which to receive messages. Partitions are zero indexed, so partition must be in the range [0, topic.num_partitions).

int64 partition = 2;

Returns
Type Description
long

The partition.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSubscription()

public String getSubscription()

The subscription from which to receive messages.

string subscription = 1;

Returns
Type Description
String

The subscription.

getSubscriptionBytes()

public ByteString getSubscriptionBytes()

The subscription from which to receive messages.

string subscription = 1;

Returns
Type Description
ByteString

The bytes for subscription.

hasInitialLocation()

public boolean hasInitialLocation()

Optional. Initial target location within the message backlog. If not set, messages will be delivered from the commit cursor for the given subscription and partition.

.google.cloud.pubsublite.v1.SeekRequest initial_location = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the initialLocation field is set.

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 InitialSubscribeRequest.Builder newBuilderForType()
Returns
Type Description
InitialSubscribeRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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