public static final class StreamingPullRequest.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<StreamingPullRequest.Builder> 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 | Method and Description |
|---|---|
StreamingPullRequest.Builder |
addAckIds(String value)
List of acknowledgement IDs for acknowledging previously received messages
(received on this stream or a different stream).
|
StreamingPullRequest.Builder |
addAckIdsBytes(com.google.protobuf.ByteString value)
List of acknowledgement IDs for acknowledging previously received messages
(received on this stream or a different stream).
|
StreamingPullRequest.Builder |
addAllAckIds(Iterable<String> values)
List of acknowledgement IDs for acknowledging previously received messages
(received on this stream or a different stream).
|
StreamingPullRequest.Builder |
addAllModifyDeadlineAckIds(Iterable<String> values)
List of acknowledgement IDs whose deadline will be modified based on the
corresponding element in `modify_deadline_seconds`.
|
StreamingPullRequest.Builder |
addAllModifyDeadlineSeconds(Iterable<? extends Integer> values)
The list of new ack deadlines for the IDs listed in
`modify_deadline_ack_ids`.
|
StreamingPullRequest.Builder |
addModifyDeadlineAckIds(String value)
List of acknowledgement IDs whose deadline will be modified based on the
corresponding element in `modify_deadline_seconds`.
|
StreamingPullRequest.Builder |
addModifyDeadlineAckIdsBytes(com.google.protobuf.ByteString value)
List of acknowledgement IDs whose deadline will be modified based on the
corresponding element in `modify_deadline_seconds`.
|
StreamingPullRequest.Builder |
addModifyDeadlineSeconds(int value)
The list of new ack deadlines for the IDs listed in
`modify_deadline_ack_ids`.
|
StreamingPullRequest.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
StreamingPullRequest |
build() |
StreamingPullRequest |
buildPartial() |
StreamingPullRequest.Builder |
clear() |
StreamingPullRequest.Builder |
clearAckIds()
List of acknowledgement IDs for acknowledging previously received messages
(received on this stream or a different stream).
|
StreamingPullRequest.Builder |
clearClientId()
A unique identifier that is used to distinguish client instances from each
other.
|
StreamingPullRequest.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
StreamingPullRequest.Builder |
clearMaxOutstandingBytes()
Flow control settings for the maximum number of outstanding bytes.
|
StreamingPullRequest.Builder |
clearMaxOutstandingMessages()
Flow control settings for the maximum number of outstanding messages.
|
StreamingPullRequest.Builder |
clearModifyDeadlineAckIds()
List of acknowledgement IDs whose deadline will be modified based on the
corresponding element in `modify_deadline_seconds`.
|
StreamingPullRequest.Builder |
clearModifyDeadlineSeconds()
The list of new ack deadlines for the IDs listed in
`modify_deadline_ack_ids`.
|
StreamingPullRequest.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
StreamingPullRequest.Builder |
clearStreamAckDeadlineSeconds()
Required.
|
StreamingPullRequest.Builder |
clearSubscription()
Required.
|
StreamingPullRequest.Builder |
clone() |
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.
|
StreamingPullRequest |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
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`.
|
int |
getStreamAckDeadlineSeconds()
Required.
|
String |
getSubscription()
Required.
|
com.google.protobuf.ByteString |
getSubscriptionBytes()
Required.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
StreamingPullRequest.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
StreamingPullRequest.Builder |
mergeFrom(com.google.protobuf.Message other) |
StreamingPullRequest.Builder |
mergeFrom(StreamingPullRequest other) |
StreamingPullRequest.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
StreamingPullRequest.Builder |
setAckIds(int index,
String value)
List of acknowledgement IDs for acknowledging previously received messages
(received on this stream or a different stream).
|
StreamingPullRequest.Builder |
setClientId(String value)
A unique identifier that is used to distinguish client instances from each
other.
|
StreamingPullRequest.Builder |
setClientIdBytes(com.google.protobuf.ByteString value)
A unique identifier that is used to distinguish client instances from each
other.
|
StreamingPullRequest.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
StreamingPullRequest.Builder |
setMaxOutstandingBytes(long value)
Flow control settings for the maximum number of outstanding bytes.
|
StreamingPullRequest.Builder |
setMaxOutstandingMessages(long value)
Flow control settings for the maximum number of outstanding messages.
|
StreamingPullRequest.Builder |
setModifyDeadlineAckIds(int index,
String value)
List of acknowledgement IDs whose deadline will be modified based on the
corresponding element in `modify_deadline_seconds`.
|
StreamingPullRequest.Builder |
setModifyDeadlineSeconds(int index,
int value)
The list of new ack deadlines for the IDs listed in
`modify_deadline_ack_ids`.
|
StreamingPullRequest.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
StreamingPullRequest.Builder |
setStreamAckDeadlineSeconds(int value)
Required.
|
StreamingPullRequest.Builder |
setSubscription(String value)
Required.
|
StreamingPullRequest.Builder |
setSubscriptionBytes(com.google.protobuf.ByteString value)
Required.
|
StreamingPullRequest.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<StreamingPullRequest.Builder>public StreamingPullRequest.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<StreamingPullRequest.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<StreamingPullRequest.Builder>public StreamingPullRequest getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic StreamingPullRequest build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic StreamingPullRequest buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic StreamingPullRequest.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<StreamingPullRequest.Builder>public StreamingPullRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<StreamingPullRequest.Builder>public StreamingPullRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<StreamingPullRequest.Builder>public StreamingPullRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<StreamingPullRequest.Builder>public StreamingPullRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<StreamingPullRequest.Builder>public StreamingPullRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<StreamingPullRequest.Builder>public StreamingPullRequest.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<StreamingPullRequest.Builder>public StreamingPullRequest.Builder mergeFrom(StreamingPullRequest other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<StreamingPullRequest.Builder>public StreamingPullRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<StreamingPullRequest.Builder>IOExceptionpublic 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 StreamingPullRequestOrBuilderpublic 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 StreamingPullRequestOrBuilderpublic StreamingPullRequest.Builder setSubscription(String value)
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) = { ... }
value - The subscription to set.public StreamingPullRequest.Builder clearSubscription()
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) = { ... }
public StreamingPullRequest.Builder setSubscriptionBytes(com.google.protobuf.ByteString value)
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) = { ... }
value - The bytes for subscription to set.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 StreamingPullRequestOrBuilderpublic 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 StreamingPullRequestOrBuilderpublic 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 StreamingPullRequestOrBuilderindex - 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 StreamingPullRequestOrBuilderindex - The index of the value to return.public StreamingPullRequest.Builder setAckIds(int index, String value)
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;index - The index to set the value at.value - The ackIds to set.public StreamingPullRequest.Builder addAckIds(String value)
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;value - The ackIds to add.public StreamingPullRequest.Builder addAllAckIds(Iterable<String> values)
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;values - The ackIds to add.public StreamingPullRequest.Builder clearAckIds()
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;public StreamingPullRequest.Builder addAckIdsBytes(com.google.protobuf.ByteString value)
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;value - The bytes of the ackIds to add.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 StreamingPullRequestOrBuilderpublic 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 StreamingPullRequestOrBuilderpublic 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 StreamingPullRequestOrBuilderindex - The index of the element to return.public StreamingPullRequest.Builder setModifyDeadlineSeconds(int index, int value)
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;index - The index to set the value at.value - The modifyDeadlineSeconds to set.public StreamingPullRequest.Builder addModifyDeadlineSeconds(int value)
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;value - The modifyDeadlineSeconds to add.public StreamingPullRequest.Builder addAllModifyDeadlineSeconds(Iterable<? extends Integer> values)
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;values - The modifyDeadlineSeconds to add.public StreamingPullRequest.Builder clearModifyDeadlineSeconds()
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;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 StreamingPullRequestOrBuilderpublic 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 StreamingPullRequestOrBuilderpublic 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 StreamingPullRequestOrBuilderindex - 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 StreamingPullRequestOrBuilderindex - The index of the value to return.public StreamingPullRequest.Builder setModifyDeadlineAckIds(int index, String value)
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;index - The index to set the value at.value - The modifyDeadlineAckIds to set.public StreamingPullRequest.Builder addModifyDeadlineAckIds(String value)
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;value - The modifyDeadlineAckIds to add.public StreamingPullRequest.Builder addAllModifyDeadlineAckIds(Iterable<String> values)
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;values - The modifyDeadlineAckIds to add.public StreamingPullRequest.Builder clearModifyDeadlineAckIds()
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;public StreamingPullRequest.Builder addModifyDeadlineAckIdsBytes(com.google.protobuf.ByteString value)
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;value - The bytes of the modifyDeadlineAckIds to add.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 StreamingPullRequestOrBuilderpublic StreamingPullRequest.Builder setStreamAckDeadlineSeconds(int value)
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];value - The streamAckDeadlineSeconds to set.public StreamingPullRequest.Builder clearStreamAckDeadlineSeconds()
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];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 StreamingPullRequestOrBuilderpublic 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 StreamingPullRequestOrBuilderpublic StreamingPullRequest.Builder setClientId(String value)
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;value - The clientId to set.public StreamingPullRequest.Builder clearClientId()
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;public StreamingPullRequest.Builder setClientIdBytes(com.google.protobuf.ByteString value)
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;value - The bytes for clientId to set.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 StreamingPullRequestOrBuilderpublic StreamingPullRequest.Builder setMaxOutstandingMessages(long value)
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;value - The maxOutstandingMessages to set.public StreamingPullRequest.Builder clearMaxOutstandingMessages()
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;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 StreamingPullRequestOrBuilderpublic StreamingPullRequest.Builder setMaxOutstandingBytes(long value)
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;value - The maxOutstandingBytes to set.public StreamingPullRequest.Builder clearMaxOutstandingBytes()
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;public final StreamingPullRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<StreamingPullRequest.Builder>public final StreamingPullRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<StreamingPullRequest.Builder>Copyright © 2023 Google LLC. All rights reserved.