google::cloud::pubsub::TopicAdminConnection Class Reference

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

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

Classes
struct	CreateTopicParams
	Wrap the arguments for CreateTopic() More...
struct	DeleteTopicParams
	Wrap the arguments for DeleteTopic() More...
struct	DetachSubscriptionParams
	Wrap the arguments for DetachSubscription() More...
struct	GetTopicParams
	Wrap the arguments for GetTopic() More...
struct	ListTopicSnapshotsParams
	Wrap the arguments for ListTopicSnapshots() More...
struct	ListTopicsParams
	Wrap the arguments for ListTopics() More...
struct	ListTopicSubscriptionsParams
	Wrap the arguments for ListTopicSubscriptions() More...
struct	UpdateTopicParams
	Wrap the arguments for UpdateTopic() More...

Public Member Functions
virtual	~TopicAdminConnection ()=0
virtual StatusOr< google::pubsub::v1::Topic >	CreateTopic (CreateTopicParams)
	Defines the interface for TopicAdminClient::CreateTopic() More...
virtual StatusOr< google::pubsub::v1::Topic >	GetTopic (GetTopicParams)
	Defines the interface for TopicAdminClient::GetTopic() More...
virtual StatusOr< google::pubsub::v1::Topic >	UpdateTopic (UpdateTopicParams)
	Defines the interface for TopicAdminClient::UpdateTopic() More...
virtual ListTopicsRange	ListTopics (ListTopicsParams)
	Defines the interface for TopicAdminClient::ListTopics() More...
virtual Status	DeleteTopic (DeleteTopicParams)
	Defines the interface for TopicAdminClient::DeleteTopic() More...
virtual StatusOr< google::pubsub::v1::DetachSubscriptionResponse >	DetachSubscription (DetachSubscriptionParams)
	Defines the interface for TopicAdminClient::DetachSubscriptions() More...
virtual ListTopicSubscriptionsRange	ListTopicSubscriptions (ListTopicSubscriptionsParams)
	Defines the interface for TopicAdminClient::ListTopicSubscriptions() More...
virtual ListTopicSnapshotsRange	ListTopicSnapshots (ListTopicSnapshotsParams)
	Defines the interface for TopicAdminClient::ListTopicSnapshots() More...
virtual Options	options () const
	Returns the options used to create the connection. More...

Detailed Description

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

This interface defines pure-virtual functions for each of the user-facing overload sets in TopicAdminClient. That is, all of TopicAdminClient's 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 TopicAdminClient object for use in their own tests.

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

The *Params nested classes

Applications may define classes derived from TopicAdminConnection, 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.

Constructor & Destructor Documentation

~TopicAdminConnection()

virtual google::cloud::pubsub::TopicAdminConnection::~TopicAdminConnection ( )

pure virtual

Member Function Documentation

CreateTopic()

virtual StatusOr< google::pubsub::v1::Topic > google::cloud::pubsub::TopicAdminConnection::CreateTopic ( CreateTopicParams  )

virtual

Defines the interface for TopicAdminClient::CreateTopic()

DeleteTopic()

virtual Status google::cloud::pubsub::TopicAdminConnection::DeleteTopic ( DeleteTopicParams  )

virtual

Defines the interface for TopicAdminClient::DeleteTopic()

DetachSubscription()

virtual StatusOr< google::pubsub::v1::DetachSubscriptionResponse > google::cloud::pubsub::TopicAdminConnection::DetachSubscription ( DetachSubscriptionParams  )

virtual

Defines the interface for TopicAdminClient::DetachSubscriptions()

GetTopic()

virtual StatusOr< google::pubsub::v1::Topic > google::cloud::pubsub::TopicAdminConnection::GetTopic ( GetTopicParams  )

virtual

Defines the interface for TopicAdminClient::GetTopic()

ListTopics()

virtual ListTopicsRange google::cloud::pubsub::TopicAdminConnection::ListTopics ( ListTopicsParams  )

virtual

Defines the interface for TopicAdminClient::ListTopics()

ListTopicSnapshots()

virtual ListTopicSnapshotsRange google::cloud::pubsub::TopicAdminConnection::ListTopicSnapshots ( ListTopicSnapshotsParams  )

virtual

Defines the interface for TopicAdminClient::ListTopicSnapshots()

ListTopicSubscriptions()

virtual ListTopicSubscriptionsRange google::cloud::pubsub::TopicAdminConnection::ListTopicSubscriptions ( ListTopicSubscriptionsParams  )

virtual

Defines the interface for TopicAdminClient::ListTopicSubscriptions()

options()

virtual Options google::cloud::pubsub::TopicAdminConnection::options ( ) const

inlinevirtual

Returns the options used to create the connection.

UpdateTopic()

virtual StatusOr< google::pubsub::v1::Topic > google::cloud::pubsub::TopicAdminConnection::UpdateTopic ( UpdateTopicParams  )

virtual

Defines the interface for TopicAdminClient::UpdateTopic()