# Cloud Pub/Sub v1 API - Class StreamingPullRequest (3.36.0)

3.36.0 (latest) 3.35.0 3.34.0 3.33.0 3.32.0 3.31.0 3.30.0 3.29.0 3.28.0 3.27.0 3.26.0 3.25.0 3.24.0 3.23.0 3.22.0 3.21.0 3.20.0 3.19.0 3.18.0 3.17.0 3.16.0 3.15.0 3.14.0 3.13.0 3.12.0 3.11.0 3.10.1 3.9.1 3.8.0 3.7.0 3.6.0 3.5.1 3.4.0 3.3.0 3.2.0 3.1.0 3.0.0 2.10.0 2.9.0 2.8.0 2.7.0 2.6.0 2.5.0 2.4.0 2.3.0

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

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

Request for the `StreamingPull` streaming RPC method. This request is used to
establish the initial stream as well as to stream acknowledgments and ack
deadline modifications from the client to the server.

## Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) \> StreamingPullRequest

## Implements

[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[StreamingPullRequest](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.PubSub.V1/latest/Google.Cloud.PubSub.V1.StreamingPullRequest), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[StreamingPullRequest](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.PubSub.V1/latest/Google.Cloud.PubSub.V1.StreamingPullRequest), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[StreamingPullRequest](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.PubSub.V1/latest/Google.Cloud.PubSub.V1.StreamingPullRequest), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html)

## Inherited Members

[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) [object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) [object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)

## Namespace

[Google.Cloud.PubSub.V1](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.PubSub.V1/latest/Google.Cloud.PubSub.V1)

## Assembly

Google.Cloud.PubSub.V1.dll

## Constructors

### StreamingPullRequest()

    public StreamingPullRequest()

### StreamingPullRequest(StreamingPullRequest)

    public StreamingPullRequest(StreamingPullRequest other)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `other` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.PubSub.V1/latest/Google.Cloud.PubSub.V1.StreamingPullRequest` |

## Properties

### AckIds

    public RepeatedField<string> AckIds { get; }

Optional. List of acknowledgment 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 acknowledgment
ID is malformed, the stream will be aborted with status `INVALID_ARGUMENT`.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.RepeatedField-1.htmlhttps://learn.microsoft.com/dotnet/api/system.string` |   |

### ClientId

    public string ClientId { get; set; }

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.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### MaxOutstandingBytes

    public long MaxOutstandingBytes { get; set; }

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

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.int64` |   |

### MaxOutstandingMessages

    public long MaxOutstandingMessages { get; set; }

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

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.int64` |   |

### ModifyDeadlineAckIds

    public RepeatedField<string> ModifyDeadlineAckIds { get; }

Optional. List of acknowledgment 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.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.RepeatedField-1.htmlhttps://learn.microsoft.com/dotnet/api/system.string` |   |

### ModifyDeadlineSeconds

    public RepeatedField<int> ModifyDeadlineSeconds { get; }

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

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.RepeatedField-1.htmlhttps://learn.microsoft.com/dotnet/api/system.int32` |   |

### ProtocolVersion

    public long ProtocolVersion { get; set; }

Optional. The protocol version used by the client. 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`.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.int64` |   |

### StreamAckDeadlineSeconds

    public int StreamAckDeadlineSeconds { get; set; }

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

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.int32` |   |

### Subscription

    public string Subscription { get; set; }

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

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### SubscriptionAsSubscriptionName

    public SubscriptionName SubscriptionAsSubscriptionName { get; set; }

[SubscriptionName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.PubSub.V1/latest/Google.Cloud.PubSub.V1.SubscriptionName)-typed view over the [Subscription](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.PubSub.V1/latest/Google.Cloud.PubSub.V1.StreamingPullRequest#Google_Cloud_PubSub_V1_StreamingPullRequest_Subscription) resource name property.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.PubSub.V1/latest/Google.Cloud.PubSub.V1.SubscriptionName` |   |