final class StreamingPullRequest extends GeneratedMessageV3 with 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
- Alphabetic
- By Inheritance
- StreamingPullRequest
- StreamingPullRequestOrBuilder
- GeneratedMessageV3
- Serializable
- AbstractMessage
- Message
- MessageOrBuilder
- AbstractMessageLite
- MessageLite
- MessageLiteOrBuilder
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(obj: AnyRef): Boolean
- Definition Classes
- StreamingPullRequest → AbstractMessage → Message → AnyRef → Any
- Annotations
- @Override()
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def findInitializationErrors(): List[String]
- Definition Classes
- AbstractMessage → MessageOrBuilder
- def getAckIds(index: Int): String
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`.
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 of the element to return.
- returns
The ackIds at the given index.
- Definition Classes
- StreamingPullRequest → StreamingPullRequestOrBuilder
- def getAckIdsBytes(index: Int): ByteString
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`.
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 of the value to return.
- returns
The bytes of the ackIds at the given index.
- Definition Classes
- StreamingPullRequest → StreamingPullRequestOrBuilder
- def getAckIdsCount(): Int
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`.
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
The count of ackIds.
- Definition Classes
- StreamingPullRequest → StreamingPullRequestOrBuilder
- def getAckIdsList(): ProtocolStringList
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`.
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
A list containing the ackIds.
- Definition Classes
- StreamingPullRequest → StreamingPullRequestOrBuilder
- def getAllFields(): Map[FieldDescriptor, AnyRef]
- Definition Classes
- GeneratedMessageV3 → MessageOrBuilder
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def getClientId(): String
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.
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
The clientId.
- Definition Classes
- StreamingPullRequest → StreamingPullRequestOrBuilder
- Annotations
- @Override()
- def getClientIdBytes(): ByteString
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.
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
The bytes for clientId.
- Definition Classes
- StreamingPullRequest → StreamingPullRequestOrBuilder
- Annotations
- @Override()
- def getDefaultInstanceForType(): StreamingPullRequest
- Definition Classes
- StreamingPullRequest → MessageOrBuilder → MessageLiteOrBuilder
- Annotations
- @Override()
- def getDescriptorForType(): Descriptor
- Definition Classes
- GeneratedMessageV3 → MessageOrBuilder
- def getField(arg0: FieldDescriptor): AnyRef
- Definition Classes
- GeneratedMessageV3 → MessageOrBuilder
- def getInitializationErrorString(): String
- Definition Classes
- AbstractMessage → MessageOrBuilder
- def getMaxOutstandingBytes(): Long
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`.
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
The maxOutstandingBytes.
- Definition Classes
- StreamingPullRequest → StreamingPullRequestOrBuilder
- Annotations
- @Override()
- def getMaxOutstandingMessages(): Long
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`.
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
The maxOutstandingMessages.
- Definition Classes
- StreamingPullRequest → StreamingPullRequestOrBuilder
- Annotations
- @Override()
- def getModifyDeadlineAckIds(index: Int): String
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.
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 of the element to return.
- returns
The modifyDeadlineAckIds at the given index.
- Definition Classes
- StreamingPullRequest → StreamingPullRequestOrBuilder
- def getModifyDeadlineAckIdsBytes(index: Int): ByteString
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.
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 of the value to return.
- returns
The bytes of the modifyDeadlineAckIds at the given index.
- Definition Classes
- StreamingPullRequest → StreamingPullRequestOrBuilder
- def getModifyDeadlineAckIdsCount(): Int
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.
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
The count of modifyDeadlineAckIds.
- Definition Classes
- StreamingPullRequest → StreamingPullRequestOrBuilder
- def getModifyDeadlineAckIdsList(): ProtocolStringList
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.
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
A list containing the modifyDeadlineAckIds.
- Definition Classes
- StreamingPullRequest → StreamingPullRequestOrBuilder
- def getModifyDeadlineSeconds(index: Int): Int
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`.
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 of the element to return.
- returns
The modifyDeadlineSeconds at the given index.
- Definition Classes
- StreamingPullRequest → StreamingPullRequestOrBuilder
- def getModifyDeadlineSecondsCount(): Int
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`.
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
The count of modifyDeadlineSeconds.
- Definition Classes
- StreamingPullRequest → StreamingPullRequestOrBuilder
- def getModifyDeadlineSecondsList(): List[Integer]
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`.
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
A list containing the modifyDeadlineSeconds.
- Definition Classes
- StreamingPullRequest → StreamingPullRequestOrBuilder
- Annotations
- @Override()
- def getOneofFieldDescriptor(arg0: OneofDescriptor): FieldDescriptor
- Definition Classes
- GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
- def getParserForType(): Parser[StreamingPullRequest]
- Definition Classes
- StreamingPullRequest → GeneratedMessageV3 → Message → MessageLite
- Annotations
- @Override()
- def getRepeatedField(arg0: FieldDescriptor, arg1: Int): AnyRef
- Definition Classes
- GeneratedMessageV3 → MessageOrBuilder
- def getRepeatedFieldCount(arg0: FieldDescriptor): Int
- Definition Classes
- GeneratedMessageV3 → MessageOrBuilder
- def getSerializedSize(): Int
- Definition Classes
- StreamingPullRequest → GeneratedMessageV3 → AbstractMessage → MessageLite
- Annotations
- @Override()
- def getStreamAckDeadlineSeconds(): Int
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).
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
The streamAckDeadlineSeconds.
- Definition Classes
- StreamingPullRequest → StreamingPullRequestOrBuilder
- Annotations
- @Override()
- def getSubscription(): String
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}`.
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
The subscription.
- Definition Classes
- StreamingPullRequest → StreamingPullRequestOrBuilder
- Annotations
- @Override()
- def getSubscriptionBytes(): ByteString
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}`.
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
The bytes for subscription.
- Definition Classes
- StreamingPullRequest → StreamingPullRequestOrBuilder
- Annotations
- @Override()
- final def getUnknownFields(): UnknownFieldSet
- Definition Classes
- StreamingPullRequest → GeneratedMessageV3 → MessageOrBuilder
- Annotations
- @Override()
- def hasField(arg0: FieldDescriptor): Boolean
- Definition Classes
- GeneratedMessageV3 → MessageOrBuilder
- def hasOneof(arg0: OneofDescriptor): Boolean
- Definition Classes
- GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
- def hashCode(): Int
- Definition Classes
- StreamingPullRequest → AbstractMessage → Message → AnyRef → Any
- Annotations
- @Override()
- def internalGetFieldAccessorTable(): FieldAccessorTable
- Attributes
- protected[v1]
- Definition Classes
- StreamingPullRequest → GeneratedMessageV3
- Annotations
- @Override()
- def internalGetMapField(arg0: Int): MapField[_ <: AnyRef, _ <: AnyRef]
- Attributes
- protected[protobuf]
- Definition Classes
- GeneratedMessageV3
- final def isInitialized(): Boolean
- Definition Classes
- StreamingPullRequest → GeneratedMessageV3 → AbstractMessage → MessageLiteOrBuilder
- Annotations
- @Override()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def makeExtensionsImmutable(): Unit
- Attributes
- protected[protobuf]
- Definition Classes
- GeneratedMessageV3
- def mergeFromAndMakeImmutableInternal(arg0: CodedInputStream, arg1: ExtensionRegistryLite): Unit
- Attributes
- protected[protobuf]
- Definition Classes
- GeneratedMessageV3
- Annotations
- @throws(classOf[com.google.protobuf.InvalidProtocolBufferException])
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def newBuilderForType(parent: BuilderParent): Builder
- Attributes
- protected[v1]
- Definition Classes
- StreamingPullRequest → GeneratedMessageV3
- Annotations
- @Override()
- def newBuilderForType(): Builder
- Definition Classes
- StreamingPullRequest → Message → MessageLite
- Annotations
- @Override()
- def newBuilderForType(arg0: BuilderParent): Builder
- Attributes
- protected[protobuf]
- Definition Classes
- GeneratedMessageV3 → AbstractMessage
- def newInstance(unused: UnusedPrivateParameter): AnyRef
- Attributes
- protected[v1]
- Definition Classes
- StreamingPullRequest → GeneratedMessageV3
- Annotations
- @Override() @SuppressWarnings()
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def parseUnknownField(arg0: CodedInputStream, arg1: Builder, arg2: ExtensionRegistryLite, arg3: Int): Boolean
- Attributes
- protected[protobuf]
- Definition Classes
- GeneratedMessageV3
- Annotations
- @throws(classOf[java.io.IOException])
- def parseUnknownFieldProto3(arg0: CodedInputStream, arg1: Builder, arg2: ExtensionRegistryLite, arg3: Int): Boolean
- Attributes
- protected[protobuf]
- Definition Classes
- GeneratedMessageV3
- Annotations
- @throws(classOf[java.io.IOException])
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toBuilder(): Builder
- Definition Classes
- StreamingPullRequest → Message → MessageLite
- Annotations
- @Override()
- def toByteArray(): Array[Byte]
- Definition Classes
- AbstractMessageLite → MessageLite
- def toByteString(): ByteString
- Definition Classes
- AbstractMessageLite → MessageLite
- final def toString(): String
- Definition Classes
- AbstractMessage → Message → AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- def writeDelimitedTo(arg0: OutputStream): Unit
- Definition Classes
- AbstractMessageLite → MessageLite
- Annotations
- @throws(classOf[java.io.IOException])
- def writeReplace(): AnyRef
- Attributes
- protected[protobuf]
- Definition Classes
- GeneratedMessageV3
- Annotations
- @throws(classOf[java.io.ObjectStreamException])
- def writeTo(output: CodedOutputStream): Unit
- Definition Classes
- StreamingPullRequest → GeneratedMessageV3 → AbstractMessage → MessageLite
- Annotations
- @Override()
- def writeTo(arg0: OutputStream): Unit
- Definition Classes
- AbstractMessageLite → MessageLite
- Annotations
- @throws(classOf[java.io.IOException])