adding state info to docs (#317)

Signed-off-by: Modular Magician <magic-modules@google.com>
This commit is contained in:
The Magician 2019-07-19 13:12:23 -07:00 committed by Alex Stephen
parent d0d820bc84
commit 5967303b2d
60 changed files with 63 additions and 3 deletions

View file

@ -48,6 +48,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
description: description:
description: description:
- An optional string description of this rule. - An optional string description of this rule.

View file

@ -47,6 +47,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
name: name:
description: description:
- Dataset name. - Dataset name.

View file

@ -47,6 +47,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
table_reference: table_reference:
description: description:
- Reference describing the ID of this table. - Reference describing the ID of this table.

View file

@ -47,6 +47,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
id: id:
description: description:
- The unique identifier for the trigger. - The unique identifier for the trigger.

View file

@ -51,6 +51,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
name: name:
description: description:
- The name of the job. - The name of the job.

View file

@ -56,6 +56,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
address: address:
description: description:
- The static external IP address represented by this resource. Only IPv4 is supported. - The static external IP address represented by this resource. Only IPv4 is supported.

View file

@ -51,6 +51,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
bucket_name: bucket_name:
description: description:
- Cloud Storage bucket name. - Cloud Storage bucket name.

View file

@ -51,6 +51,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
affinity_cookie_ttl_sec: affinity_cookie_ttl_sec:
description: description:
- Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set - Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set

View file

@ -57,6 +57,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
description: description:
description: description:
- An optional description of this resource. Provide this property when you create - An optional description of this resource. Provide this property when you create

View file

@ -54,6 +54,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
allowed: allowed:
description: description:
- The list of ALLOW rules specified by this firewall. Each rule specifies a protocol - The list of ALLOW rules specified by this firewall. Each rule specifies a protocol

View file

@ -49,6 +49,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
description: description:
description: description:
- An optional description of this resource. Provide this property when you create - An optional description of this resource. Provide this property when you create

View file

@ -48,6 +48,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
address: address:
description: description:
- The static external IP address represented by this resource. - The static external IP address represented by this resource.

View file

@ -51,6 +51,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
description: description:
description: description:
- An optional description of this resource. Provide this property when you create - An optional description of this resource. Provide this property when you create

View file

@ -55,6 +55,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
check_interval_sec: check_interval_sec:
description: description:
- How often (in seconds) to send a health check. The default value is 5 seconds. - How often (in seconds) to send a health check. The default value is 5 seconds.

View file

@ -48,6 +48,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
check_interval_sec: check_interval_sec:
description: description:
- How often (in seconds) to send a health check. The default value is 5 seconds. - How often (in seconds) to send a health check. The default value is 5 seconds.

View file

@ -48,6 +48,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
check_interval_sec: check_interval_sec:
description: description:
- How often (in seconds) to send a health check. The default value is 5 seconds. - How often (in seconds) to send a health check. The default value is 5 seconds.

View file

@ -57,6 +57,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
description: description:
description: description:
- An optional description of this resource. Provide this property when you create - An optional description of this resource. Provide this property when you create

View file

@ -47,6 +47,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
can_ip_forward: can_ip_forward:
description: description:
- Allows this instance to send and receive packets with non-matching destination - Allows this instance to send and receive packets with non-matching destination

View file

@ -50,6 +50,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
description: description:
description: description:
- An optional description of this resource. Provide this property when you create - An optional description of this resource. Provide this property when you create

View file

@ -52,6 +52,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
base_instance_name: base_instance_name:
description: description:
- The base instance name to use for instances in this group. The value must be - The base instance name to use for instances in this group. The value must be

View file

@ -53,6 +53,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
description: description:
description: description:
- An optional description of this resource. Provide this property when you create - An optional description of this resource. Provide this property when you create

View file

@ -48,6 +48,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
interconnect: interconnect:
description: description:
- URL of the underlying Interconnect object that this attachment's traffic will - URL of the underlying Interconnect object that this attachment's traffic will

View file

@ -47,6 +47,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
description: description:
description: description:
- An optional description of this resource. The resource must be recreated to - An optional description of this resource. The resource must be recreated to

View file

@ -57,6 +57,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
description: description:
description: description:
- An optional description of this resource. Provide this property when you create - An optional description of this resource. Provide this property when you create

View file

@ -62,6 +62,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
dest_range: dest_range:
description: description:
- The destination range of outgoing packets that this route applies to. - The destination range of outgoing packets that this route applies to.

View file

@ -47,6 +47,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
name: name:
description: description:
- Name of the resource. The name must be 1-63 characters long, and comply with - Name of the resource. The name must be 1-63 characters long, and comply with

View file

@ -49,6 +49,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
certificate: certificate:
description: description:
- The certificate in PEM format. - The certificate in PEM format.

View file

@ -48,6 +48,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
description: description:
description: description:
- An optional description of this resource. - An optional description of this resource.

View file

@ -63,6 +63,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
description: description:
description: description:
- An optional description of this resource. Provide this property when you create - An optional description of this resource. Provide this property when you create

View file

@ -48,6 +48,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
description: description:
description: description:
- An optional description of this resource. - An optional description of this resource.

View file

@ -48,6 +48,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
description: description:
description: description:
- An optional description of this resource. - An optional description of this resource.

View file

@ -47,6 +47,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
backup_pool: backup_pool:
description: description:
- This field is applicable only when the containing target pool is serving a forwarding - This field is applicable only when the containing target pool is serving a forwarding
@ -360,7 +361,7 @@ def return_if_object(module, response, kind, allow_not_found=False):
except getattr(json.decoder, 'JSONDecodeError', ValueError): except getattr(json.decoder, 'JSONDecodeError', ValueError):
module.fail_json(msg="Invalid JSON response with error: %s" % response.text) module.fail_json(msg="Invalid JSON response with error: %s" % response.text)
result = decode_request(result, module) result = decode_response(result, module)
if navigate_hash(result, ['error', 'errors']): if navigate_hash(result, ['error', 'errors']):
module.fail_json(msg=navigate_hash(result, ['error', 'errors'])) module.fail_json(msg=navigate_hash(result, ['error', 'errors']))
@ -371,7 +372,7 @@ def return_if_object(module, response, kind, allow_not_found=False):
def is_different(module, response): def is_different(module, response):
request = resource_to_request(module) request = resource_to_request(module)
response = response_to_hash(module, response) response = response_to_hash(module, response)
request = decode_request(request, module) request = decode_response(request, module)
# Remove all output-only from response. # Remove all output-only from response.
response_vals = {} response_vals = {}
@ -453,7 +454,7 @@ def encode_request(request, module):
# Mask healthChecks into a single element. # Mask healthChecks into a single element.
# @see encode_request for details # @see encode_request for details
def decode_request(response, module): def decode_response(response, module):
if response['kind'] != 'compute#targetPool': if response['kind'] != 'compute#targetPool':
return response return response

View file

@ -48,6 +48,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
description: description:
description: description:
- An optional description of this resource. - An optional description of this resource.

View file

@ -48,6 +48,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
description: description:
description: description:
- An optional description of this resource. - An optional description of this resource.

View file

@ -48,6 +48,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
description: description:
description: description:
- An optional description of this resource. - An optional description of this resource.

View file

@ -48,6 +48,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
default_service: default_service:
description: description:
- A reference to BackendService resource if none of the hostRules match. - A reference to BackendService resource if none of the hostRules match.

View file

@ -47,6 +47,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
name: name:
description: description:
- Name of the resource. The name must be 1-63 characters long, and comply with - Name of the resource. The name must be 1-63 characters long, and comply with

View file

@ -47,6 +47,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
name: name:
description: description:
- The name of this cluster. The name must be unique within this project and location, - The name of this cluster. The name must be unique within this project and location,

View file

@ -51,6 +51,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
name: name:
description: description:
- The name of the node pool. - The name of the node pool.

View file

@ -48,6 +48,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
description: description:
description: description:
- A mutable string of at most 1024 characters associated with this resource for - A mutable string of at most 1024 characters associated with this resource for

View file

@ -51,6 +51,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
name: name:
description: description:
- For example, U(www.example.com). - For example, U(www.example.com).

View file

@ -47,6 +47,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
name: name:
description: description:
- The name of the role. - The name of the role.

View file

@ -47,6 +47,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
name: name:
description: description:
- The name of the service account. - The name of the service account.

View file

@ -47,6 +47,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
private_key_type: private_key_type:
description: description:
- Output format for the service account key. - Output format for the service account key.

View file

@ -49,6 +49,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
name: name:
description: description:
- The name specified for the model. - The name specified for the model.

View file

@ -48,6 +48,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
name: name:
description: description:
- The name specified for the version when it was created. - The name specified for the version when it was created.

View file

@ -48,6 +48,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
name: name:
description: description:
- Name of the subscription. - Name of the subscription.

View file

@ -47,6 +47,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
name: name:
description: description:
- Name of the topic. - Name of the topic.

View file

@ -47,6 +47,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
alternative_location_id: alternative_location_id:
description: description:
- Only applicable to STANDARD_HA tier which protects the instance against zonal - Only applicable to STANDARD_HA tier which protects the instance against zonal

View file

@ -48,6 +48,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
name: name:
description: description:
- 'The user-assigned display name of the Project. It must be 4 to 30 characters. - 'The user-assigned display name of the Project. It must be 4 to 30 characters.

View file

@ -47,6 +47,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
name: name:
description: description:
- Resource name of the repository, of the form projects/{{project}}/repos/{{repo}}. - Resource name of the repository, of the form projects/{{project}}/repos/{{repo}}.

View file

@ -47,6 +47,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
name: name:
description: description:
- A unique identifier for the database, which cannot be changed after the instance - A unique identifier for the database, which cannot be changed after the instance

View file

@ -47,6 +47,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
name: name:
description: description:
- A unique identifier for the instance, which cannot be changed after the instance - A unique identifier for the instance, which cannot be changed after the instance

View file

@ -47,6 +47,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
charset: charset:
description: description:
- The MySQL charset value. - The MySQL charset value.

View file

@ -49,6 +49,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
backend_type: backend_type:
description: description:
- "* FIRST_GEN: First Generation instance. MySQL only." - "* FIRST_GEN: First Generation instance. MySQL only."

View file

@ -47,6 +47,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
host: host:
description: description:
- The host name from which the user can connect. For insert operations, host defaults - The host name from which the user can connect. For insert operations, host defaults

View file

@ -52,6 +52,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
acl: acl:
description: description:
- Access controls on the bucket. - Access controls on the bucket.

View file

@ -56,6 +56,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
bucket: bucket:
description: description:
- The name of the bucket. - The name of the bucket.

View file

@ -47,6 +47,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
action: action:
description: description:
- Upload or download from the bucket. - Upload or download from the bucket.

View file

@ -47,6 +47,7 @@ options:
- present - present
- absent - absent
default: present default: present
type: str
name: name:
description: description:
- The immutable name of the TPU. - The immutable name of the TPU.