com.google.pubsub.v1

Class StreamingPullRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.pubsub.v1.StreamingPullRequest

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, StreamingPullRequestOrBuilder, java.io.Serializable

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StreamingPullRequest.Builder Request for the `StreamingPull` streaming RPC method.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields

Modifier and Type	Field and Description
static int	ACK_IDS_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

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
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).
com.google.protobuf.ProtocolStringList	getAckIdsList() List of acknowledgement IDs for acknowledging previously received messages (received on this stream or a different stream).
static StreamingPullRequest	getDefaultInstance()
StreamingPullRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
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`.
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`.
java.util.List<java.lang.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() The ack deadline to use for the stream.
java.lang.String	getSubscription() The subscription for which to initialize the new stream.
SubscriptionName	getSubscriptionAsSubscriptionName()
com.google.protobuf.ByteString	getSubscriptionBytes() The subscription for which to initialize the new stream.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
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)
static StreamingPullRequest	parseDelimitedFrom(java.io.InputStream input)
static StreamingPullRequest	parseDelimitedFrom(java.io.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(java.nio.ByteBuffer data)
static StreamingPullRequest	parseFrom(java.nio.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(java.io.InputStream input)
static StreamingPullRequest	parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<StreamingPullRequest>	parser()
StreamingPullRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

SUBSCRIPTION_FIELD_NUMBER

public static final int SUBSCRIPTION_FIELD_NUMBER

See Also:

Constant Field Values

ACK_IDS_FIELD_NUMBER

public static final int ACK_IDS_FIELD_NUMBER

See Also:

Constant Field Values

MODIFY_DEADLINE_SECONDS_FIELD_NUMBER

public static final int MODIFY_DEADLINE_SECONDS_FIELD_NUMBER

See Also:

Constant Field Values

MODIFY_DEADLINE_ACK_IDS_FIELD_NUMBER

public static final int MODIFY_DEADLINE_ACK_IDS_FIELD_NUMBER

See Also:

Constant Field Values

STREAM_ACK_DEADLINE_SECONDS_FIELD_NUMBER

public static final int STREAM_ACK_DEADLINE_SECONDS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getSubscription

public 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;

Specified by:

getSubscription in interface StreamingPullRequestOrBuilder

getSubscriptionBytes

public 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;

Specified by:

getSubscriptionBytes in interface StreamingPullRequestOrBuilder

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 interface StreamingPullRequestOrBuilder

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 interface StreamingPullRequestOrBuilder

getAckIds

public 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;

Specified by:

getAckIds in interface StreamingPullRequestOrBuilder

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 interface StreamingPullRequestOrBuilder

getModifyDeadlineSecondsList

public 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;

Specified by:

getModifyDeadlineSecondsList in interface StreamingPullRequestOrBuilder

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 interface StreamingPullRequestOrBuilder

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 interface StreamingPullRequestOrBuilder

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 interface StreamingPullRequestOrBuilder

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 interface StreamingPullRequestOrBuilder

getModifyDeadlineAckIds

public 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;

Specified by:

getModifyDeadlineAckIds in interface StreamingPullRequestOrBuilder

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 interface StreamingPullRequestOrBuilder

getStreamAckDeadlineSeconds

public 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;

Specified by:

getStreamAckDeadlineSeconds in interface StreamingPullRequestOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static StreamingPullRequest parseFrom(java.nio.ByteBuffer data)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StreamingPullRequest parseFrom(java.nio.ByteBuffer data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StreamingPullRequest parseFrom(com.google.protobuf.ByteString data)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StreamingPullRequest parseFrom(com.google.protobuf.ByteString data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StreamingPullRequest parseFrom(byte[] data)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StreamingPullRequest parseFrom(byte[] data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StreamingPullRequest parseFrom(java.io.InputStream input)
                                      throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static StreamingPullRequest parseFrom(java.io.InputStream input,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static StreamingPullRequest parseDelimitedFrom(java.io.InputStream input)
                                               throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static StreamingPullRequest parseDelimitedFrom(java.io.InputStream input,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static StreamingPullRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                      throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static StreamingPullRequest parseFrom(com.google.protobuf.CodedInputStream input,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public StreamingPullRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static StreamingPullRequest.Builder newBuilder()

newBuilder

public static StreamingPullRequest.Builder newBuilder(StreamingPullRequest prototype)

toBuilder

public StreamingPullRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected StreamingPullRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getSubscriptionAsSubscriptionName

public final SubscriptionName getSubscriptionAsSubscriptionName()

getDefaultInstance

public static StreamingPullRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<StreamingPullRequest> parser()

getParserForType

public com.google.protobuf.Parser<StreamingPullRequest> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public StreamingPullRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder