Packages

c

com.google.pubsub.v1

PullRequest

final class PullRequest extends GeneratedMessageV3 with PullRequestOrBuilder

Request for the `Pull` method.

Protobuf type google.pubsub.v1.PullRequest

Source
PullRequest.java
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PullRequest
  2. PullRequestOrBuilder
  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. Protected

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(obj: AnyRef): Boolean
    Definition Classes
    PullRequest → AbstractMessage → Message → AnyRef → Any
    Annotations
    @Override()
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. def findInitializationErrors(): List[String]
    Definition Classes
    AbstractMessage → MessageOrBuilder
  10. def getAllFields(): Map[FieldDescriptor, AnyRef]
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def getDefaultInstanceForType(): PullRequest
    Definition Classes
    PullRequest → MessageOrBuilder → MessageLiteOrBuilder
    Annotations
    @Override()
  13. def getDescriptorForType(): Descriptor
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  14. def getField(arg0: FieldDescriptor): AnyRef
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  15. def getInitializationErrorString(): String
    Definition Classes
    AbstractMessage → MessageOrBuilder
  16. def getMaxMessages(): Int

    Required. The maximum number of messages to return for this request. Must
    be a positive integer. The Pub/Sub system may return fewer than the number
    specified.
    

    Required. The maximum number of messages to return for this request. Must
    be a positive integer. The Pub/Sub system may return fewer than the number
    specified.
    

    int32 max_messages = 3 [(.google.api.field_behavior) = REQUIRED];

    returns

    The maxMessages.

    Definition Classes
    PullRequestPullRequestOrBuilder
    Annotations
    @Override()
  17. def getOneofFieldDescriptor(arg0: OneofDescriptor): FieldDescriptor
    Definition Classes
    GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
  18. def getParserForType(): Parser[PullRequest]
    Definition Classes
    PullRequest → GeneratedMessageV3 → Message → MessageLite
    Annotations
    @Override()
  19. def getRepeatedField(arg0: FieldDescriptor, arg1: Int): AnyRef
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  20. def getRepeatedFieldCount(arg0: FieldDescriptor): Int
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  21. def getSerializedSize(): Int
    Definition Classes
    PullRequest → GeneratedMessageV3 → AbstractMessage → MessageLite
    Annotations
    @Override()
  22. def getSubscription(): String

    Required. The subscription from which messages should be pulled.
    Format is `projects/{project}/subscriptions/{sub}`.
    

    Required. The subscription from which messages should be pulled.
    Format is `projects/{project}/subscriptions/{sub}`.
    

    string subscription = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

    returns

    The subscription.

    Definition Classes
    PullRequestPullRequestOrBuilder
    Annotations
    @Override()
  23. def getSubscriptionBytes(): ByteString

    Required. The subscription from which messages should be pulled.
    Format is `projects/{project}/subscriptions/{sub}`.
    

    Required. The subscription from which messages should be pulled.
    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
    PullRequestPullRequestOrBuilder
    Annotations
    @Override()
  24. final def getUnknownFields(): UnknownFieldSet
    Definition Classes
    PullRequest → GeneratedMessageV3 → MessageOrBuilder
    Annotations
    @Override()
  25. def hasField(arg0: FieldDescriptor): Boolean
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  26. def hasOneof(arg0: OneofDescriptor): Boolean
    Definition Classes
    GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
  27. def hashCode(): Int
    Definition Classes
    PullRequest → AbstractMessage → Message → AnyRef → Any
    Annotations
    @Override()
  28. def internalGetFieldAccessorTable(): FieldAccessorTable
    Attributes
    protected[v1]
    Definition Classes
    PullRequest → GeneratedMessageV3
    Annotations
    @Override()
  29. def internalGetMapField(arg0: Int): MapField[_ <: AnyRef, _ <: AnyRef]
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
  30. final def isInitialized(): Boolean
    Definition Classes
    PullRequest → GeneratedMessageV3 → AbstractMessage → MessageLiteOrBuilder
    Annotations
    @Override()
  31. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  32. def makeExtensionsImmutable(): Unit
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
  33. def mergeFromAndMakeImmutableInternal(arg0: CodedInputStream, arg1: ExtensionRegistryLite): Unit
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[com.google.protobuf.InvalidProtocolBufferException])
  34. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  35. def newBuilderForType(parent: BuilderParent): Builder
    Attributes
    protected[v1]
    Definition Classes
    PullRequest → GeneratedMessageV3
    Annotations
    @Override()
  36. def newBuilderForType(): Builder
    Definition Classes
    PullRequest → Message → MessageLite
    Annotations
    @Override()
  37. def newBuilderForType(arg0: BuilderParent): Builder
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3 → AbstractMessage
  38. def newInstance(unused: UnusedPrivateParameter): AnyRef
    Attributes
    protected[v1]
    Definition Classes
    PullRequest → GeneratedMessageV3
    Annotations
    @Override() @SuppressWarnings()
  39. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  40. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  41. def parseUnknownField(arg0: CodedInputStream, arg1: Builder, arg2: ExtensionRegistryLite, arg3: Int): Boolean
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[java.io.IOException])
  42. def parseUnknownFieldProto3(arg0: CodedInputStream, arg1: Builder, arg2: ExtensionRegistryLite, arg3: Int): Boolean
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[java.io.IOException])
  43. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  44. def toBuilder(): Builder
    Definition Classes
    PullRequest → Message → MessageLite
    Annotations
    @Override()
  45. def toByteArray(): Array[Byte]
    Definition Classes
    AbstractMessageLite → MessageLite
  46. def toByteString(): ByteString
    Definition Classes
    AbstractMessageLite → MessageLite
  47. final def toString(): String
    Definition Classes
    AbstractMessage → Message → AnyRef → Any
  48. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  49. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  50. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  51. def writeDelimitedTo(arg0: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws(classOf[java.io.IOException])
  52. def writeReplace(): AnyRef
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[java.io.ObjectStreamException])
  53. def writeTo(output: CodedOutputStream): Unit
    Definition Classes
    PullRequest → GeneratedMessageV3 → AbstractMessage → MessageLite
    Annotations
    @Override()
  54. def writeTo(arg0: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws(classOf[java.io.IOException])

Deprecated Value Members

  1. def getReturnImmediately(): Boolean

    Optional. If this field set to true, the system will respond immediately
    even if it there are no messages available to return in the `Pull`
    response. Otherwise, the system may wait (for a bounded amount of time)
    until at least one message is available, rather than returning no messages.
    Warning: setting this field to `true` is discouraged because it adversely
    impacts the performance of `Pull` operations. We recommend that users do
    not set this field.
    

    Optional. If this field set to true, the system will respond immediately
    even if it there are no messages available to return in the `Pull`
    response. Otherwise, the system may wait (for a bounded amount of time)
    until at least one message is available, rather than returning no messages.
    Warning: setting this field to `true` is discouraged because it adversely
    impacts the performance of `Pull` operations. We recommend that users do
    not set this field.
    

    bool return_immediately = 2 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

    returns

    The returnImmediately.

    Definition Classes
    PullRequestPullRequestOrBuilder
    Annotations
    @Override() @Deprecated
    Deprecated

Inherited from PullRequestOrBuilder

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