Pub/Sub Client#

gcloud pubsub client for interacting with API.

class gcloud.pubsub.client.Client(project=None, credentials=None, http=None)[source]#

Client to bundle configuration needed for API requests.

Parameters:

Parameters:	project (string) – the project which the client acts on behalf of. Will be passed when creating a topic. If not passed, falls back to the default inferred from the environment. credentials (`oauth2client.client.OAuth2Credentials` or `NoneType`) – The OAuth2 Credentials to use for the connection owned by this client. If not passed (and if no `http` object is passed), falls back to the default inferred from the environment. http (`httplib2.Http` or class that defines `request()`.) – An optional HTTP object to make requests. If not passed, an `http` object is created that is bound to the `credentials` for the current object.

project (string) – the project which the client acts on behalf of. Will be passed when creating a topic. If not passed, falls back to the default inferred from the environment.
credentials (oauth2client.client.OAuth2Credentials or NoneType) – The OAuth2 Credentials to use for the connection owned by this client. If not passed (and if no http object is passed), falls back to the default inferred from the environment.
http (httplib2.Http or class that defines request().) – An optional HTTP object to make requests. If not passed, an http object is created that is bound to the credentials for the current object.

list_subscriptions(page_size=None, page_token=None, topic_name=None)[source]#

List subscriptions for the project associated with this client.

Parameters:	page_size (int) – maximum number of topics to return, If not passed, defaults to a value set by the API. page_token (string) – opaque marker for the next “page” of topics. If not passed, the API will return the first page of topics. topic_name (string) – limit results to subscriptions bound to the given topic.
Return type:	tuple, (list, str)
Returns:	list of `gcloud.pubsub.subscription.Subscription`, plus a “next page token” string: if not None, indicates that more topics can be retrieved with another call (pass that value as `page_token`).

list_topics(page_size=None, page_token=None)[source]#

List topics for the project associated with this client.

Parameters:	page_size (int) – maximum number of topics to return, If not passed, defaults to a value set by the API. page_token (string) – opaque marker for the next “page” of topics. If not passed, the API will return the first page of topics.
Return type:	tuple, (list, str)
Returns:	list of `gcloud.pubsub.topic.Topic`, plus a “next page token” string: if not None, indicates that more topics can be retrieved with another call (pass that value as `page_token`).

topic(name, timestamp_messages=False)[source]#

Creates a topic bound to the current client.

Parameters:	name (string) – the name of the topic to be constructed. timestamp_messages (boolean) – To be passed to `Topic` constructor.
Return type:	`gcloud.pubsub.topic.Topic`
Returns:	Topic created with the current client.

Connection#

Create / interact with gcloud pubsub connections.

class gcloud.pubsub.connection.Connection(credentials=None, http=None)[source]#

A connection to Google Cloud Pubsub via the JSON REST API.

API_BASE_URL = 'https://pubsub.googleapis.com'#: The base of the API call URL.

API_URL_TEMPLATE = '{api_base_url}/{api_version}{path}'#: A template for the URL of a particular API call.

API_VERSION = 'v1'#: The version of the API, used in building the API call’s URL.

gcloud.pubsub.connection.SCOPE = ('https://www.googleapis.com/auth/pubsub', 'https://www.googleapis.com/auth/cloud-platform')#: The scopes required for authenticating as a Cloud Pub/Sub consumer.