Cloud Pub/Sub v1 API - Class PullRequest (3.19.0)

public sealed class PullRequest : IMessage<PullRequest>, IEquatable<PullRequest>, IDeepCloneable<PullRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud Pub/Sub v1 API class PullRequest.

Request for the Pull method.

Inheritance

object > PullRequest

Namespace

Google.Cloud.PubSub.V1

Assembly

Google.Cloud.PubSub.V1.dll

Constructors

PullRequest()

public PullRequest()

PullRequest(PullRequest)

public PullRequest(PullRequest other)
Parameter
Name Description
other PullRequest

Properties

MaxMessages

public int MaxMessages { get; set; }

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.

Property Value
Type Description
int

ReturnImmediately

[Obsolete]
public bool ReturnImmediately { get; set; }

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.

Property Value
Type Description
bool

Subscription

public string Subscription { get; set; }

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

Property Value
Type Description
string

SubscriptionAsSubscriptionName

public SubscriptionName SubscriptionAsSubscriptionName { get; set; }

SubscriptionName-typed view over the Subscription resource name property.

Property Value
Type Description
SubscriptionName