mirror of
https://github.com/ansible-collections/google.cloud.git
synced 2025-04-25 12:21:25 -07:00
Documentation Refactor
This commit is contained in:
parent
6a98471a53
commit
87656c4016
88 changed files with 11960 additions and 12598 deletions
|
@ -32,24 +32,24 @@ DOCUMENTATION = '''
|
|||
---
|
||||
module: gcp_spanner_database_facts
|
||||
description:
|
||||
- Gather facts for GCP Database
|
||||
- Gather facts for GCP Database
|
||||
short_description: Gather facts for GCP Database
|
||||
version_added: 2.8
|
||||
author: Google Inc. (@googlecloudplatform)
|
||||
requirements:
|
||||
- python >= 2.6
|
||||
- requests >= 2.18.4
|
||||
- google-auth >= 1.3.0
|
||||
- python >= 2.6
|
||||
- requests >= 2.18.4
|
||||
- google-auth >= 1.3.0
|
||||
options:
|
||||
instance:
|
||||
description:
|
||||
- The instance to create the database on.
|
||||
- 'This field represents a link to a Instance resource in GCP. It can be specified
|
||||
in two ways. You can add `register: name-of-resource` to a gcp_spanner_instance
|
||||
task and then set this instance field to "{{ name-of-resource }}" Alternatively,
|
||||
you can set this instance to a dictionary with the name key where the value is the
|
||||
name of your Instance.'
|
||||
required: true
|
||||
instance:
|
||||
description:
|
||||
- The instance to create the database on.
|
||||
- 'This field represents a link to a Instance resource in GCP. It can be specified
|
||||
in two ways. You can add `register: name-of-resource` to a gcp_spanner_instance
|
||||
task and then set this instance field to "{{ name-of-resource }}" Alternatively,
|
||||
you can set this instance to a dictionary with the name key where the value
|
||||
is the name of your Instance'
|
||||
required: true
|
||||
extends_documentation_fragment: gcp
|
||||
'''
|
||||
|
||||
|
@ -64,29 +64,30 @@ EXAMPLES = '''
|
|||
|
||||
RETURN = '''
|
||||
items:
|
||||
description: List of items
|
||||
returned: always
|
||||
type: complex
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- A unique identifier for the database, which cannot be changed after the instance
|
||||
is created. Values are of the form projects/<project>/instances/[a-z][-a-z0-9]*[a-z0-9].
|
||||
The final segment of the name must be between 6 and 30 characters in length.
|
||||
returned: success
|
||||
type: str
|
||||
extraStatements:
|
||||
description:
|
||||
- 'An optional list of DDL statements to run inside the newly created database. Statements
|
||||
can create tables, indexes, etc. These statements execute atomically with the creation
|
||||
of the database: if there is an error in any statement, the database is not created.'
|
||||
returned: success
|
||||
type: list
|
||||
instance:
|
||||
description:
|
||||
- The instance to create the database on.
|
||||
returned: success
|
||||
type: dict
|
||||
description: List of items
|
||||
returned: always
|
||||
type: complex
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- A unique identifier for the database, which cannot be changed after the instance
|
||||
is created. Values are of the form projects/<project>/instances/[a-z][-a-z0-9]*[a-z0-9].
|
||||
The final segment of the name must be between 6 and 30 characters in length.
|
||||
returned: success
|
||||
type: str
|
||||
extraStatements:
|
||||
description:
|
||||
- 'An optional list of DDL statements to run inside the newly created database.
|
||||
Statements can create tables, indexes, etc. These statements execute atomically
|
||||
with the creation of the database: if there is an error in any statement,
|
||||
the database is not created.'
|
||||
returned: success
|
||||
type: list
|
||||
instance:
|
||||
description:
|
||||
- The instance to create the database on.
|
||||
returned: success
|
||||
type: dict
|
||||
'''
|
||||
|
||||
################################################################################
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue