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)
Defines the interface for SubscriptionAdminClient::CreateSubscription()
| Parameter | |
|---|---|
| Name | Description |
|
CreateSubscriptionParams
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::pubsub::v1::Subscription > |
|
virtual GetSubscription(GetSubscriptionParams)
Defines the interface for SubscriptionAdminClient::GetSubscription()
| Parameter | |
|---|---|
| Name | Description |
|
GetSubscriptionParams
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::pubsub::v1::Subscription > |
|
virtual UpdateSubscription(UpdateSubscriptionParams)
Defines the interface for SubscriptionAdminClient::UpdateSubscription()
| Parameter | |
|---|---|
| Name | Description |
|
UpdateSubscriptionParams
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::pubsub::v1::Subscription > |
|
virtual ListSubscriptions(ListSubscriptionsParams)
Defines the interface for SubscriptionAdminClient::ListSubscriptions()
| Parameter | |
|---|---|
| Name | Description |
|
ListSubscriptionsParams
|
| Returns | |
|---|---|
| Type | Description |
ListSubscriptionsRange |
|
virtual DeleteSubscription(DeleteSubscriptionParams)
Defines the interface for SubscriptionAdminClient::DeleteSubscription()
| Parameter | |
|---|---|
| Name | Description |
|
DeleteSubscriptionParams
|
| Returns | |
|---|---|
| Type | Description |
Status |
|
virtual ModifyPushConfig(ModifyPushConfigParams)
Defines the interface for SubscriptionAdminClient::ModifyPushConfig()
| Parameter | |
|---|---|
| Name | Description |
|
ModifyPushConfigParams
|
| Returns | |
|---|---|
| Type | Description |
Status |
|
virtual CreateSnapshot(CreateSnapshotParams)
Defines the interface for SnapshotAdminClient::CreateSnapshot()
| Parameter | |
|---|---|
| Name | Description |
|
CreateSnapshotParams
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::pubsub::v1::Snapshot > |
|
virtual GetSnapshot(GetSnapshotParams)
Defines the interface for SnapshotAdminClient::GetSnapshot()
| Parameter | |
|---|---|
| Name | Description |
|
GetSnapshotParams
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::pubsub::v1::Snapshot > |
|
virtual UpdateSnapshot(UpdateSnapshotParams)
Defines the interface for SnapshotAdminClient::UpdateSnapshot()
| Parameter | |
|---|---|
| Name | Description |
|
UpdateSnapshotParams
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::pubsub::v1::Snapshot > |
|
virtual ListSnapshots(ListSnapshotsParams)
Defines the interface for SubscriptionAdminClient::ListSnapshots()
| Parameter | |
|---|---|
| Name | Description |
|
ListSnapshotsParams
|
| Returns | |
|---|---|
| Type | Description |
ListSnapshotsRange |
|
virtual DeleteSnapshot(DeleteSnapshotParams)
Defines the interface for SnapshotAdminClient::DeleteSnapshot()
| Parameter | |
|---|---|
| Name | Description |
|
DeleteSnapshotParams
|
| Returns | |
|---|---|
| Type | Description |
Status |
|
virtual Seek(SeekParams)
Defines the interface for SubscriptionAdminClient::Seek()
| Parameter | |
|---|---|
| Name | Description |
|
SeekParams
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::pubsub::v1::SeekResponse > |
|
virtual options() const
Return the options used to create the connection.
| Returns | |
|---|---|
| Type | Description |
Options |
|