gcpubsub_facts - List Topics/Subscriptions and Messages from Google PubSub.¶

New in version 2.3.

Synopsis
Requirements (on host that executes module)
Options
Examples
Return Values
Notes
- Status
- Support

Synopsis ¶

List Topics/Subscriptions from Google PubSub. Use the gcpubsub module for topic/subscription management. See https://cloud.google.com/pubsub/docs for an overview.

Requirements (on host that executes module)¶

python >= 2.6

google-auth >= 0.5.0

google-cloud-pubsub >= 0.22.0

Options ¶

parameter	required	comments
state	no	list is the only valid option.
topic	no	GCP pubsub topic name. Only the name, not the full path, is required.
view	yes	Choices are 'topics' or 'subscriptions'

Examples ¶

## List all Topics in a project
gcpubsub_facts:
  view: topics
  state: list

## List all Subscriptions in a project
gcpubsub_facts:
  view: subscriptions
  state: list

## List all Subscriptions for a Topic in a project
gcpubsub_facts:
  view: subscriptions
  topic: my-topic
  state: list

Return Values ¶

Common return values are documented here Return Values, the following are the fields unique to this module:

name	description	returned	type	sample
topic	Name of topic. Used to filter subscriptions.	Always	str	mytopic
topics	List of topics.	When view is set to topics.	list	['mytopic', 'mytopic2']
subscriptions	List of subscriptions.	When view is set to subscriptions.	list	['mysubscription', 'mysubscription2']

Notes ¶

Note

list state enables user to list topics or subscriptions in the project. See examples for details.

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support ¶

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.