com.google.pubsub.v1

Interface StreamingPullRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

StreamingPullRequest, StreamingPullRequest.Builder

public interface StreamingPullRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
java.lang.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).
java.util.List<java.lang.String>	getAckIdsList() List of acknowledgement IDs for acknowledging previously received messages (received on this stream or a different stream).
java.lang.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`.
java.util.List<java.lang.String>	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`.
java.util.List<java.lang.Integer>	getModifyDeadlineSecondsList() The list of new ack deadlines for the IDs listed in `modify_deadline_ack_ids`.
int	getStreamAckDeadlineSeconds() The ack deadline to use for the stream.
java.lang.String	getSubscription() The subscription for which to initialize the new stream.
com.google.protobuf.ByteString	getSubscriptionBytes() The subscription for which to initialize the new stream.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getSubscription

java.lang.String getSubscription()

 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;

getSubscriptionBytes

com.google.protobuf.ByteString getSubscriptionBytes()

 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;

getAckIdsList

java.util.List<java.lang.String> 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;

getAckIdsCount

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;

getAckIds

java.lang.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;

getAckIdsBytes

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;

getModifyDeadlineSecondsList

java.util.List<java.lang.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;

getModifyDeadlineSecondsCount

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;

getModifyDeadlineSeconds

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;

getModifyDeadlineAckIdsList

java.util.List<java.lang.String> 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;

getModifyDeadlineAckIdsCount

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;

getModifyDeadlineAckIds

java.lang.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;

getModifyDeadlineAckIdsBytes

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;

getStreamAckDeadlineSeconds

int getStreamAckDeadlineSeconds()

 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;