summaryrefslogtreecommitdiff
path: root/lib/ansible/modules/cloud/google/gcp_spanner_instance_info.py
diff options
context:
space:
mode:
Diffstat (limited to 'lib/ansible/modules/cloud/google/gcp_spanner_instance_info.py')
-rw-r--r--lib/ansible/modules/cloud/google/gcp_spanner_instance_info.py194
1 files changed, 0 insertions, 194 deletions
diff --git a/lib/ansible/modules/cloud/google/gcp_spanner_instance_info.py b/lib/ansible/modules/cloud/google/gcp_spanner_instance_info.py
deleted file mode 100644
index 35ae75b090..0000000000
--- a/lib/ansible/modules/cloud/google/gcp_spanner_instance_info.py
+++ /dev/null
@@ -1,194 +0,0 @@
-#!/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_spanner_instance_info
-description:
-- Gather info for GCP Instance
-short_description: Gather info for GCP Instance
-version_added: '2.8'
-author: Google Inc. (@googlecloudplatform)
-requirements:
-- python >= 2.6
-- requests >= 2.18.4
-- google-auth >= 1.3.0
-options:
- project:
- description:
- - The Google Cloud Platform project to use.
- type: str
- auth_kind:
- description:
- - The type of credential used.
- type: str
- required: true
- choices:
- - application
- - machineaccount
- - serviceaccount
- service_account_contents:
- description:
- - The contents of a Service Account JSON file, either in a dictionary or as a
- JSON string that represents it.
- type: jsonarg
- service_account_file:
- description:
- - The path of a Service Account JSON file if serviceaccount is selected as type.
- type: path
- service_account_email:
- description:
- - An optional service account email address if machineaccount is selected and
- the user does not wish to use the default email.
- type: str
- scopes:
- description:
- - Array of scopes to be used
- type: list
- env_type:
- description:
- - Specifies which Ansible environment you're running this module within.
- - This should not be set unless you know what you're doing.
- - This only alters the User Agent string for any API requests.
- type: str
-notes:
-- for authentication, you can set service_account_file using the C(gcp_service_account_file)
- env variable.
-- for authentication, you can set service_account_contents using the C(GCP_SERVICE_ACCOUNT_CONTENTS)
- env variable.
-- For authentication, you can set service_account_email using the C(GCP_SERVICE_ACCOUNT_EMAIL)
- env variable.
-- For authentication, you can set auth_kind using the C(GCP_AUTH_KIND) env variable.
-- For authentication, you can set scopes using the C(GCP_SCOPES) env variable.
-- Environment variables values will only be used if the playbook values are not set.
-- The I(service_account_email) and I(service_account_file) options are mutually exclusive.
-'''
-
-EXAMPLES = '''
-- name: get info on an instance
- gcp_spanner_instance_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:
- - A unique identifier for the instance, which cannot be changed after the instance
- is created. The name must be between 6 and 30 characters in length.
- returned: success
- type: str
- config:
- description:
- - The name of the instance's configuration (similar but not quite the same as
- a region) which defines defines the geographic placement and replication of
- your databases in this instance. It determines where your data is stored.
- Values are typically of the form `regional-europe-west1` , `us-central` etc.
- - In order to obtain a valid list please consult the [Configuration section
- of the docs](U(https://cloud.google.com/spanner/docs/instances)).
- returned: success
- type: str
- displayName:
- description:
- - The descriptive name for this instance as it appears in UIs. Must be unique
- per project and between 4 and 30 characters in length.
- returned: success
- type: str
- nodeCount:
- description:
- - The number of nodes allocated to this instance.
- returned: success
- type: int
- labels:
- description:
- - 'An object containing a list of "key": value pairs.'
- - 'Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.'
- returned: success
- type: dict
-'''
-
-################################################################################
-# Imports
-################################################################################
-from ansible.module_utils.gcp_utils import navigate_hash, GcpSession, GcpModule, GcpRequest
-import json
-
-################################################################################
-# Main
-################################################################################
-
-
-def main():
- module = GcpModule(argument_spec=dict())
-
- if not module.params['scopes']:
- module.params['scopes'] = ['https://www.googleapis.com/auth/spanner.admin']
-
- return_value = {'resources': fetch_list(module, collection(module))}
- module.exit_json(**return_value)
-
-
-def collection(module):
- return "https://spanner.googleapis.com/v1/projects/{project}/instances".format(**module.params)
-
-
-def fetch_list(module, link):
- auth = GcpSession(module, 'spanner')
- return auth.list(link, return_if_object, array_name='instances')
-
-
-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()