New in version 2.6.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
ack_deadline_seconds |
This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (on a best-effort basis).
For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call subscriptions.modifyAckDeadline with the corresponding ackId if using pull. The minimum custom deadline you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds (10 minutes).
If this parameter is 0, a default value of 10 seconds is used.
For push delivery, this value is also used to set the request timeout for the call to the push endpoint.
If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message.
|
||
auth_kind
required |
|
The type of credential used.
|
|
name |
Name of the subscription.
|
||
project |
The Google Cloud Platform project to use.
|
||
push_config |
If push delivery is used with this subscription, this field is used to configure it. An empty pushConfig signifies that the subscriber will pull and ack messages using API methods.
|
||
push_endpoint |
A URL locating the endpoint to which messages should be pushed.
For example, a Webhook endpoint might use "https://example.com/push".
|
||
scopes
required |
Array of scopes to be used.
|
||
service_account_email |
An optional service account email address if machineaccount is selected and the user does not wish to use the default email.
|
||
service_account_file |
The path of a Service Account JSON file if serviceaccount is selected as type.
|
||
state
required |
|
Whether the given object should exist in GCP
|
|
topic |
A reference to Topic resource.
|
Note
GCP_SERVICE_ACCOUNT_FILE
env variable.GCP_SERVICE_ACCOUNT_EMAIL
env variable.GCP_AUTH_KIND
env variable.GCP_SCOPES
env variable.- name: create a topic
gcp_pubsub_topic:
name: 'topic-subscription'
project: "{{ gcp_project }}"
auth_kind: "{{ gcp_cred_kind }}"
service_account_file: "{{ gcp_cred_file }}"
scopes:
- https://www.googleapis.com/auth/pubsub
state: present
register: topic
- name: create a subscription
gcp_pubsub_subscription:
name: testObject
topic: "{{ topic }}"
push_config:
push_endpoint: 'https://myapp.graphite.cloudnativeapp.com/webhook/sub1'
ack_deadline_seconds: 300
project: testProject
auth_kind: service_account
service_account_file: /tmp/auth.pem
scopes:
- https://www.googleapis.com/auth/pubsub
state: present
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
ack_deadline_seconds
int
|
success |
This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (on a best-effort basis).
For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call subscriptions.modifyAckDeadline with the corresponding ackId if using pull. The minimum custom deadline you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds (10 minutes).
If this parameter is 0, a default value of 10 seconds is used.
For push delivery, this value is also used to set the request timeout for the call to the push endpoint.
If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message.
|
|
name
str
|
success |
Name of the subscription.
|
|
push_config
complex
|
success |
If push delivery is used with this subscription, this field is used to configure it. An empty pushConfig signifies that the subscriber will pull and ack messages using API methods.
|
|
push_endpoint
str
|
success |
A URL locating the endpoint to which messages should be pushed.
For example, a Webhook endpoint might use "https://example.com/push".
|
|
topic
dict
|
success |
A reference to Topic resource.
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Hint
If you notice any issues in this documentation you can edit this document to improve it.