Performs subscription administrative operations in Cloud Pub/Sub.
Applications use this class to perform subscription administrative operations on Cloud Pub/Sub.
Performance
SubscriptionAdminClient objects are relatively cheap to create, copy, and move. However, each SubscriptionAdminClient object must be created with a std::shared_ptr<SubscriptionAdminConnection>, which itself is relatively expensive to create. Therefore, connection instances should be shared when possible. See the MakeSubscriptionAdminConnection() function and the SubscriptionAdminConnection interface for more details.
Thread Safety
Instances of this class created via copy-construction or copy-assignment share the underlying pool of connections. Access to these copies via multiple threads is guaranteed to work. Two threads operating on the same instance of this class is not guaranteed to work.
Error Handling
This class uses StatusOr<T> to report errors. When an operation fails to perform its work the returned StatusOr<T> contains the error details. If the ok() member function in the StatusOr<T> returns true then it contains the expected result. Please consult the StatusOr documentation for more details.
Constructors
SubscriptionAdminClient(std::shared_ptr< SubscriptionAdminConnection >, Options)
| Parameters | |
|---|---|
| Name | Description |
connection |
std::shared_ptr< SubscriptionAdminConnection >
|
opts |
Options
|
SubscriptionAdminClient()
The default constructor is deleted.
Use SubscriberClient(std::shared_ptr<SubscriberConnection>)
Functions
CreateSubscription(Topic const &, Subscription const &, SubscriptionBuilder, Options)
Creates a new subscription in Cloud Pub/Sub.
Idempotency
This operation is idempotent, the state of the system is the same after one or several calls, and therefore it is always retried. It might return a status code of kAlreadyExists as a consequence of retrying a successful (but reported as failed) request.
| Parameters | |
|---|---|
| Name | Description |
topic |
Topic const &
the topic that the subscription will attach to |
subscription |
Subscription const &
the name for the subscription |
builder |
SubscriptionBuilder
any additional configuration for the subscription |
opts |
Options
Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::pubsub::v1::Subscription > |
|
GetSubscription(Subscription, Options)
Gets the metadata for an existing Cloud Pub/Sub subscription.
Idempotency
This is a read-only operation and therefore always idempotent and retried.
| Parameters | |
|---|---|
| Name | Description |
subscription |
Subscription
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::pubsub::v1::Subscription > |
|
UpdateSubscription(Subscription const &, SubscriptionBuilder, Options)
Updates an existing subscription in Cloud Pub/Sub.
Idempotency
This operation is idempotent, the state of the system is the same after one or several calls, and therefore it is always retried.
| Parameters | |
|---|---|
| Name | Description |
subscription |
Subscription const &
the name for the subscription |
builder |
SubscriptionBuilder
any additional configuration for the subscription |
opts |
Options
Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::pubsub::v1::Subscription > |
|
ListSubscriptions(std::string const &, Options)
Lists all the subscriptions for a given project id.
Idempotency
This is a read-only operation and therefore always idempotent and retried.
| Parameters | |
|---|---|
| Name | Description |
project_id |
std::string const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
ListSubscriptionsRange |
|
DeleteSubscription(Subscription, Options)
Deletes an existing subscription in Cloud Pub/Sub.
Idempotency
This operation is idempotent, the state of the system is the same after one or several calls, and therefore it is always retried. It might return a status code of kNotFound as a consequence of retrying a successful (but reported as failed) request.
| Parameters | |
|---|---|
| Name | Description |
subscription |
Subscription
the name of the subscription to be deleted. |
opts |
Options
Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
Status |
|
ModifyPushSubscription(Subscription const &, PushConfigBuilder, Options)
Modifies an existing subscription's push configuration.
This can change a push subscription into a pull subscription (by setting an empty push config), change the push endpoint, or change a pull subscription into a push config.
Idempotency
This operation is idempotent, the state of the system is the same after one or several calls, and therefore it is always retried.
| Parameters | |
|---|---|
| Name | Description |
subscription |
Subscription const &
the name of the subscription to be modified. |
builder |
PushConfigBuilder
a description of the changes to be made. |
opts |
Options
Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
Status |
|
CreateSnapshot(Subscription const &, SnapshotBuilder, Options)
Creates a new snapshot for a subscription with a server-assigned name.
Idempotency
This is not an idempotent operation, repeated calls would create multiple snapshots with different names assigned by the service, and therefore it is never retried.
| Parameters | |
|---|---|
| Name | Description |
subscription |
Subscription const &
the name of the subscription |
builder |
SnapshotBuilder
additional configuration for the snapshot, e.g., labels |
opts |
Options
Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::pubsub::v1::Snapshot > |
|
CreateSnapshot(Subscription const &, Snapshot const &, SnapshotBuilder, Options)
Creates a new snapshot for a subscription with a given name.
Idempotency
This operation is idempotent, the state of the system is the same after one or several calls, and therefore it is always retried.
See Also
https://cloud.google.com/pubsub/docs/replay-overview for a detailed description of Cloud Pub/Sub's snapshots.
| Parameters | |
|---|---|
| Name | Description |
subscription |
Subscription const &
the name of the subscription |
snapshot |
Snapshot const &
the name of the snapshot |
builder |
SnapshotBuilder
additional configuration for the snapshot, e.g., labels |
opts |
Options
Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::pubsub::v1::Snapshot > |
|
GetSnapshot(Snapshot const &, Options)
Gets information about an existing snapshot.
Idempotency
This is a read-only operation and therefore always idempotent and retried.
See Also
https://cloud.google.com/pubsub/docs/replay-overview for a detailed description of Cloud Pub/Sub's snapshots.
| Parameters | |
|---|---|
| Name | Description |
snapshot |
Snapshot const &
the name of the snapshot |
opts |
Options
Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::pubsub::v1::Snapshot > |
|
UpdateSnapshot(Snapshot const &, SnapshotBuilder, Options)
Updates an existing snapshot.
Idempotency
This operation is idempotent, the state of the system is the same after one or several calls, and therefore it is always retried.
See Also
https://cloud.google.com/pubsub/docs/replay-overview for a detailed description of Cloud Pub/Sub's snapshots.
| Parameters | |
|---|---|
| Name | Description |
snapshot |
Snapshot const &
the name of the snapshot |
builder |
SnapshotBuilder
the changes applied to the snapshot |
opts |
Options
Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::pubsub::v1::Snapshot > |
|
ListSnapshots(std::string const &, Options)
Lists all the snapshots for a given project id.
Idempotency
This is a read-only operation and therefore always idempotent and retried.
See Also
https://cloud.google.com/pubsub/docs/replay-overview for a detailed description of Cloud Pub/Sub's snapshots.
| Parameters | |
|---|---|
| Name | Description |
project_id |
std::string const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
ListSnapshotsRange |
|
DeleteSnapshot(Snapshot const &, Options)
Deletes a snapshot.
Idempotency
This operation is idempotent, the state of the system is the same after one or several calls, and therefore it is always retried.
See Also
https://cloud.google.com/pubsub/docs/replay-overview for a detailed description of Cloud Pub/Sub's snapshots.
| Parameters | |
|---|---|
| Name | Description |
snapshot |
Snapshot const &
the name of the snapshot |
opts |
Options
Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
Status |
|
Seek(Subscription const &, std::chrono::system_clock::time_point, Options)
Seeks a subscription to its state at timestamp.
Messages retained in the subscription that were published before timestamp are marked as acknowledged, while messages published after timestamp are marked as unacknowledged.
Idempotency
This operation is idempotent, the state of the system is the same after one or several calls, and therefore it is always retried.
See Also
https://cloud.google.com/pubsub/docs/replay-overview for a detailed description of Cloud Pub/Sub's Seek() functionality.
| Parameters | |
|---|---|
| Name | Description |
subscription |
Subscription const &
|
timestamp |
std::chrono::system_clock::time_point
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::pubsub::v1::SeekResponse > |
|
Seek(Subscription const &, Snapshot const &, Options)
Seeks a subscription to its state at snapshot.
Idempotency
This operation is idempotent, the state of the system is the same after one or several calls, and therefore it is always retried.
See Also
https://cloud.google.com/pubsub/docs/replay-overview for a detailed description of Cloud Pub/Sub's Seek() functionality.
| Parameters | |
|---|---|
| Name | Description |
subscription |
Subscription const &
|
snapshot |
Snapshot const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::pubsub::v1::SeekResponse > |
|