Package com.google.pubsub.v1
Class StreamingPullRequest.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<StreamingPullRequest.Builder>
com.google.pubsub.v1.StreamingPullRequest.Builder
- All Implemented Interfaces:
com.google.protobuf.Message.Builder
,com.google.protobuf.MessageLite.Builder
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,StreamingPullRequestOrBuilder
,Cloneable
- Enclosing class:
- StreamingPullRequest
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
-
Method Summary
Modifier and TypeMethodDescriptionList of acknowledgement IDs for acknowledging previously received messages (received on this stream or a different stream).addAckIdsBytes
(com.google.protobuf.ByteString value) List of acknowledgement IDs for acknowledging previously received messages (received on this stream or a different stream).addAllAckIds
(Iterable<String> values) List of acknowledgement IDs for acknowledging previously received messages (received on this stream or a different stream).addAllModifyDeadlineAckIds
(Iterable<String> values) List of acknowledgement IDs whose deadline will be modified based on the corresponding element in `modify_deadline_seconds`.addAllModifyDeadlineSeconds
(Iterable<? extends Integer> values) The list of new ack deadlines for the IDs listed in `modify_deadline_ack_ids`.addModifyDeadlineAckIds
(String value) List of acknowledgement IDs whose deadline will be modified based on the corresponding element in `modify_deadline_seconds`.addModifyDeadlineAckIdsBytes
(com.google.protobuf.ByteString value) List of acknowledgement IDs whose deadline will be modified based on the corresponding element in `modify_deadline_seconds`.addModifyDeadlineSeconds
(int value) The list of new ack deadlines for the IDs listed in `modify_deadline_ack_ids`.addRepeatedField
(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) build()
clear()
List of acknowledgement IDs for acknowledging previously received messages (received on this stream or a different stream).A unique identifier that is used to distinguish client instances from each other.clearField
(com.google.protobuf.Descriptors.FieldDescriptor field) Flow control settings for the maximum number of outstanding bytes.Flow control settings for the maximum number of outstanding messages.List of acknowledgement IDs whose deadline will be modified based on the corresponding element in `modify_deadline_seconds`.The list of new ack deadlines for the IDs listed in `modify_deadline_ack_ids`.clearOneof
(com.google.protobuf.Descriptors.OneofDescriptor oneof) Required.Required.clone()
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
List of acknowledgement IDs for acknowledging previously received messages (received on this stream or a different stream).com.google.protobuf.ProtocolStringList
List of acknowledgement IDs for acknowledging previously received messages (received on this stream or a different stream).A unique identifier that is used to distinguish client instances from each other.com.google.protobuf.ByteString
A unique identifier that is used to distinguish client instances from each other.static final com.google.protobuf.Descriptors.Descriptor
com.google.protobuf.Descriptors.Descriptor
long
Flow control settings for the maximum number of outstanding bytes.long
Flow control settings for the maximum number of outstanding messages.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
List of acknowledgement IDs whose deadline will be modified based on the corresponding element in `modify_deadline_seconds`.com.google.protobuf.ProtocolStringList
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
The list of new ack deadlines for the IDs listed in `modify_deadline_ack_ids`.The list of new ack deadlines for the IDs listed in `modify_deadline_ack_ids`.int
Required.Required.com.google.protobuf.ByteString
Required.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
final boolean
mergeFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom
(com.google.protobuf.Message other) mergeFrom
(StreamingPullRequest other) mergeUnknownFields
(com.google.protobuf.UnknownFieldSet unknownFields) List of acknowledgement IDs for acknowledging previously received messages (received on this stream or a different stream).setClientId
(String value) A unique identifier that is used to distinguish client instances from each other.setClientIdBytes
(com.google.protobuf.ByteString value) A unique identifier that is used to distinguish client instances from each other.setMaxOutstandingBytes
(long value) Flow control settings for the maximum number of outstanding bytes.setMaxOutstandingMessages
(long value) Flow control settings for the maximum number of outstanding messages.setModifyDeadlineAckIds
(int index, String value) List of acknowledgement IDs whose deadline will be modified based on the corresponding element in `modify_deadline_seconds`.setModifyDeadlineSeconds
(int index, int value) The list of new ack deadlines for the IDs listed in `modify_deadline_ack_ids`.setRepeatedField
(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) setStreamAckDeadlineSeconds
(int value) Required.setSubscription
(String value) Required.setSubscriptionBytes
(com.google.protobuf.ByteString value) Required.setUnknownFields
(com.google.protobuf.UnknownFieldSet unknownFields) Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom
Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3.Builder<StreamingPullRequest.Builder>
-
clear
- Specified by:
clear
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clear
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clear
in classcom.google.protobuf.GeneratedMessageV3.Builder<StreamingPullRequest.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.Message.Builder
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.MessageOrBuilder
- Overrides:
getDescriptorForType
in classcom.google.protobuf.GeneratedMessageV3.Builder<StreamingPullRequest.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
build
in interfacecom.google.protobuf.Message.Builder
- Specified by:
build
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartial
in interfacecom.google.protobuf.Message.Builder
- Specified by:
buildPartial
in interfacecom.google.protobuf.MessageLite.Builder
-
clone
- Specified by:
clone
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clone
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clone
in classcom.google.protobuf.GeneratedMessageV3.Builder<StreamingPullRequest.Builder>
-
setField
public StreamingPullRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
setField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setField
in classcom.google.protobuf.GeneratedMessageV3.Builder<StreamingPullRequest.Builder>
-
clearField
public StreamingPullRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field) - Specified by:
clearField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearField
in classcom.google.protobuf.GeneratedMessageV3.Builder<StreamingPullRequest.Builder>
-
clearOneof
public StreamingPullRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) - Specified by:
clearOneof
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearOneof
in classcom.google.protobuf.GeneratedMessageV3.Builder<StreamingPullRequest.Builder>
-
setRepeatedField
public StreamingPullRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) - Specified by:
setRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<StreamingPullRequest.Builder>
-
addRepeatedField
public StreamingPullRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
addRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
addRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<StreamingPullRequest.Builder>
-
mergeFrom
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<StreamingPullRequest.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3.Builder<StreamingPullRequest.Builder>
-
mergeFrom
public StreamingPullRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Specified by:
mergeFrom
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<StreamingPullRequest.Builder>
- Throws:
IOException
-
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) = { ... }
- Specified by:
getSubscription
in interfaceStreamingPullRequestOrBuilder
- Returns:
- The subscription.
-
getSubscriptionBytes
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) = { ... }
- Specified by:
getSubscriptionBytes
in interfaceStreamingPullRequestOrBuilder
- Returns:
- The bytes for subscription.
-
setSubscription
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) = { ... }
- Parameters:
value
- The subscription to set.- Returns:
- This builder for chaining.
-
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) = { ... }
- Returns:
- This builder for chaining.
-
setSubscriptionBytes
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) = { ... }
- Parameters:
value
- The bytes for subscription to set.- Returns:
- This builder for chaining.
-
getAckIdsList
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;
- Specified by:
getAckIdsList
in interfaceStreamingPullRequestOrBuilder
- Returns:
- A list containing the ackIds.
-
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;
- Specified by:
getAckIdsCount
in interfaceStreamingPullRequestOrBuilder
- Returns:
- The count of ackIds.
-
getAckIds
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;
- Specified by:
getAckIds
in interfaceStreamingPullRequestOrBuilder
- Parameters:
index
- The index of the element to return.- Returns:
- The ackIds at the given index.
-
getAckIdsBytes
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;
- Specified by:
getAckIdsBytes
in interfaceStreamingPullRequestOrBuilder
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the ackIds at the given index.
-
setAckIds
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;
- Parameters:
index
- The index to set the value at.value
- The ackIds to set.- Returns:
- This builder for chaining.
-
addAckIds
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;
- Parameters:
value
- The ackIds to add.- Returns:
- This builder for chaining.
-
addAllAckIds
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;
- Parameters:
values
- The ackIds to add.- Returns:
- This builder for chaining.
-
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;
- Returns:
- This builder for chaining.
-
addAckIdsBytes
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;
- Parameters:
value
- The bytes of the ackIds to add.- Returns:
- This builder for chaining.
-
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;
- Specified by:
getModifyDeadlineSecondsList
in interfaceStreamingPullRequestOrBuilder
- Returns:
- A list containing the modifyDeadlineSeconds.
-
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;
- Specified by:
getModifyDeadlineSecondsCount
in interfaceStreamingPullRequestOrBuilder
- Returns:
- The count of modifyDeadlineSeconds.
-
getModifyDeadlineSeconds
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;
- Specified by:
getModifyDeadlineSeconds
in interfaceStreamingPullRequestOrBuilder
- Parameters:
index
- The index of the element to return.- Returns:
- The modifyDeadlineSeconds at the given index.
-
setModifyDeadlineSeconds
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;
- Parameters:
index
- The index to set the value at.value
- The modifyDeadlineSeconds to set.- Returns:
- This builder for chaining.
-
addModifyDeadlineSeconds
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;
- Parameters:
value
- The modifyDeadlineSeconds to add.- Returns:
- This builder for chaining.
-
addAllModifyDeadlineSeconds
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;
- Parameters:
values
- The modifyDeadlineSeconds to add.- Returns:
- This builder for chaining.
-
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;
- Returns:
- This builder for chaining.
-
getModifyDeadlineAckIdsList
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;
- Specified by:
getModifyDeadlineAckIdsList
in interfaceStreamingPullRequestOrBuilder
- Returns:
- A list containing the modifyDeadlineAckIds.
-
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;
- Specified by:
getModifyDeadlineAckIdsCount
in interfaceStreamingPullRequestOrBuilder
- Returns:
- The count of modifyDeadlineAckIds.
-
getModifyDeadlineAckIds
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;
- Specified by:
getModifyDeadlineAckIds
in interfaceStreamingPullRequestOrBuilder
- Parameters:
index
- The index of the element to return.- Returns:
- The modifyDeadlineAckIds at the given index.
-
getModifyDeadlineAckIdsBytes
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;
- Specified by:
getModifyDeadlineAckIdsBytes
in interfaceStreamingPullRequestOrBuilder
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the modifyDeadlineAckIds at the given index.
-
setModifyDeadlineAckIds
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;
- Parameters:
index
- The index to set the value at.value
- The modifyDeadlineAckIds to set.- Returns:
- This builder for chaining.
-
addModifyDeadlineAckIds
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;
- Parameters:
value
- The modifyDeadlineAckIds to add.- Returns:
- This builder for chaining.
-
addAllModifyDeadlineAckIds
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;
- Parameters:
values
- The modifyDeadlineAckIds to add.- Returns:
- This builder for chaining.
-
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;
- Returns:
- This builder for chaining.
-
addModifyDeadlineAckIdsBytes
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;
- Parameters:
value
- The bytes of the modifyDeadlineAckIds to add.- Returns:
- This builder for chaining.
-
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];
- Specified by:
getStreamAckDeadlineSeconds
in interfaceStreamingPullRequestOrBuilder
- Returns:
- The streamAckDeadlineSeconds.
-
setStreamAckDeadlineSeconds
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];
- Parameters:
value
- The streamAckDeadlineSeconds to set.- Returns:
- This builder for chaining.
-
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];
- Returns:
- This builder for chaining.
-
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;
- Specified by:
getClientId
in interfaceStreamingPullRequestOrBuilder
- Returns:
- The clientId.
-
getClientIdBytes
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;
- Specified by:
getClientIdBytes
in interfaceStreamingPullRequestOrBuilder
- Returns:
- The bytes for clientId.
-
setClientId
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;
- Parameters:
value
- The clientId to set.- Returns:
- This builder for chaining.
-
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;
- Returns:
- This builder for chaining.
-
setClientIdBytes
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;
- Parameters:
value
- The bytes for clientId to set.- Returns:
- This builder for chaining.
-
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;
- Specified by:
getMaxOutstandingMessages
in interfaceStreamingPullRequestOrBuilder
- Returns:
- The maxOutstandingMessages.
-
setMaxOutstandingMessages
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;
- Parameters:
value
- The maxOutstandingMessages to set.- Returns:
- This builder for chaining.
-
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;
- Returns:
- This builder for chaining.
-
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;
- Specified by:
getMaxOutstandingBytes
in interfaceStreamingPullRequestOrBuilder
- Returns:
- The maxOutstandingBytes.
-
setMaxOutstandingBytes
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;
- Parameters:
value
- The maxOutstandingBytes to set.- Returns:
- This builder for chaining.
-
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;
- Returns:
- This builder for chaining.
-
setUnknownFields
public final StreamingPullRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) - Specified by:
setUnknownFields
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<StreamingPullRequest.Builder>
-
mergeUnknownFields
public final StreamingPullRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) - Specified by:
mergeUnknownFields
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<StreamingPullRequest.Builder>
-