Class StreamingPullRequest (1.122.2)

public final class StreamingPullRequest extends GeneratedMessageV3 implements StreamingPullRequestOrBuilder

Request for the StreamingPull streaming RPC method. This request is used to establish the initial stream as well as to stream acknowledgements and ack deadline modifications from the client to the server.

Protobuf type google.pubsub.v1.StreamingPullRequest

Static Fields

ACK_IDS_FIELD_NUMBER

public static final int ACK_IDS_FIELD_NUMBER
Field Value
TypeDescription
int

CLIENT_ID_FIELD_NUMBER

public static final int CLIENT_ID_FIELD_NUMBER
Field Value
TypeDescription
int

MAX_OUTSTANDING_BYTES_FIELD_NUMBER

public static final int MAX_OUTSTANDING_BYTES_FIELD_NUMBER
Field Value
TypeDescription
int

MAX_OUTSTANDING_MESSAGES_FIELD_NUMBER

public static final int MAX_OUTSTANDING_MESSAGES_FIELD_NUMBER
Field Value
TypeDescription
int

MODIFY_DEADLINE_ACK_IDS_FIELD_NUMBER

public static final int MODIFY_DEADLINE_ACK_IDS_FIELD_NUMBER
Field Value
TypeDescription
int

MODIFY_DEADLINE_SECONDS_FIELD_NUMBER

public static final int MODIFY_DEADLINE_SECONDS_FIELD_NUMBER
Field Value
TypeDescription
int

STREAM_ACK_DEADLINE_SECONDS_FIELD_NUMBER

public static final int STREAM_ACK_DEADLINE_SECONDS_FIELD_NUMBER
Field Value
TypeDescription
int

SUBSCRIPTION_FIELD_NUMBER

public static final int SUBSCRIPTION_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static StreamingPullRequest getDefaultInstance()
Returns
TypeDescription
StreamingPullRequest

getDescriptor()

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

newBuilder()

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

newBuilder(StreamingPullRequest prototype)

public static StreamingPullRequest.Builder newBuilder(StreamingPullRequest prototype)
Parameter
NameDescription
prototypeStreamingPullRequest
Returns
TypeDescription
StreamingPullRequest.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAckIds(int index)

public String getAckIds(int index)

List of acknowledgement IDs for acknowledging previously received messages (received on this stream or a different stream). If an ack ID has expired, the corresponding message may be redelivered later. Acknowledging a message more than once will not result in an error. If the acknowledgement ID is malformed, the stream will be aborted with status INVALID_ARGUMENT.

repeated string ack_ids = 2;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The ackIds at the given index.

getAckIdsBytes(int index)

public ByteString getAckIdsBytes(int index)

List of acknowledgement IDs for acknowledging previously received messages (received on this stream or a different stream). If an ack ID has expired, the corresponding message may be redelivered later. Acknowledging a message more than once will not result in an error. If the acknowledgement ID is malformed, the stream will be aborted with status INVALID_ARGUMENT.

repeated string ack_ids = 2;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the ackIds at the given index.

getAckIdsCount()

public int getAckIdsCount()

List of acknowledgement IDs for acknowledging previously received messages (received on this stream or a different stream). If an ack ID has expired, the corresponding message may be redelivered later. Acknowledging a message more than once will not result in an error. If the acknowledgement ID is malformed, the stream will be aborted with status INVALID_ARGUMENT.

repeated string ack_ids = 2;

Returns
TypeDescription
int

The count of ackIds.

getAckIdsList()

public ProtocolStringList getAckIdsList()

List of acknowledgement IDs for acknowledging previously received messages (received on this stream or a different stream). If an ack ID has expired, the corresponding message may be redelivered later. Acknowledging a message more than once will not result in an error. If the acknowledgement ID is malformed, the stream will be aborted with status INVALID_ARGUMENT.

repeated string ack_ids = 2;

Returns
TypeDescription
ProtocolStringList

A list containing the ackIds.

getClientId()

public String getClientId()

A unique identifier that is used to distinguish client instances from each other. Only needs to be provided on the initial request. When a stream disconnects and reconnects for the same stream, the client_id should be set to the same value so that state associated with the old stream can be transferred to the new stream. The same client_id should not be used for different client instances.

string client_id = 6;

Returns
TypeDescription
String

The clientId.

getClientIdBytes()

public ByteString getClientIdBytes()

A unique identifier that is used to distinguish client instances from each other. Only needs to be provided on the initial request. When a stream disconnects and reconnects for the same stream, the client_id should be set to the same value so that state associated with the old stream can be transferred to the new stream. The same client_id should not be used for different client instances.

string client_id = 6;

Returns
TypeDescription
ByteString

The bytes for clientId.

getDefaultInstanceForType()

public StreamingPullRequest getDefaultInstanceForType()
Returns
TypeDescription
StreamingPullRequest

getMaxOutstandingBytes()

public long getMaxOutstandingBytes()

Flow control settings for the maximum number of outstanding bytes. When there are max_outstanding_bytes or more worth of messages currently sent to the streaming pull client that have not yet been acked or nacked, the server will stop sending more messages. The sending of messages resumes once the number of outstanding bytes is less than this value. If the value is <= 0, there is no limit to the number of outstanding bytes. This property can only be set on the initial StreamingPullRequest. If it is set on a subsequent request, the stream will be aborted with status INVALID_ARGUMENT.

int64 max_outstanding_bytes = 8;

Returns
TypeDescription
long

The maxOutstandingBytes.

getMaxOutstandingMessages()

public long getMaxOutstandingMessages()

