Packages

c

com.google.pubsub.v1

StreamingPullRequest

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

Source
StreamingPullRequest.java
Linear Supertypes
StreamingPullRequestOrBuilder, GeneratedMessageV3, Serializable, AbstractMessage, Message, MessageOrBuilder, AbstractMessageLite[MessageType, BuilderType], MessageLite, MessageLiteOrBuilder, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StreamingPullRequest
  2. StreamingPullRequestOrBuilder
  3. GeneratedMessageV3
  4. Serializable
  5. AbstractMessage
  6. Message
  7. MessageOrBuilder
  8. AbstractMessageLite
  9. MessageLite
  10. MessageLiteOrBuilder
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(obj: Any): Boolean
    Definition Classes
    StreamingPullRequest → AbstractMessage → Message → AnyRef → Any
  8. def findInitializationErrors(): List[String]
    Definition Classes
    AbstractMessage → MessageOrBuilder
  9. 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
  10. 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
  11. 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
  12. 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
  13. def getAllFields(): Map[FieldDescriptor, AnyRef]
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  14. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. 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
  16. 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
  17. def getDefaultInstanceForType(): StreamingPullRequest
    Definition Classes
    StreamingPullRequest → MessageOrBuilder → MessageLiteOrBuilder
  18. def getDescriptorForType(): Descriptor
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  19. def getField(arg0: FieldDescriptor): AnyRef
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  20. def getInitializationErrorString(): String
    Definition Classes
    AbstractMessage → MessageOrBuilder
  21. 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
  22. 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
  23. 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
  24. 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
  25. 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
  26. 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
  27. 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
  28. def getOneofFieldDescriptor(arg0: OneofDescriptor): FieldDescriptor
    Definition Classes
    GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
  29. def getParserForType(): Parser[StreamingPullRequest]
    Definition Classes
    StreamingPullRequest → GeneratedMessageV3 → Message → MessageLite
  30. def getRepeatedField(arg0: FieldDescriptor, arg1: Int): AnyRef
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  31. def getRepeatedFieldCount(arg0: FieldDescriptor): Int
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  32. def getSerializedSize(): Int
    Definition Classes
    StreamingPullRequest → GeneratedMessageV3 → AbstractMessage → MessageLite
  33. 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
  34. 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
  35. 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
  36. final def getUnknownFields(): UnknownFieldSet
    Definition Classes
    StreamingPullRequest → GeneratedMessageV3 → MessageOrBuilder
  37. def hasField(arg0: FieldDescriptor): Boolean
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  38. def hasOneof(arg0: OneofDescriptor): Boolean
    Definition Classes
    GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
  39. def hashCode(): Int
    Definition Classes
    StreamingPullRequest → AbstractMessage → Message → AnyRef → Any
  40. def internalGetFieldAccessorTable(): FieldAccessorTable
    Attributes
    protected[v1]
    Definition Classes
    StreamingPullRequest → GeneratedMessageV3
  41. def internalGetMapField(arg0: Int): MapField[_, _]
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
  42. final def isInitialized(): Boolean
    Definition Classes
    StreamingPullRequest → GeneratedMessageV3 → AbstractMessage → MessageLiteOrBuilder
  43. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  44. def makeExtensionsImmutable(): Unit
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
  45. def mergeFromAndMakeImmutableInternal(arg0: CodedInputStream, arg1: ExtensionRegistryLite): Unit
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws( ... )
  46. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  47. def newBuilderForType(parent: BuilderParent): Builder
    Attributes
    protected[v1]
    Definition Classes
    StreamingPullRequest → GeneratedMessageV3
  48. def newBuilderForType(): Builder
    Definition Classes
    StreamingPullRequest → Message → MessageLite
  49. def newBuilderForType(arg0: BuilderParent): Builder
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3 → AbstractMessage
  50. def newInstance(unused: UnusedPrivateParameter): AnyRef
    Attributes
    protected[v1]
    Definition Classes
    StreamingPullRequest → GeneratedMessageV3
  51. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  52. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  53. def parseUnknownField(arg0: CodedInputStream, arg1: Builder, arg2: ExtensionRegistryLite, arg3: Int): Boolean
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws( classOf[java.io.IOException] )
  54. def parseUnknownFieldProto3(arg0: CodedInputStream, arg1: Builder, arg2: ExtensionRegistryLite, arg3: Int): Boolean
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws( classOf[java.io.IOException] )
  55. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  56. def toBuilder(): Builder
    Definition Classes
    StreamingPullRequest → Message → MessageLite
  57. def toByteArray(): Array[Byte]
    Definition Classes
    AbstractMessageLite → MessageLite
  58. def toByteString(): ByteString
    Definition Classes
    AbstractMessageLite → MessageLite
  59. final def toString(): String
    Definition Classes
    AbstractMessage → Message → AnyRef → Any
  60. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  61. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  62. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  63. def writeDelimitedTo(arg0: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws( classOf[java.io.IOException] )
  64. def writeReplace(): AnyRef
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws( ... )
  65. def writeTo(output: CodedOutputStream): Unit
    Definition Classes
    StreamingPullRequest → GeneratedMessageV3 → AbstractMessage → MessageLite
  66. def writeTo(arg0: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws( classOf[java.io.IOException] )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from StreamingPullRequestOrBuilder

Inherited from GeneratedMessageV3

Inherited from Serializable

Inherited from AbstractMessage

Inherited from Message

Inherited from MessageOrBuilder

Inherited from AbstractMessageLite[MessageType, BuilderType]

Inherited from MessageLite

Inherited from MessageLiteOrBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped