Class SubscriptionAdminConnection (2.11.0)

A connection to Cloud Pub/Sub for subscription-related administrative operations.

This interface defines pure-virtual functions for each of the user-facing overload sets in SubscriptionAdminClient. That is, all of SubscriptionAdminClient overloads will forward to the one pure-virtual function declared in this interface. This allows users to inject custom behavior (e.g., with a Google Mock object) in a SubscriptionAdminClient object for use in their own tests.

To create a concrete instance that connects you to the real Cloud Pub/Sub service, see MakeSubscriptionAdminConnection().

The *Params nested classes

Applications may define classes derived from SubscriptionAdminConnection, for example, because they want to mock the class. To avoid breaking all such derived classes when we change the number or type of the arguments to the member functions we define lightweight structures to pass the arguments.

Functions

virtual CreateSubscription(CreateSubscriptionParams)

Parameter
NameDescription
CreateSubscriptionParams
Returns
TypeDescription
StatusOr< google::pubsub::v1::Subscription >

virtual GetSubscription(GetSubscriptionParams)

Parameter
NameDescription
GetSubscriptionParams
Returns
TypeDescription
StatusOr< google::pubsub::v1::Subscription >

virtual UpdateSubscription(UpdateSubscriptionParams)

Parameter
NameDescription
UpdateSubscriptionParams
Returns
TypeDescription
StatusOr< google::pubsub::v1::Subscription >

virtual ListSubscriptions(ListSubscriptionsParams)

Parameter
NameDescription
ListSubscriptionsParams
Returns
TypeDescription
ListSubscriptionsRange

virtual DeleteSubscription(DeleteSubscriptionParams)

Parameter
NameDescription
DeleteSubscriptionParams
Returns
TypeDescription
Status

virtual ModifyPushConfig(ModifyPushConfigParams)

Defines the interface for SubscriptionAdminClient::ModifyPushConfig()

Parameter
NameDescription
ModifyPushConfigParams
Returns
TypeDescription
Status

virtual CreateSnapshot(CreateSnapshotParams)

Defines the interface for SnapshotAdminClient::CreateSnapshot()

Parameter
NameDescription
CreateSnapshotParams
Returns
TypeDescription
StatusOr< google::pubsub::v1::Snapshot >

virtual GetSnapshot(GetSnapshotParams)

Defines the interface for SnapshotAdminClient::GetSnapshot()

Parameter
NameDescription
GetSnapshotParams
Returns
TypeDescription
StatusOr< google::pubsub::v1::Snapshot >

virtual UpdateSnapshot(UpdateSnapshotParams)

Defines the interface for SnapshotAdminClient::UpdateSnapshot()

Parameter
NameDescription
UpdateSnapshotParams
Returns
TypeDescription
StatusOr< google::pubsub::v1::Snapshot >

virtual ListSnapshots(ListSnapshotsParams)

Defines the interface for SubscriptionAdminClient::ListSnapshots()

Parameter
NameDescription
ListSnapshotsParams
Returns
TypeDescription
ListSnapshotsRange

virtual DeleteSnapshot(DeleteSnapshotParams)

Defines the interface for SnapshotAdminClient::DeleteSnapshot()

Parameter
NameDescription
DeleteSnapshotParams
Returns
TypeDescription
Status

virtual Seek(SeekParams)

Defines the interface for SubscriptionAdminClient::Seek()

Parameter
NameDescription
SeekParams
Returns
TypeDescription
StatusOr< google::pubsub::v1::SeekResponse >

virtual options() const

Return the options used to create the connection.

Returns
TypeDescription
Options