Packages

t

com.google.pubsub.v1

StreamingPullRequestOrBuilder

trait StreamingPullRequestOrBuilder extends MessageOrBuilder

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StreamingPullRequestOrBuilder
  2. MessageOrBuilder
  3. MessageLiteOrBuilder
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def findInitializationErrors(): List[String]
    Definition Classes
    MessageOrBuilder
  2. abstract def getAckIds(index: Int): String

    Optional. 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`.


    Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

    index

    The index of the element to return.

    returns

    The ackIds at the given index.

  3. abstract def getAckIdsBytes(index: Int): ByteString

    Optional. 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`.


    Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

    index

    The index of the value to return.

    returns

    The bytes of the ackIds at the given index.

  4. abstract def getAckIdsCount(): Int

    Optional. 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`.


    Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

    returns

    The count of ackIds.

  5. abstract def getAckIdsList(): List[String]

    Optional. 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`.


    Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

    returns

    A list containing the ackIds.

  6. abstract def getAllFields(): Map[FieldDescriptor, AnyRef]
    Definition Classes
    MessageOrBuilder
  7. abstract def getClientId(): String

    Optional. 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.


    Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

    returns

    The clientId.

  8. abstract def getClientIdBytes(): ByteString

    Optional. 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.


    Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

    returns

    The bytes for clientId.

  9. abstract def getDefaultInstanceForType(): Message
    Definition Classes
    MessageOrBuilder → MessageLiteOrBuilder
  10. abstract def getDescriptorForType(): Descriptor
    Definition Classes
    MessageOrBuilder
  11. abstract def getField(arg0: FieldDescriptor): AnyRef
    Definition Classes
    MessageOrBuilder
  12. abstract def getInitializationErrorString(): String
    Definition Classes
    MessageOrBuilder
  13. abstract def getMaxOutstandingBytes(): Long

    Optional. 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`.


    Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

    returns

    The maxOutstandingBytes.

  14. abstract def getMaxOutstandingMessages(): Long

    Optional. Flow control settings for the maximum number of outstanding
messages. When there are `max_outstanding_messages` 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`.


    Optional. Flow control settings for the maximum number of outstanding
messages. When there are `max_outstanding_messages` 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 [(.google.api.field_behavior) = OPTIONAL];

    returns

    The maxOutstandingMessages.

  15. abstract def getModifyDeadlineAckIds(index: Int): String

    Optional. 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.


    Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

    index

    The index of the element to return.

    returns

    The modifyDeadlineAckIds at the given index.

  16. abstract def getModifyDeadlineAckIdsBytes(index: Int): ByteString

    Optional. 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.


    Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

    index

    The index of the value to return.

    returns

    The bytes of the modifyDeadlineAckIds at the given index.

  17. abstract def getModifyDeadlineAckIdsCount(): Int

    Optional. 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.


    Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

    returns

    The count of modifyDeadlineAckIds.

  18. abstract def getModifyDeadlineAckIdsList(): List[String]

    Optional. 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.


    Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

    returns

    A list containing the modifyDeadlineAckIds.

  19. abstract def getModifyDeadlineSeconds(index: Int): Int

    Optional. 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`.


    Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

    index

    The index of the element to return.

    returns

    The modifyDeadlineSeconds at the given index.

  20. abstract def getModifyDeadlineSecondsCount(): Int

    Optional. 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`.


    Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

    returns

    The count of modifyDeadlineSeconds.

  21. abstract def getModifyDeadlineSecondsList(): List[Integer]

    Optional. 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`.


    Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

    returns

    A list containing the modifyDeadlineSeconds.

  22. abstract def getOneofFieldDescriptor(arg0: OneofDescriptor): FieldDescriptor
    Definition Classes
    MessageOrBuilder
  23. abstract def getRepeatedField(arg0: FieldDescriptor, arg1: Int): AnyRef
    Definition Classes
    MessageOrBuilder
  24. abstract def getRepeatedFieldCount(arg0: FieldDescriptor): Int
    Definition Classes
    MessageOrBuilder
  25. abstract 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.

  26. abstract 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.

  27. abstract 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.

  28. abstract def getUnknownFields(): UnknownFieldSet
    Definition Classes
    MessageOrBuilder
  29. abstract def hasField(arg0: FieldDescriptor): Boolean
    Definition Classes
    MessageOrBuilder
  30. abstract def hasOneof(arg0: OneofDescriptor): Boolean
    Definition Classes
    MessageOrBuilder
  31. abstract def isInitialized(): Boolean
    Definition Classes
    MessageLiteOrBuilder

Concrete 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(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from MessageOrBuilder

Inherited from MessageLiteOrBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped