Class SubscriptionAdminClient (2.21.0)

Required. The name of the subscription. It must have the format "projects/{project}/subscriptions/{subscription}". {subscription} must start with a letter, and contain only letters ([A-Za-z]), numbers ([0-9]), dashes (-), underscores (_), periods (.), tildes (~), plus (+) or percent signs (%). It must be between 3 and 255 characters in length, and it must not start with "goog".

Required. The name of the topic from which this subscription is receiving messages. Format is projects/{project}/topics/{topic}. The value of this field will be _deleted-topic_ if the topic has been deleted.

Optional. If push delivery is used with this subscription, this field is used to configure it.

Optional. The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message. In the interval after the message is delivered and before it is acknowledged, it is considered to be outstanding. During that time period, the message will not be redelivered (on a best-effort basis).
For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call ModifyAckDeadline with the corresponding ack_id if using non-streaming pull or send the ack_id in a StreamingModifyAckDeadlineRequest if using streaming pull. The minimum custom deadline you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds (10 minutes). If this parameter is 0, a default value of 10 seconds is used.
For push delivery, this value is also used to set the request timeout for the call to the push endpoint.
If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message.

Optional. Override the class-level options, such as retry and backoff policies.

the result of the RPC. The response message type (google.pubsub.v1.Subscription) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.pubsub.v1.Subscription. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

Optional. Override the class-level options, such as retry and backoff policies.

the result of the RPC. The response message type (google.pubsub.v1.Subscription) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

Required. The name of the subscription to get. Format is projects/{project}/subscriptions/{sub}.

Optional. Override the class-level options, such as retry and backoff policies.

the result of the RPC. The response message type (google.pubsub.v1.Subscription) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.pubsub.v1.GetSubscriptionRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

Optional. Override the class-level options, such as retry and backoff policies.

the result of the RPC. The response message type (google.pubsub.v1.Subscription) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

Required. The updated subscription object.

Required. Indicates which fields in the provided subscription to update. Must be specified and non-empty.

Optional. Override the class-level options, such as retry and backoff policies.

the result of the RPC. The response message type (google.pubsub.v1.Subscription) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.pubsub.v1.UpdateSubscriptionRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

Optional. Override the class-level options, such as retry and backoff policies.

the result of the RPC. The response message type (google.pubsub.v1.Subscription) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

Required. The name of the project in which to list subscriptions. Format is projects/{project-id}.

Optional. Override the class-level options, such as retry and backoff policies.

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.pubsub.v1.Subscription, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.pubsub.v1.ListSubscriptionsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

Optional. Override the class-level options, such as retry and backoff policies.

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.pubsub.v1.Subscription, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

Required. The subscription to delete. Format is projects/{project}/subscriptions/{sub}.

Optional. Override the class-level options, such as retry and backoff policies.

a Status object. If the request failed, the status contains the details of the failure.

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.pubsub.v1.DeleteSubscriptionRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

Optional. Override the class-level options, such as retry and backoff policies.

a Status object. If the request failed, the status contains the details of the failure.

Required. The name of the subscription. Format is projects/{project}/subscriptions/{sub}.

Required. The push configuration for future deliveries.
An empty pushConfig indicates that the Pub/Sub system should stop pushing messages from the given subscription and allow messages to be pulled and acknowledged - effectively pausing the subscription if Pull or StreamingPull is not called.

Optional. Override the class-level options, such as retry and backoff policies.

a Status object. If the request failed, the status contains the details of the failure.

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.pubsub.v1.ModifyPushConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

Optional. Override the class-level options, such as retry and backoff policies.

a Status object. If the request failed, the status contains the details of the failure.

Required. The name of the snapshot to get. Format is projects/{project}/snapshots/{snap}.

Optional. Override the class-level options, such as retry and backoff policies.

the result of the RPC. The response message type (google.pubsub.v1.Snapshot) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.pubsub.v1.GetSnapshotRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

Optional. Override the class-level options, such as retry and backoff policies.

the result of the RPC. The response message type (google.pubsub.v1.Snapshot) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

Required. The name of the project in which to list snapshots. Format is projects/{project-id}.

Optional. Override the class-level options, such as retry and backoff policies.

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.pubsub.v1.Snapshot, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.pubsub.v1.ListSnapshotsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

Optional. Override the class-level options, such as retry and backoff policies.

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.pubsub.v1.Snapshot, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

Required. User-provided name for this snapshot. If the name is not provided in the request, the server will assign a random name for this snapshot on the same project as the subscription. Note that for REST API requests, you must specify a name. See the resource name rules. Format is projects/{project}/snapshots/{snap}.

Required. The subscription whose backlog the snapshot retains. Specifically, the created snapshot is guaranteed to retain: (a) The existing backlog on the subscription. More precisely, this is defined as the messages in the subscription's backlog that are unacknowledged upon the successful completion of the CreateSnapshot request; as well as: (b) Any messages published to the subscription's topic following the successful completion of the CreateSnapshot request. Format is projects/{project}/subscriptions/{sub}.

Optional. Override the class-level options, such as retry and backoff policies.

the result of the RPC. The response message type (google.pubsub.v1.Snapshot) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.pubsub.v1.CreateSnapshotRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

Optional. Override the class-level options, such as retry and backoff policies.

the result of the RPC. The response message type (google.pubsub.v1.Snapshot) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

Required. The updated snapshot object.

Required. Indicates which fields in the provided snapshot to update. Must be specified and non-empty.

Optional. Override the class-level options, such as retry and backoff policies.

the result of the RPC. The response message type (google.pubsub.v1.Snapshot) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.pubsub.v1.UpdateSnapshotRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

Optional. Override the class-level options, such as retry and backoff policies.

the result of the RPC. The response message type (google.pubsub.v1.Snapshot) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

Required. The name of the snapshot to delete. Format is projects/{project}/snapshots/{snap}.

Optional. Override the class-level options, such as retry and backoff policies.

a Status object. If the request failed, the status contains the details of the failure.

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.pubsub.v1.DeleteSnapshotRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

Optional. Override the class-level options, such as retry and backoff policies.

a Status object. If the request failed, the status contains the details of the failure.

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.pubsub.v1.SeekRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

Optional. Override the class-level options, such as retry and backoff policies.

the result of the RPC. The response message type (google.pubsub.v1.SeekResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.