mirror of
https://github.com/ansible-collections/google.cloud.git
synced 2025-07-27 15:11:33 -07:00
Add retention duraction, retain acked message to pubsub (#202)
<!-- This change is generated by MagicModules. --> /cc @rileykarson
This commit is contained in:
parent
dcc0d36ba8
commit
e95d3b226e
2 changed files with 66 additions and 0 deletions
|
@ -113,6 +113,26 @@ options:
|
||||||
- If the subscriber never acknowledges the message, the Pub/Sub system will eventually
|
- If the subscriber never acknowledges the message, the Pub/Sub system will eventually
|
||||||
redeliver the message.
|
redeliver the message.
|
||||||
required: false
|
required: false
|
||||||
|
message_retention_duration:
|
||||||
|
description:
|
||||||
|
- How long to retain unacknowledged messages in the subscription's backlog, from
|
||||||
|
the moment a message is published. If retainAckedMessages is true, then this
|
||||||
|
also configures the retention of acknowledged messages, and thus configures
|
||||||
|
how far back in time a subscriptions.seek can be done. Defaults to 7 days. Cannot
|
||||||
|
be more than 7 days (`"604800s"`) or less than 10 minutes (`"600s"`).
|
||||||
|
- 'A duration in seconds with up to nine fractional digits, terminated by ''s''.
|
||||||
|
Example: `"600.5s"`.'
|
||||||
|
required: false
|
||||||
|
default: 604800s
|
||||||
|
version_added: 2.8
|
||||||
|
retain_acked_messages:
|
||||||
|
description:
|
||||||
|
- Indicates whether to retain acknowledged messages. If `true`, then messages
|
||||||
|
are not expunged from the subscription's backlog, even if they are acknowledged,
|
||||||
|
until they fall out of the messageRetentionDuration window.
|
||||||
|
required: false
|
||||||
|
type: bool
|
||||||
|
version_added: 2.8
|
||||||
extends_documentation_fragment: gcp
|
extends_documentation_fragment: gcp
|
||||||
notes:
|
notes:
|
||||||
- 'API Reference: U(https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.subscriptions)'
|
- 'API Reference: U(https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.subscriptions)'
|
||||||
|
@ -207,6 +227,24 @@ ackDeadlineSeconds:
|
||||||
redeliver the message.
|
redeliver the message.
|
||||||
returned: success
|
returned: success
|
||||||
type: int
|
type: int
|
||||||
|
messageRetentionDuration:
|
||||||
|
description:
|
||||||
|
- How long to retain unacknowledged messages in the subscription's backlog, from
|
||||||
|
the moment a message is published. If retainAckedMessages is true, then this also
|
||||||
|
configures the retention of acknowledged messages, and thus configures how far
|
||||||
|
back in time a subscriptions.seek can be done. Defaults to 7 days. Cannot be more
|
||||||
|
than 7 days (`"604800s"`) or less than 10 minutes (`"600s"`).
|
||||||
|
- 'A duration in seconds with up to nine fractional digits, terminated by ''s''.
|
||||||
|
Example: `"600.5s"`.'
|
||||||
|
returned: success
|
||||||
|
type: str
|
||||||
|
retainAckedMessages:
|
||||||
|
description:
|
||||||
|
- Indicates whether to retain acknowledged messages. If `true`, then messages are
|
||||||
|
not expunged from the subscription's backlog, even if they are acknowledged, until
|
||||||
|
they fall out of the messageRetentionDuration window.
|
||||||
|
returned: success
|
||||||
|
type: bool
|
||||||
'''
|
'''
|
||||||
|
|
||||||
################################################################################
|
################################################################################
|
||||||
|
@ -232,6 +270,8 @@ def main():
|
||||||
labels=dict(type='dict'),
|
labels=dict(type='dict'),
|
||||||
push_config=dict(type='dict', options=dict(push_endpoint=dict(required=True, type='str'), attributes=dict(type='dict'))),
|
push_config=dict(type='dict', options=dict(push_endpoint=dict(required=True, type='str'), attributes=dict(type='dict'))),
|
||||||
ack_deadline_seconds=dict(type='int'),
|
ack_deadline_seconds=dict(type='int'),
|
||||||
|
message_retention_duration=dict(default='604800s', type='str'),
|
||||||
|
retain_acked_messages=dict(type='bool'),
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
|
|
||||||
|
@ -286,6 +326,10 @@ def updateMask(request, response):
|
||||||
update_mask.append('pushConfig')
|
update_mask.append('pushConfig')
|
||||||
if request.get('ackDeadlineSeconds') != response.get('ackDeadlineSeconds'):
|
if request.get('ackDeadlineSeconds') != response.get('ackDeadlineSeconds'):
|
||||||
update_mask.append('ackDeadlineSeconds')
|
update_mask.append('ackDeadlineSeconds')
|
||||||
|
if request.get('messageRetentionDuration') != response.get('messageRetentionDuration'):
|
||||||
|
update_mask.append('messageRetentionDuration')
|
||||||
|
if request.get('retainAckedMessages') != response.get('retainAckedMessages'):
|
||||||
|
update_mask.append('retainAckedMessages')
|
||||||
return ','.join(update_mask)
|
return ','.join(update_mask)
|
||||||
|
|
||||||
|
|
||||||
|
@ -301,6 +345,8 @@ def resource_to_request(module):
|
||||||
u'labels': module.params.get('labels'),
|
u'labels': module.params.get('labels'),
|
||||||
u'pushConfig': SubscriptionPushconfig(module.params.get('push_config', {}), module).to_request(),
|
u'pushConfig': SubscriptionPushconfig(module.params.get('push_config', {}), module).to_request(),
|
||||||
u'ackDeadlineSeconds': module.params.get('ack_deadline_seconds'),
|
u'ackDeadlineSeconds': module.params.get('ack_deadline_seconds'),
|
||||||
|
u'messageRetentionDuration': module.params.get('message_retention_duration'),
|
||||||
|
u'retainAckedMessages': module.params.get('retain_acked_messages'),
|
||||||
}
|
}
|
||||||
request = encode_request(request, module)
|
request = encode_request(request, module)
|
||||||
return_vals = {}
|
return_vals = {}
|
||||||
|
@ -375,6 +421,8 @@ def response_to_hash(module, response):
|
||||||
u'labels': response.get(u'labels'),
|
u'labels': response.get(u'labels'),
|
||||||
u'pushConfig': SubscriptionPushconfig(response.get(u'pushConfig', {}), module).from_response(),
|
u'pushConfig': SubscriptionPushconfig(response.get(u'pushConfig', {}), module).from_response(),
|
||||||
u'ackDeadlineSeconds': response.get(u'ackDeadlineSeconds'),
|
u'ackDeadlineSeconds': response.get(u'ackDeadlineSeconds'),
|
||||||
|
u'messageRetentionDuration': response.get(u'messageRetentionDuration'),
|
||||||
|
u'retainAckedMessages': response.get(u'retainAckedMessages'),
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -126,6 +126,24 @@ items:
|
||||||
eventually redeliver the message.
|
eventually redeliver the message.
|
||||||
returned: success
|
returned: success
|
||||||
type: int
|
type: int
|
||||||
|
messageRetentionDuration:
|
||||||
|
description:
|
||||||
|
- How long to retain unacknowledged messages in the subscription's backlog,
|
||||||
|
from the moment a message is published. If retainAckedMessages is true, then
|
||||||
|
this also configures the retention of acknowledged messages, and thus configures
|
||||||
|
how far back in time a subscriptions.seek can be done. Defaults to 7 days.
|
||||||
|
Cannot be more than 7 days (`"604800s"`) or less than 10 minutes (`"600s"`).
|
||||||
|
- 'A duration in seconds with up to nine fractional digits, terminated by ''s''.
|
||||||
|
Example: `"600.5s"`.'
|
||||||
|
returned: success
|
||||||
|
type: str
|
||||||
|
retainAckedMessages:
|
||||||
|
description:
|
||||||
|
- Indicates whether to retain acknowledged messages. If `true`, then messages
|
||||||
|
are not expunged from the subscription's backlog, even if they are acknowledged,
|
||||||
|
until they fall out of the messageRetentionDuration window.
|
||||||
|
returned: success
|
||||||
|
type: bool
|
||||||
'''
|
'''
|
||||||
|
|
||||||
################################################################################
|
################################################################################
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue