public final class StreamingPullRequest extends com.google.protobuf.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
Modifier and Type | Class and Description |
---|---|
static class |
StreamingPullRequest.Builder
Request for the `StreamingPull` streaming RPC method.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
Modifier and Type | Field and Description |
---|---|
static int |
ACK_IDS_FIELD_NUMBER |
static int |
CLIENT_ID_FIELD_NUMBER |
static int |
MAX_OUTSTANDING_BYTES_FIELD_NUMBER |
static int |
MAX_OUTSTANDING_MESSAGES_FIELD_NUMBER |
static int |
MODIFY_DEADLINE_ACK_IDS_FIELD_NUMBER |
static int |
MODIFY_DEADLINE_SECONDS_FIELD_NUMBER |
static int |
STREAM_ACK_DEADLINE_SECONDS_FIELD_NUMBER |
static int |
SUBSCRIPTION_FIELD_NUMBER |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj) |
String |
getAckIds(int index)
List of acknowledgement IDs for acknowledging previously received messages
(received on this stream or a different stream).
|
com.google.protobuf.ByteString |
getAckIdsBytes(int index)
List of acknowledgement IDs for acknowledging previously received messages
(received on this stream or a different stream).
|
int |
getAckIdsCount()
List of acknowledgement IDs for acknowledging previously received messages
(received on this stream or a different stream).
|
com.google.protobuf.ProtocolStringList |
getAckIdsList()
List of acknowledgement IDs for acknowledging previously received messages
(received on this stream or a different stream).
|
String |
getClientId()
A unique identifier that is used to distinguish client instances from each
other.
|
com.google.protobuf.ByteString |
getClientIdBytes()
A unique identifier that is used to distinguish client instances from each
other.
|
static StreamingPullRequest |
getDefaultInstance() |
StreamingPullRequest |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
long |
getMaxOutstandingBytes()
Flow control settings for the maximum number of outstanding bytes.
|
long |
getMaxOutstandingMessages()
Flow control settings for the maximum number of outstanding messages.
|
String |
getModifyDeadlineAckIds(int index)
List of acknowledgement IDs whose deadline will be modified based on the
corresponding element in `modify_deadline_seconds`.
|
com.google.protobuf.ByteString |
getModifyDeadlineAckIdsBytes(int index)
List of acknowledgement IDs whose deadline will be modified based on the
corresponding element in `modify_deadline_seconds`.
|
int |
getModifyDeadlineAckIdsCount()
List of acknowledgement IDs whose deadline will be modified based on the
corresponding element in `modify_deadline_seconds`.
|
com.google.protobuf.ProtocolStringList |
getModifyDeadlineAckIdsList()
List of acknowledgement IDs whose deadline will be modified based on the
corresponding element in `modify_deadline_seconds`.
|
int |
getModifyDeadlineSeconds(int index)
The list of new ack deadlines for the IDs listed in
`modify_deadline_ack_ids`.
|
int |
getModifyDeadlineSecondsCount()
The list of new ack deadlines for the IDs listed in
`modify_deadline_ack_ids`.
|
List<Integer> |
getModifyDeadlineSecondsList()
The list of new ack deadlines for the IDs listed in
`modify_deadline_ack_ids`.
|
com.google.protobuf.Parser<StreamingPullRequest> |
getParserForType() |
int |
getSerializedSize() |
int |
getStreamAckDeadlineSeconds()
Required.
|
String |
getSubscription()
Required.
|
com.google.protobuf.ByteString |
getSubscriptionBytes()
Required.
|
int |
hashCode() |
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static StreamingPullRequest.Builder |
newBuilder() |
static StreamingPullRequest.Builder |
newBuilder(StreamingPullRequest prototype) |
StreamingPullRequest.Builder |
newBuilderForType() |
protected StreamingPullRequest.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static StreamingPullRequest |
parseDelimitedFrom(InputStream input) |
static StreamingPullRequest |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static StreamingPullRequest |
parseFrom(byte[] data) |
static StreamingPullRequest |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static StreamingPullRequest |
parseFrom(ByteBuffer data) |
static StreamingPullRequest |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static StreamingPullRequest |
parseFrom(com.google.protobuf.ByteString data) |
static StreamingPullRequest |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static StreamingPullRequest |
parseFrom(com.google.protobuf.CodedInputStream input) |
static StreamingPullRequest |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static StreamingPullRequest |
parseFrom(InputStream input) |
static StreamingPullRequest |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<StreamingPullRequest> |
parser() |
StreamingPullRequest.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
public static final int SUBSCRIPTION_FIELD_NUMBER
public static final int ACK_IDS_FIELD_NUMBER
public static final int MODIFY_DEADLINE_SECONDS_FIELD_NUMBER
public static final int MODIFY_DEADLINE_ACK_IDS_FIELD_NUMBER
public static final int STREAM_ACK_DEADLINE_SECONDS_FIELD_NUMBER
public static final int CLIENT_ID_FIELD_NUMBER
public static final int MAX_OUTSTANDING_MESSAGES_FIELD_NUMBER
public static final int MAX_OUTSTANDING_BYTES_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance
in class com.google.protobuf.GeneratedMessageV3
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable
in class com.google.protobuf.GeneratedMessageV3
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) = { ... }
getSubscription
in interface StreamingPullRequestOrBuilder
public com.google.protobuf.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) = { ... }
getSubscriptionBytes
in interface StreamingPullRequestOrBuilder
public com.google.protobuf.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;
getAckIdsList
in interface StreamingPullRequestOrBuilder
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;
getAckIdsCount
in interface StreamingPullRequestOrBuilder
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;
getAckIds
in interface StreamingPullRequestOrBuilder
index
- The index of the element to return.public com.google.protobuf.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;
getAckIdsBytes
in interface StreamingPullRequestOrBuilder
index
- The index of the value to return.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;
getModifyDeadlineSecondsList
in interface StreamingPullRequestOrBuilder
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;
getModifyDeadlineSecondsCount
in interface StreamingPullRequestOrBuilder
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;
getModifyDeadlineSeconds
in interface StreamingPullRequestOrBuilder
index
- The index of the element to return.public com.google.protobuf.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;
getModifyDeadlineAckIdsList
in interface StreamingPullRequestOrBuilder
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;
getModifyDeadlineAckIdsCount
in interface StreamingPullRequestOrBuilder
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;
getModifyDeadlineAckIds
in interface StreamingPullRequestOrBuilder
index
- The index of the element to return.public com.google.protobuf.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;
getModifyDeadlineAckIdsBytes
in interface StreamingPullRequestOrBuilder
index
- The index of the value to return.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];
getStreamAckDeadlineSeconds
in interface StreamingPullRequestOrBuilder
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;
getClientId
in interface StreamingPullRequestOrBuilder
public com.google.protobuf.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;
getClientIdBytes
in interface StreamingPullRequestOrBuilder
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;
getMaxOutstandingMessages
in interface StreamingPullRequestOrBuilder
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;
getMaxOutstandingBytes
in interface StreamingPullRequestOrBuilder
public final boolean isInitialized()
isInitialized
in interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
in class com.google.protobuf.GeneratedMessageV3
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
writeTo
in interface com.google.protobuf.MessageLite
writeTo
in class com.google.protobuf.GeneratedMessageV3
IOException
public int getSerializedSize()
getSerializedSize
in interface com.google.protobuf.MessageLite
getSerializedSize
in class com.google.protobuf.GeneratedMessageV3
public boolean equals(Object obj)
equals
in interface com.google.protobuf.Message
equals
in class com.google.protobuf.AbstractMessage
public int hashCode()
hashCode
in interface com.google.protobuf.Message
hashCode
in class com.google.protobuf.AbstractMessage
public static StreamingPullRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static StreamingPullRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static StreamingPullRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static StreamingPullRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static StreamingPullRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static StreamingPullRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static StreamingPullRequest parseFrom(InputStream input) throws IOException
IOException
public static StreamingPullRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static StreamingPullRequest parseDelimitedFrom(InputStream input) throws IOException
IOException
public static StreamingPullRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static StreamingPullRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOException
public static StreamingPullRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public StreamingPullRequest.Builder newBuilderForType()
newBuilderForType
in interface com.google.protobuf.Message
newBuilderForType
in interface com.google.protobuf.MessageLite
public static StreamingPullRequest.Builder newBuilder()
public static StreamingPullRequest.Builder newBuilder(StreamingPullRequest prototype)
public StreamingPullRequest.Builder toBuilder()
toBuilder
in interface com.google.protobuf.Message
toBuilder
in interface com.google.protobuf.MessageLite
protected StreamingPullRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType
in class com.google.protobuf.GeneratedMessageV3
public static StreamingPullRequest getDefaultInstance()
public static com.google.protobuf.Parser<StreamingPullRequest> parser()
public com.google.protobuf.Parser<StreamingPullRequest> getParserForType()
getParserForType
in interface com.google.protobuf.Message
getParserForType
in interface com.google.protobuf.MessageLite
getParserForType
in class com.google.protobuf.GeneratedMessageV3
public StreamingPullRequest getDefaultInstanceForType()
getDefaultInstanceForType
in interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType
in interface com.google.protobuf.MessageOrBuilder
Copyright © 2023 Google LLC. All rights reserved.