Google Cloud Pub/Sub C++ Client  2.4.0
A C++ Client Library for Google Cloud Pub/Sub
Classes | Public Member Functions | List of all members
google::cloud::pubsub::SubscriptionAdminConnection Class Referenceabstract

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

#include <google/cloud/pubsub/subscription_admin_connection.h>

Classes

struct  CreateSnapshotParams
 Wrap the arguments for CreateSnapshot() More...
 
struct  CreateSubscriptionParams
 Wrap the arguments for CreateSubscription() More...
 
struct  DeleteSnapshotParams
 Wrap the arguments for DeleteSnapshot() More...
 
struct  DeleteSubscriptionParams
 Wrap the arguments for DeleteSubscription() More...
 
struct  GetSnapshotParams
 Wrap the arguments for GetSnapshot() More...
 
struct  GetSubscriptionParams
 Wrap the arguments for GetSubscription() More...
 
struct  ListSnapshotsParams
 Wrap the arguments for ListSnapshots() More...
 
struct  ListSubscriptionsParams
 Wrap the arguments for ListSubscriptions() More...
 
struct  ModifyPushConfigParams
 Wrap the arguments for ModifyPushConfig() More...
 
struct  SeekParams
 Wrap the arguments for Seek() More...
 
struct  UpdateSnapshotParams
 Wrap the arguments for UpdateSnapshot() More...
 
struct  UpdateSubscriptionParams
 Wrap the arguments for UpdateSubscription() More...
 

Public Member Functions

virtual ~SubscriptionAdminConnection ()=0
 
virtual StatusOr< google::pubsub::v1::Subscription > CreateSubscription (CreateSubscriptionParams)
 Defines the interface for SubscriptionAdminClient::CreateSubscription() More...
 
virtual StatusOr< google::pubsub::v1::Subscription > GetSubscription (GetSubscriptionParams)
 Defines the interface for SubscriptionAdminClient::GetSubscription() More...
 
virtual StatusOr< google::pubsub::v1::Subscription > UpdateSubscription (UpdateSubscriptionParams)
 Defines the interface for SubscriptionAdminClient::UpdateSubscription() More...
 
virtual ListSubscriptionsRange ListSubscriptions (ListSubscriptionsParams)
 Defines the interface for SubscriptionAdminClient::ListSubscriptions() More...
 
virtual Status DeleteSubscription (DeleteSubscriptionParams)
 Defines the interface for SubscriptionAdminClient::DeleteSubscription() More...
 
virtual Status ModifyPushConfig (ModifyPushConfigParams)
 Defines the interface for SubscriptionAdminClient::ModifyPushConfig() More...
 
virtual StatusOr< google::pubsub::v1::Snapshot > CreateSnapshot (CreateSnapshotParams)
 Defines the interface for SnapshotAdminClient::CreateSnapshot() More...
 
virtual StatusOr< google::pubsub::v1::Snapshot > GetSnapshot (GetSnapshotParams)
 Defines the interface for SnapshotAdminClient::GetSnapshot() More...
 
virtual StatusOr< google::pubsub::v1::Snapshot > UpdateSnapshot (UpdateSnapshotParams)
 Defines the interface for SnapshotAdminClient::UpdateSnapshot() More...
 
virtual ListSnapshotsRange ListSnapshots (ListSnapshotsParams)
 Defines the interface for SubscriptionAdminClient::ListSnapshots() More...
 
virtual Status DeleteSnapshot (DeleteSnapshotParams)
 Defines the interface for SnapshotAdminClient::DeleteSnapshot() More...
 
virtual StatusOr< google::pubsub::v1::SeekResponse > Seek (SeekParams)
 Defines the interface for SubscriptionAdminClient::Seek() More...
 
virtual Options options () const
 Return the options used to create the connection. More...
 

Detailed Description

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.

Definition at line 82 of file subscription_admin_connection.h.

Constructor & Destructor Documentation

◆ ~SubscriptionAdminConnection()

virtual google::cloud::pubsub::SubscriptionAdminConnection::~SubscriptionAdminConnection ( )
pure virtual

Member Function Documentation

◆ CreateSnapshot()

virtual StatusOr<google::pubsub::v1::Snapshot> google::cloud::pubsub::SubscriptionAdminConnection::CreateSnapshot ( CreateSnapshotParams  )
virtual

Defines the interface for SnapshotAdminClient::CreateSnapshot()

◆ CreateSubscription()

virtual StatusOr<google::pubsub::v1::Subscription> google::cloud::pubsub::SubscriptionAdminConnection::CreateSubscription ( CreateSubscriptionParams  )
virtual

◆ DeleteSnapshot()

virtual Status google::cloud::pubsub::SubscriptionAdminConnection::DeleteSnapshot ( DeleteSnapshotParams  )
virtual

Defines the interface for SnapshotAdminClient::DeleteSnapshot()

◆ DeleteSubscription()

virtual Status google::cloud::pubsub::SubscriptionAdminConnection::DeleteSubscription ( DeleteSubscriptionParams  )
virtual

◆ GetSnapshot()

virtual StatusOr<google::pubsub::v1::Snapshot> google::cloud::pubsub::SubscriptionAdminConnection::GetSnapshot ( GetSnapshotParams  )
virtual

Defines the interface for SnapshotAdminClient::GetSnapshot()

◆ GetSubscription()

virtual StatusOr<google::pubsub::v1::Subscription> google::cloud::pubsub::SubscriptionAdminConnection::GetSubscription ( GetSubscriptionParams  )
virtual

Defines the interface for SubscriptionAdminClient::GetSubscription()

◆ ListSnapshots()

virtual ListSnapshotsRange google::cloud::pubsub::SubscriptionAdminConnection::ListSnapshots ( ListSnapshotsParams  )
virtual

Defines the interface for SubscriptionAdminClient::ListSnapshots()

◆ ListSubscriptions()

virtual ListSubscriptionsRange google::cloud::pubsub::SubscriptionAdminConnection::ListSubscriptions ( ListSubscriptionsParams  )
virtual

◆ ModifyPushConfig()

virtual Status google::cloud::pubsub::SubscriptionAdminConnection::ModifyPushConfig ( ModifyPushConfigParams  )
virtual

Defines the interface for SubscriptionAdminClient::ModifyPushConfig()

◆ options()

virtual Options google::cloud::pubsub::SubscriptionAdminConnection::options ( ) const
inlinevirtual

Return the options used to create the connection.

Definition at line 188 of file subscription_admin_connection.h.

◆ Seek()

virtual StatusOr<google::pubsub::v1::SeekResponse> google::cloud::pubsub::SubscriptionAdminConnection::Seek ( SeekParams  )
virtual

Defines the interface for SubscriptionAdminClient::Seek()

◆ UpdateSnapshot()

virtual StatusOr<google::pubsub::v1::Snapshot> google::cloud::pubsub::SubscriptionAdminConnection::UpdateSnapshot ( UpdateSnapshotParams  )
virtual

Defines the interface for SnapshotAdminClient::UpdateSnapshot()

◆ UpdateSubscription()

virtual StatusOr<google::pubsub::v1::Subscription> google::cloud::pubsub::SubscriptionAdminConnection::UpdateSubscription ( UpdateSubscriptionParams  )
virtual