Package com.google.pubsub.v1

Interface PullRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    PullRequest, PullRequest.Builder
    public interface PullRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      int getMaxMessages()
      Required.
      boolean getReturnImmediately()
      Deprecated.
      google.pubsub.v1.PullRequest.return_immediately is deprecated.
      String getSubscription()
      Required.
      com.google.protobuf.ByteString getSubscriptionBytes()
      Required.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

    • Method Detail

      • getSubscription

        String getSubscription()
         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.

      • getSubscriptionBytes

        com.google.protobuf.ByteString getSubscriptionBytes()
         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.

      • getReturnImmediately

        @Deprecated
boolean getReturnImmediately()
        Deprecated.
        google.pubsub.v1.PullRequest.return_immediately is deprecated. See google/pubsub/v1/pubsub.proto;l=1226
         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.

      • getMaxMessages

        int getMaxMessages()
         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.