Flow control settings for the maximum number of outstanding messages. When there are max_outstanding_messages or more currently sent to the streaming pull client that have not yet been acked or nacked, the server stops sending more messages. The sending of messages resumes once the number of outstanding messages is less than this value. If the value is <= 0, there is no limit to the number of outstanding messages. This property can only be set on the initial StreamingPullRequest. If it is set on a subsequent request, the stream will be aborted with status INVALID_ARGUMENT.

int64 max_outstanding_messages = 7;

Returns
TypeDescription
long

The maxOutstandingMessages.

getModifyDeadlineAckIds(int index)

public String getModifyDeadlineAckIds(int index)

List of acknowledgement IDs whose deadline will be modified based on the corresponding element in modify_deadline_seconds. This field can be used to indicate that more time is needed to process a message by the subscriber, or to make the message available for redelivery if the processing was interrupted.

repeated string modify_deadline_ack_ids = 4;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The modifyDeadlineAckIds at the given index.

getModifyDeadlineAckIdsBytes(int index)

public ByteString getModifyDeadlineAckIdsBytes(int index)

List of acknowledgement IDs whose deadline will be modified based on the corresponding element in modify_deadline_seconds. This field can be used to indicate that more time is needed to process a message by the subscriber, or to make the message available for redelivery if the processing was interrupted.

repeated string modify_deadline_ack_ids = 4;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the modifyDeadlineAckIds at the given index.

getModifyDeadlineAckIdsCount()

public int getModifyDeadlineAckIdsCount()

List of acknowledgement IDs whose deadline will be modified based on the corresponding element in modify_deadline_seconds. This field can be used to indicate that more time is needed to process a message by the subscriber, or to make the message available for redelivery if the processing was interrupted.

repeated string modify_deadline_ack_ids = 4;

Returns
TypeDescription
int

The count of modifyDeadlineAckIds.

getModifyDeadlineAckIdsList()

public ProtocolStringList getModifyDeadlineAckIdsList()

List of acknowledgement IDs whose deadline will be modified based on the corresponding element in modify_deadline_seconds. This field can be used to indicate that more time is needed to process a message by the subscriber, or to make the message available for redelivery if the processing was interrupted.

repeated string modify_deadline_ack_ids = 4;

Returns
TypeDescription
ProtocolStringList

A list containing the modifyDeadlineAckIds.

getModifyDeadlineSeconds(int index)

public int getModifyDeadlineSeconds(int index)

The list of new ack deadlines for the IDs listed in modify_deadline_ack_ids. The size of this list must be the same as the size of modify_deadline_ack_ids. If it differs the stream will be aborted with INVALID_ARGUMENT. Each element in this list is applied to the element in the same position in modify_deadline_ack_ids. The new ack deadline is with respect to the time this request was sent to the Pub/Sub system. Must be >= 0. For example, if the value is 10, the new ack deadline will expire 10 seconds after this request is received. If the value is 0, the message is immediately made available for another streaming or non-streaming pull request. If the value is < 0 (an error), the stream will be aborted with status INVALID_ARGUMENT.

repeated int32 modify_deadline_seconds = 3;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
int

The modifyDeadlineSeconds at the given index.

getModifyDeadlineSecondsCount()

public int getModifyDeadlineSecondsCount()

The list of new ack deadlines for the IDs listed in modify_deadline_ack_ids. The size of this list must be the same as the size of modify_deadline_ack_ids. If it differs the stream will be aborted with INVALID_ARGUMENT. Each element in this list is applied to the element in the same position in modify_deadline_ack_ids. The new ack deadline is with respect to the time this request was sent to the Pub/Sub system. Must be >= 0. For example, if the value is 10, the new ack deadline will expire 10 seconds after this request is received. If the value is 0, the message is immediately made available for another streaming or non-streaming pull request. If the value is < 0 (an error), the stream will be aborted with status INVALID_ARGUMENT.

repeated int32 modify_deadline_seconds = 3;

Returns
TypeDescription
int

The count of modifyDeadlineSeconds.

getModifyDeadlineSecondsList()

public List<Integer> getModifyDeadlineSecondsList()

The list of new ack deadlines for the IDs listed in modify_deadline_ack_ids. The size of this list must be the same as the size of modify_deadline_ack_ids. If it differs the stream will be aborted with INVALID_ARGUMENT. Each element in this list is applied to the element in the same position in modify_deadline_ack_ids. The new ack deadline is with respect to the time this request was sent to the Pub/Sub system. Must be >= 0. For example, if the value is 10, the new ack deadline will expire 10 seconds after this request is received. If the value is 0, the message is immediately made available for another streaming or non-streaming pull request. If the value is < 0 (an error), the stream will be aborted with status INVALID_ARGUMENT.

repeated int32 modify_deadline_seconds = 3;

Returns
TypeDescription
List<Integer>

A list containing the modifyDeadlineSeconds.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getStreamAckDeadlineSeconds()

public int getStreamAckDeadlineSeconds()

Required. The ack deadline to use for the stream. This must be provided in the first request on the stream, but it can also be updated on subsequent requests from client to server. The minimum deadline you can specify is 10 seconds. The maximum deadline you can specify is 600 seconds (10 minutes).

int32 stream_ack_deadline_seconds = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
int

The streamAckDeadlineSeconds.

getSubscription()

public String getSubscription()

Required. The subscription for which to initialize the new stream. This must be provided in the first request on the stream, and must not be set in subsequent requests from client to server. Format is projects/{project}/subscriptions/{sub}.

string subscription = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The subscription.

getSubscriptionBytes()

public ByteString getSubscriptionBytes()

Required. The subscription for which to initialize the new stream. This must be provided in the first request on the stream, and must not be set in subsequent requests from client to server. Format is projects/{project}/subscriptions/{sub}.

string subscription = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for subscription.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
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 StreamingPullRequest.Builder newBuilderForType()
Returns
TypeDescription
StreamingPullRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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