mirror of
https://github.com/ansible-collections/google.cloud.git
synced 2025-09-30 05:23:29 -07:00
rename facts modules to info modules (#298)
Signed-off-by: Modular Magician <magic-modules@google.com>
This commit is contained in:
The Magician
Alex Stephen
parent
242834ff72
commit
effb6cdadd
175 changed files with 725 additions and 409 deletions
234
plugins/modules/gcp_pubsub_subscription_info.py
Normal file
234
plugins/modules/gcp_pubsub_subscription_info.py
Normal file
|
|
@ -0,0 +1,234 @@
|
|||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# Copyright (C) 2017 Google
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# ----------------------------------------------------------------------------
|
||||
#
|
||||
# *** AUTO GENERATED CODE *** AUTO GENERATED CODE ***
|
||||
#
|
||||
# ----------------------------------------------------------------------------
|
||||
#
|
||||
# This file is automatically generated by Magic Modules and manual
|
||||
# changes will be clobbered when the file is regenerated.
|
||||
#
|
||||
# Please read more about how to change this file at
|
||||
# https://www.github.com/GoogleCloudPlatform/magic-modules
|
||||
#
|
||||
# ----------------------------------------------------------------------------
|
||||
|
||||
from __future__ import absolute_import, division, print_function
|
||||
|
||||
__metaclass__ = type
|
||||
|
||||
################################################################################
|
||||
# Documentation
|
||||
################################################################################
|
||||
|
||||
ANSIBLE_METADATA = {'metadata_version': '1.1', 'status': ["preview"], 'supported_by': 'community'}
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
module: gcp_pubsub_subscription_info
|
||||
description:
|
||||
- Gather info for GCP Subscription
|
||||
- This module was previously called gcp_pubsub_subscription_facts before Ansible 2.9.
|
||||
The usage has not changed
|
||||
short_description: Gather info for GCP Subscription
|
||||
version_added: 2.8
|
||||
author: Google Inc. (@googlecloudplatform)
|
||||
requirements:
|
||||
- python >= 2.6
|
||||
- requests >= 2.18.4
|
||||
- google-auth >= 1.3.0
|
||||
options: {}
|
||||
extends_documentation_fragment: gcp
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
- name: " a subscription info"
|
||||
gcp_pubsub_subscription_info:
|
||||
project: test_project
|
||||
auth_kind: serviceaccount
|
||||
service_account_file: "/tmp/auth.pem"
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
resources:
|
||||
description: List of resources
|
||||
returned: always
|
||||
type: complex
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- Name of the subscription.
|
||||
returned: success
|
||||
type: str
|
||||
topic:
|
||||
description:
|
||||
- A reference to a Topic resource.
|
||||
returned: success
|
||||
type: dict
|
||||
labels:
|
||||
description:
|
||||
- A set of key/value label pairs to assign to this Subscription.
|
||||
returned: success
|
||||
type: dict
|
||||
pushConfig:
|
||||
description:
|
||||
- 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.
|
||||
returned: success
|
||||
type: complex
|
||||
contains:
|
||||
pushEndpoint:
|
||||
description:
|
||||
- A URL locating the endpoint to which messages should be pushed.
|
||||
- For example, a Webhook endpoint might use "U(https://example.com/push").
|
||||
returned: success
|
||||
type: str
|
||||
attributes:
|
||||
description:
|
||||
- Endpoint configuration attributes.
|
||||
- Every endpoint has a set of API supported attributes that can be used
|
||||
to control different aspects of the message delivery.
|
||||
- The currently supported attribute is x-goog-version, which you can use
|
||||
to change the format of the pushed message. This attribute indicates the
|
||||
version of the data expected by the endpoint. This controls the shape
|
||||
of the pushed message (i.e., its fields and metadata). The endpoint version
|
||||
is based on the version of the Pub/Sub API.
|
||||
- If not present during the subscriptions.create call, it will default to
|
||||
the version of the API used to make such call. If not present during a
|
||||
subscriptions.modifyPushConfig call, its value will not be changed. subscriptions.get
|
||||
calls will always return a valid version, even if the subscription was
|
||||
created without this attribute.
|
||||
- 'The possible values for this attribute are: - v1beta1: uses the push
|
||||
format defined in the v1beta1 Pub/Sub API.'
|
||||
- "- v1 or v1beta2: uses the push format defined in the v1 Pub/Sub API."
|
||||
returned: success
|
||||
type: dict
|
||||
ackDeadlineSeconds:
|
||||
description:
|
||||
- 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.
|
||||
returned: success
|
||||
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
|
||||
expirationPolicy:
|
||||
description:
|
||||
- A policy that specifies the conditions for this subscription's expiration.
|
||||
- A subscription is considered active as long as any connected subscriber is
|
||||
successfully consuming messages from the subscription or is issuing operations
|
||||
on the subscription. If expirationPolicy is not set, a default policy with
|
||||
ttl of 31 days will be used. The minimum allowed value for expirationPolicy.ttl
|
||||
is 1 day.
|
||||
returned: success
|
||||
type: complex
|
||||
contains:
|
||||
ttl:
|
||||
description:
|
||||
- Specifies the "time-to-live" duration for an associated resource. The
|
||||
resource expires if it is not active for a period of ttl. The definition
|
||||
of "activity" depends on the type of the associated resource. The minimum
|
||||
and maximum allowed values for ttl depend on the type of the associated
|
||||
resource, as well. If ttl is not set, the associated resource never expires.
|
||||
- A duration in seconds with up to nine fractional digits, terminated by
|
||||
's'.
|
||||
- Example - "3.5s".
|
||||
returned: success
|
||||
type: str
|
||||
'''
|
||||
|
||||
################################################################################
|
||||
# Imports
|
||||
################################################################################
|
||||
from ansible.module_utils.gcp_utils import navigate_hash, GcpSession, GcpModule, GcpRequest
|
||||
import json
|
||||
|
||||
################################################################################
|
||||
# Main
|
||||
################################################################################
|
||||
|
||||
|
||||
def main():
|
||||
module = GcpModule(argument_spec=dict())
|
||||
|
||||
if module._name == 'gcp_pubsub_subscription_facts':
|
||||
module.deprecate("The 'gcp_pubsub_subscription_facts' module has been renamed to 'gcp_pubsub_subscription_info'", version='2.13')
|
||||
|
||||
if not module.params['scopes']:
|
||||
module.params['scopes'] = ['https://www.googleapis.com/auth/pubsub']
|
||||
|
||||
items = fetch_list(module, collection(module))
|
||||
if items.get('subscriptions'):
|
||||
items = items.get('subscriptions')
|
||||
else:
|
||||
items = []
|
||||
return_value = {'resources': items}
|
||||
module.exit_json(**return_value)
|
||||
|
||||
|
||||
def collection(module):
|
||||
return "https://pubsub.googleapis.com/v1/projects/{project}/subscriptions".format(**module.params)
|
||||
|
||||
|
||||
def fetch_list(module, link):
|
||||
auth = GcpSession(module, 'pubsub')
|
||||
response = auth.get(link)
|
||||
return return_if_object(module, response)
|
||||
|
||||
|
||||
def return_if_object(module, response):
|
||||
# If not found, return nothing.
|
||||
if response.status_code == 404:
|
||||
return None
|
||||
|
||||
# If no content, return nothing.
|
||||
if response.status_code == 204:
|
||||
return None
|
||||
|
||||
try:
|
||||
module.raise_for_status(response)
|
||||
result = response.json()
|
||||
except getattr(json.decoder, 'JSONDecodeError', ValueError) as inst:
|
||||
module.fail_json(msg="Invalid JSON response with error: %s" % inst)
|
||||
|
||||
if navigate_hash(result, ['error', 'errors']):
|
||||
module.fail_json(msg=navigate_hash(result, ['error', 'errors']))
|
||||
|
||||
return result
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
Loading…
Add table
Add a link
Reference in a new issue