New in version 2.3.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments |
---|---|---|
state
-
|
list is the only valid option.
|
|
topic
-
|
GCP pubsub topic name. Only the name, not the full path, is required.
|
|
view
-
/ required
|
Choices are 'topics' or 'subscriptions'
|
Note
## 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
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
subscriptions
list
|
When view is set to subscriptions. |
List of subscriptions.
Sample:
['mysubscription', 'mysubscription2']
|
topic
string
|
Always |
Name of topic. Used to filter subscriptions.
Sample:
mytopic
|
topics
list
|
When view is set to topics. |
List of topics.
Sample:
['mytopic', 'mytopic2']
|
Hint
If you notice any issues in this documentation you can edit this document to improve it.