Add enum values generation to documentation (#3404) (#207)

* Add enum values generation to documentation, remove previous handwritten lists unless they add value

* Add possible enum values to inspec doc generation

* Add default, possible values to the schema description

* Format fixes

* Try spacing to see how md looks

* PR feedback

* Order of operations

* Bigger spacefor markdown

Signed-off-by: Modular Magician <magic-modules@google.com>
This commit is contained in:
The Magician 2020-04-24 13:45:23 -04:00 committed by GitHub
parent 41c072bf28
commit 282f8e3b82
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
40 changed files with 114 additions and 189 deletions

View file

@ -66,8 +66,7 @@ options:
type: str type: str
address_type: address_type:
description: description:
- The type of address to reserve, either INTERNAL or EXTERNAL. - The type of address to reserve.
- If unspecified, defaults to EXTERNAL.
- 'Some valid choices include: "INTERNAL", "EXTERNAL"' - 'Some valid choices include: "INTERNAL", "EXTERNAL"'
required: false required: false
default: EXTERNAL default: EXTERNAL
@ -99,9 +98,8 @@ options:
version_added: '2.10' version_added: '2.10'
network_tier: network_tier:
description: description:
- 'The networking tier used for configuring this address. This field can take - The networking tier used for configuring this address. If this field is not
the following values: PREMIUM or STANDARD. If this field is not specified, it specified, it is assumed to be PREMIUM.
is assumed to be PREMIUM.'
- 'Some valid choices include: "PREMIUM", "STANDARD"' - 'Some valid choices include: "PREMIUM", "STANDARD"'
required: false required: false
type: str type: str
@ -200,8 +198,7 @@ address:
type: str type: str
addressType: addressType:
description: description:
- The type of address to reserve, either INTERNAL or EXTERNAL. - The type of address to reserve.
- If unspecified, defaults to EXTERNAL.
returned: success returned: success
type: str type: str
creationTimestamp: creationTimestamp:
@ -238,9 +235,8 @@ purpose:
type: str type: str
networkTier: networkTier:
description: description:
- 'The networking tier used for configuring this address. This field can take the - The networking tier used for configuring this address. If this field is not specified,
following values: PREMIUM or STANDARD. If this field is not specified, it is assumed it is assumed to be PREMIUM.
to be PREMIUM.'
returned: success returned: success
type: str type: str
subnetwork: subnetwork:

View file

@ -128,8 +128,7 @@ resources:
type: str type: str
addressType: addressType:
description: description:
- The type of address to reserve, either INTERNAL or EXTERNAL. - The type of address to reserve.
- If unspecified, defaults to EXTERNAL.
returned: success returned: success
type: str type: str
creationTimestamp: creationTimestamp:
@ -166,9 +165,8 @@ resources:
type: str type: str
networkTier: networkTier:
description: description:
- 'The networking tier used for configuring this address. This field can take - The networking tier used for configuring this address. If this field is not
the following values: PREMIUM or STANDARD. If this field is not specified, specified, it is assumed to be PREMIUM.
it is assumed to be PREMIUM.'
returned: success returned: success
type: str type: str
subnetwork: subnetwork:

View file

@ -162,7 +162,7 @@ options:
utilization_target_type: utilization_target_type:
description: description:
- Defines how target utilization value is expressed for a Stackdriver - Defines how target utilization value is expressed for a Stackdriver
Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. Monitoring metric.
- 'Some valid choices include: "GAUGE", "DELTA_PER_SECOND", "DELTA_PER_MINUTE"' - 'Some valid choices include: "GAUGE", "DELTA_PER_SECOND", "DELTA_PER_MINUTE"'
required: false required: false
type: str type: str
@ -427,7 +427,7 @@ autoscalingPolicy:
utilizationTargetType: utilizationTargetType:
description: description:
- Defines how target utilization value is expressed for a Stackdriver Monitoring - Defines how target utilization value is expressed for a Stackdriver Monitoring
metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. metric.
returned: success returned: success
type: str type: str
loadBalancingUtilization: loadBalancingUtilization:

View file

@ -225,7 +225,7 @@ resources:
utilizationTargetType: utilizationTargetType:
description: description:
- Defines how target utilization value is expressed for a Stackdriver - Defines how target utilization value is expressed for a Stackdriver
Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. Monitoring metric.
returned: success returned: success
type: str type: str
loadBalancingUtilization: loadBalancingUtilization:

View file

@ -287,8 +287,7 @@ options:
description: description:
- Indicates whether the backend service will be used with internal or external - Indicates whether the backend service will be used with internal or external
load balancing. A backend service created for one type of load balancing cannot load balancing. A backend service created for one type of load balancing cannot
be used with the other. Must be `EXTERNAL` or `INTERNAL_SELF_MANAGED` for a be used with the other.
global backend service. Defaults to `EXTERNAL`.
- 'Some valid choices include: "EXTERNAL", "INTERNAL_SELF_MANAGED"' - 'Some valid choices include: "EXTERNAL", "INTERNAL_SELF_MANAGED"'
required: false required: false
default: EXTERNAL default: EXTERNAL
@ -313,9 +312,8 @@ options:
protocol: protocol:
description: description:
- The protocol this BackendService uses to communicate with backends. - The protocol this BackendService uses to communicate with backends.
- 'Possible values are HTTP, HTTPS, HTTP2, TCP, and SSL. The default is HTTP. - 'The default is HTTP. **NOTE**: HTTP2 is only valid for beta HTTP/2 load balancer
**NOTE**: HTTP2 is only valid for beta HTTP/2 load balancer types and may result types and may result in errors if used with the GA API.'
in errors if used with the GA API.'
- 'Some valid choices include: "HTTP", "HTTPS", "HTTP2", "TCP", "SSL"' - 'Some valid choices include: "HTTP", "HTTPS", "HTTP2", "TCP", "SSL"'
required: false required: false
type: str type: str
@ -673,8 +671,7 @@ loadBalancingScheme:
description: description:
- Indicates whether the backend service will be used with internal or external load - Indicates whether the backend service will be used with internal or external load
balancing. A backend service created for one type of load balancing cannot be balancing. A backend service created for one type of load balancing cannot be
used with the other. Must be `EXTERNAL` or `INTERNAL_SELF_MANAGED` for a global used with the other.
backend service. Defaults to `EXTERNAL`.
returned: success returned: success
type: str type: str
name: name:
@ -696,9 +693,8 @@ portName:
protocol: protocol:
description: description:
- The protocol this BackendService uses to communicate with backends. - The protocol this BackendService uses to communicate with backends.
- 'Possible values are HTTP, HTTPS, HTTP2, TCP, and SSL. The default is HTTP. **NOTE**: - 'The default is HTTP. **NOTE**: HTTP2 is only valid for beta HTTP/2 load balancer
HTTP2 is only valid for beta HTTP/2 load balancer types and may result in errors types and may result in errors if used with the GA API.'
if used with the GA API.'
returned: success returned: success
type: str type: str
securityPolicy: securityPolicy:

View file

@ -356,8 +356,7 @@ resources:
description: description:
- Indicates whether the backend service will be used with internal or external - Indicates whether the backend service will be used with internal or external
load balancing. A backend service created for one type of load balancing cannot load balancing. A backend service created for one type of load balancing cannot
be used with the other. Must be `EXTERNAL` or `INTERNAL_SELF_MANAGED` for be used with the other.
a global backend service. Defaults to `EXTERNAL`.
returned: success returned: success
type: str type: str
name: name:
@ -379,9 +378,8 @@ resources:
protocol: protocol:
description: description:
- The protocol this BackendService uses to communicate with backends. - The protocol this BackendService uses to communicate with backends.
- 'Possible values are HTTP, HTTPS, HTTP2, TCP, and SSL. The default is HTTP. - 'The default is HTTP. **NOTE**: HTTP2 is only valid for beta HTTP/2 load balancer
**NOTE**: HTTP2 is only valid for beta HTTP/2 load balancer types and may types and may result in errors if used with the GA API.'
result in errors if used with the GA API.'
returned: success returned: success
type: str type: str
securityPolicy: securityPolicy:

View file

@ -81,8 +81,7 @@ options:
type: str type: str
ip_protocol: ip_protocol:
description: description:
- The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, - The IP protocol to which this rule applies.
AH, SCTP or ICMP.
- When the load balancing scheme is INTERNAL, only TCP and UDP are valid. - When the load balancing scheme is INTERNAL, only TCP and UDP are valid.
- 'Some valid choices include: "TCP", "UDP", "ESP", "AH", "SCTP", "ICMP"' - 'Some valid choices include: "TCP", "UDP", "ESP", "AH", "SCTP", "ICMP"'
required: false required: false
@ -197,9 +196,8 @@ options:
version_added: '2.8' version_added: '2.8'
network_tier: network_tier:
description: description:
- 'The networking tier used for configuring this address. This field can take - The networking tier used for configuring this address. If this field is not
the following values: PREMIUM or STANDARD. If this field is not specified, it specified, it is assumed to be PREMIUM.
is assumed to be PREMIUM.'
- 'Some valid choices include: "PREMIUM", "STANDARD"' - 'Some valid choices include: "PREMIUM", "STANDARD"'
required: false required: false
type: str type: str
@ -352,8 +350,7 @@ IPAddress:
type: str type: str
IPProtocol: IPProtocol:
description: description:
- The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, - The IP protocol to which this rule applies.
SCTP or ICMP.
- When the load balancing scheme is INTERNAL, only TCP and UDP are valid. - When the load balancing scheme is INTERNAL, only TCP and UDP are valid.
returned: success returned: success
type: str type: str
@ -446,9 +443,8 @@ allPorts:
type: bool type: bool
networkTier: networkTier:
description: description:
- 'The networking tier used for configuring this address. This field can take the - The networking tier used for configuring this address. If this field is not specified,
following values: PREMIUM or STANDARD. If this field is not specified, it is assumed it is assumed to be PREMIUM.
to be PREMIUM.'
returned: success returned: success
type: str type: str
serviceLabel: serviceLabel:

View file

@ -160,8 +160,7 @@ resources:
type: str type: str
IPProtocol: IPProtocol:
description: description:
- The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, - The IP protocol to which this rule applies.
AH, SCTP or ICMP.
- When the load balancing scheme is INTERNAL, only TCP and UDP are valid. - When the load balancing scheme is INTERNAL, only TCP and UDP are valid.
returned: success returned: success
type: str type: str
@ -256,9 +255,8 @@ resources:
type: bool type: bool
networkTier: networkTier:
description: description:
- 'The networking tier used for configuring this address. This field can take - The networking tier used for configuring this address. If this field is not
the following values: PREMIUM or STANDARD. If this field is not specified, specified, it is assumed to be PREMIUM.
it is assumed to be PREMIUM.'
returned: success returned: success
type: str type: str
serviceLabel: serviceLabel:

View file

@ -72,8 +72,7 @@ options:
type: str type: str
ip_version: ip_version:
description: description:
- The IP Version that will be used by this address. Valid options are `IPV4` or - The IP Version that will be used by this address. The default value is `IPV4`.
`IPV6`. The default value is `IPV4`.
- 'Some valid choices include: "IPV4", "IPV6"' - 'Some valid choices include: "IPV4", "IPV6"'
required: false required: false
type: str type: str
@ -87,7 +86,7 @@ options:
version_added: '2.9' version_added: '2.9'
address_type: address_type:
description: description:
- The type of the address to reserve, default is EXTERNAL. - The type of the address to reserve.
- "* EXTERNAL indicates public/external single IP address." - "* EXTERNAL indicates public/external single IP address."
- "* INTERNAL indicates internal IP ranges belonging to some network." - "* INTERNAL indicates internal IP ranges belonging to some network."
- 'Some valid choices include: "EXTERNAL", "INTERNAL"' - 'Some valid choices include: "EXTERNAL", "INTERNAL"'
@ -212,8 +211,7 @@ name:
type: str type: str
ipVersion: ipVersion:
description: description:
- The IP Version that will be used by this address. Valid options are `IPV4` or - The IP Version that will be used by this address. The default value is `IPV4`.
`IPV6`. The default value is `IPV4`.
returned: success returned: success
type: str type: str
region: region:
@ -230,7 +228,7 @@ prefixLength:
type: int type: int
addressType: addressType:
description: description:
- The type of the address to reserve, default is EXTERNAL. - The type of the address to reserve.
- "* EXTERNAL indicates public/external single IP address." - "* EXTERNAL indicates public/external single IP address."
- "* INTERNAL indicates internal IP ranges belonging to some network." - "* INTERNAL indicates internal IP ranges belonging to some network."
returned: success returned: success

View file

@ -145,8 +145,7 @@ resources:
type: str type: str
ipVersion: ipVersion:
description: description:
- The IP Version that will be used by this address. Valid options are `IPV4` - The IP Version that will be used by this address. The default value is `IPV4`.
or `IPV6`. The default value is `IPV4`.
returned: success returned: success
type: str type: str
region: region:
@ -163,7 +162,7 @@ resources:
type: int type: int
addressType: addressType:
description: description:
- The type of the address to reserve, default is EXTERNAL. - The type of the address to reserve.
- "* EXTERNAL indicates public/external single IP address." - "* EXTERNAL indicates public/external single IP address."
- "* INTERNAL indicates internal IP ranges belonging to some network." - "* INTERNAL indicates internal IP ranges belonging to some network."
returned: success returned: success

View file

@ -83,16 +83,14 @@ options:
type: str type: str
ip_protocol: ip_protocol:
description: description:
- The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, - The IP protocol to which this rule applies. When the load balancing scheme is
AH, SCTP or ICMP. When the load balancing scheme is INTERNAL_SELF_MANAGED, only INTERNAL_SELF_MANAGED, only TCP is valid.
TCP is valid.
- 'Some valid choices include: "TCP", "UDP", "ESP", "AH", "SCTP", "ICMP"' - 'Some valid choices include: "TCP", "UDP", "ESP", "AH", "SCTP", "ICMP"'
required: false required: false
type: str type: str
ip_version: ip_version:
description: description:
- The IP Version that will be used by this global forwarding rule. - The IP Version that will be used by this global forwarding rule.
- Valid options are IPV4 or IPV6.
- 'Some valid choices include: "IPV4", "IPV6"' - 'Some valid choices include: "IPV4", "IPV6"'
required: false required: false
type: str type: str
@ -363,15 +361,13 @@ IPAddress:
type: str type: str
IPProtocol: IPProtocol:
description: description:
- The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, - The IP protocol to which this rule applies. When the load balancing scheme is
SCTP or ICMP. When the load balancing scheme is INTERNAL_SELF_MANAGED, only TCP INTERNAL_SELF_MANAGED, only TCP is valid.
is valid.
returned: success returned: success
type: str type: str
ipVersion: ipVersion:
description: description:
- The IP Version that will be used by this global forwarding rule. - The IP Version that will be used by this global forwarding rule.
- Valid options are IPV4 or IPV6.
returned: success returned: success
type: str type: str
loadBalancingScheme: loadBalancingScheme:

View file

@ -153,15 +153,13 @@ resources:
type: str type: str
IPProtocol: IPProtocol:
description: description:
- The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, - The IP protocol to which this rule applies. When the load balancing scheme
AH, SCTP or ICMP. When the load balancing scheme is INTERNAL_SELF_MANAGED, is INTERNAL_SELF_MANAGED, only TCP is valid.
only TCP is valid.
returned: success returned: success
type: str type: str
ipVersion: ipVersion:
description: description:
- The IP Version that will be used by this global forwarding rule. - The IP Version that will be used by this global forwarding rule.
- Valid options are IPV4 or IPV6.
returned: success returned: success
type: str type: str
loadBalancingScheme: loadBalancingScheme:

View file

@ -152,7 +152,7 @@ options:
proxy_header: proxy_header:
description: description:
- Specifies the type of proxy header to append before sending data to the - Specifies the type of proxy header to append before sending data to the
backend, either NONE or PROXY_V1. The default is NONE. backend.
- 'Some valid choices include: "NONE", "PROXY_V1"' - 'Some valid choices include: "NONE", "PROXY_V1"'
required: false required: false
default: NONE default: NONE
@ -214,7 +214,7 @@ options:
proxy_header: proxy_header:
description: description:
- Specifies the type of proxy header to append before sending data to the - Specifies the type of proxy header to append before sending data to the
backend, either NONE or PROXY_V1. The default is NONE. backend.
- 'Some valid choices include: "NONE", "PROXY_V1"' - 'Some valid choices include: "NONE", "PROXY_V1"'
required: false required: false
default: NONE default: NONE
@ -269,7 +269,7 @@ options:
proxy_header: proxy_header:
description: description:
- Specifies the type of proxy header to append before sending data to the - Specifies the type of proxy header to append before sending data to the
backend, either NONE or PROXY_V1. The default is NONE. backend.
- 'Some valid choices include: "NONE", "PROXY_V1"' - 'Some valid choices include: "NONE", "PROXY_V1"'
required: false required: false
default: NONE default: NONE
@ -324,7 +324,7 @@ options:
proxy_header: proxy_header:
description: description:
- Specifies the type of proxy header to append before sending data to the - Specifies the type of proxy header to append before sending data to the
backend, either NONE or PROXY_V1. The default is NONE. backend.
- 'Some valid choices include: "NONE", "PROXY_V1"' - 'Some valid choices include: "NONE", "PROXY_V1"'
required: false required: false
default: NONE default: NONE
@ -387,7 +387,7 @@ options:
proxy_header: proxy_header:
description: description:
- Specifies the type of proxy header to append before sending data to the - Specifies the type of proxy header to append before sending data to the
backend, either NONE or PROXY_V1. The default is NONE. backend.
- 'Some valid choices include: "NONE", "PROXY_V1"' - 'Some valid choices include: "NONE", "PROXY_V1"'
required: false required: false
default: NONE default: NONE
@ -574,8 +574,7 @@ httpHealthCheck:
type: str type: str
proxyHeader: proxyHeader:
description: description:
- Specifies the type of proxy header to append before sending data to the backend, - Specifies the type of proxy header to append before sending data to the backend.
either NONE or PROXY_V1. The default is NONE.
returned: success returned: success
type: str type: str
portSpecification: portSpecification:
@ -630,8 +629,7 @@ httpsHealthCheck:
type: str type: str
proxyHeader: proxyHeader:
description: description:
- Specifies the type of proxy header to append before sending data to the backend, - Specifies the type of proxy header to append before sending data to the backend.
either NONE or PROXY_V1. The default is NONE.
returned: success returned: success
type: str type: str
portSpecification: portSpecification:
@ -680,8 +678,7 @@ tcpHealthCheck:
type: str type: str
proxyHeader: proxyHeader:
description: description:
- Specifies the type of proxy header to append before sending data to the backend, - Specifies the type of proxy header to append before sending data to the backend.
either NONE or PROXY_V1. The default is NONE.
returned: success returned: success
type: str type: str
portSpecification: portSpecification:
@ -730,8 +727,7 @@ sslHealthCheck:
type: str type: str
proxyHeader: proxyHeader:
description: description:
- Specifies the type of proxy header to append before sending data to the backend, - Specifies the type of proxy header to append before sending data to the backend.
either NONE or PROXY_V1. The default is NONE.
returned: success returned: success
type: str type: str
portSpecification: portSpecification:
@ -786,8 +782,7 @@ http2HealthCheck:
type: str type: str
proxyHeader: proxyHeader:
description: description:
- Specifies the type of proxy header to append before sending data to the backend, - Specifies the type of proxy header to append before sending data to the backend.
either NONE or PROXY_V1. The default is NONE.
returned: success returned: success
type: str type: str
portSpecification: portSpecification:

View file

@ -211,7 +211,7 @@ resources:
proxyHeader: proxyHeader:
description: description:
- Specifies the type of proxy header to append before sending data to the - Specifies the type of proxy header to append before sending data to the
backend, either NONE or PROXY_V1. The default is NONE. backend.
returned: success returned: success
type: str type: str
portSpecification: portSpecification:
@ -269,7 +269,7 @@ resources:
proxyHeader: proxyHeader:
description: description:
- Specifies the type of proxy header to append before sending data to the - Specifies the type of proxy header to append before sending data to the
backend, either NONE or PROXY_V1. The default is NONE. backend.
returned: success returned: success
type: str type: str
portSpecification: portSpecification:
@ -322,7 +322,7 @@ resources:
proxyHeader: proxyHeader:
description: description:
- Specifies the type of proxy header to append before sending data to the - Specifies the type of proxy header to append before sending data to the
backend, either NONE or PROXY_V1. The default is NONE. backend.
returned: success returned: success
type: str type: str
portSpecification: portSpecification:
@ -375,7 +375,7 @@ resources:
proxyHeader: proxyHeader:
description: description:
- Specifies the type of proxy header to append before sending data to the - Specifies the type of proxy header to append before sending data to the
backend, either NONE or PROXY_V1. The default is NONE. backend.
returned: success returned: success
type: str type: str
portSpecification: portSpecification:
@ -433,7 +433,7 @@ resources:
proxyHeader: proxyHeader:
description: description:
- Specifies the type of proxy header to append before sending data to the - Specifies the type of proxy header to append before sending data to the
backend, either NONE or PROXY_V1. The default is NONE. backend.
returned: success returned: success
type: str type: str
portSpecification: portSpecification:

View file

@ -73,8 +73,7 @@ options:
type: str type: str
network_endpoint_type: network_endpoint_type:
description: description:
- Type of network endpoints in this network endpoint group. The only supported - Type of network endpoints in this network endpoint group.
value is GCE_VM_IP_PORT .
- 'Some valid choices include: "GCE_VM_IP_PORT"' - 'Some valid choices include: "GCE_VM_IP_PORT"'
required: false required: false
default: GCE_VM_IP_PORT default: GCE_VM_IP_PORT
@ -222,8 +221,7 @@ description:
type: str type: str
networkEndpointType: networkEndpointType:
description: description:
- Type of network endpoints in this network endpoint group. The only supported value - Type of network endpoints in this network endpoint group.
is GCE_VM_IP_PORT .
returned: success returned: success
type: str type: str
size: size:

View file

@ -141,8 +141,7 @@ resources:
type: str type: str
networkEndpointType: networkEndpointType:
description: description:
- Type of network endpoints in this network endpoint group. The only supported - Type of network endpoints in this network endpoint group.
value is GCE_VM_IP_PORT .
returned: success returned: success
type: str type: str
size: size:

View file

@ -148,7 +148,7 @@ options:
utilization_target_type: utilization_target_type:
description: description:
- Defines how target utilization value is expressed for a Stackdriver - Defines how target utilization value is expressed for a Stackdriver
Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. Monitoring metric.
- 'Some valid choices include: "GAUGE", "DELTA_PER_SECOND", "DELTA_PER_MINUTE"' - 'Some valid choices include: "GAUGE", "DELTA_PER_SECOND", "DELTA_PER_MINUTE"'
required: false required: false
type: str type: str
@ -404,7 +404,7 @@ autoscalingPolicy:
utilizationTargetType: utilizationTargetType:
description: description:
- Defines how target utilization value is expressed for a Stackdriver Monitoring - Defines how target utilization value is expressed for a Stackdriver Monitoring
metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. metric.
returned: success returned: success
type: str type: str
loadBalancingUtilization: loadBalancingUtilization:

View file

@ -225,7 +225,7 @@ resources:
utilizationTargetType: utilizationTargetType:
description: description:
- Defines how target utilization value is expressed for a Stackdriver - Defines how target utilization value is expressed for a Stackdriver
Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. Monitoring metric.
returned: success returned: success
type: str type: str
loadBalancingUtilization: loadBalancingUtilization:

View file

@ -58,7 +58,7 @@ options:
suboptions: suboptions:
balancing_mode: balancing_mode:
description: description:
- Specifies the balancing mode for this backend. Defaults to CONNECTION. - Specifies the balancing mode for this backend.
- 'Some valid choices include: "UTILIZATION", "RATE", "CONNECTION"' - 'Some valid choices include: "UTILIZATION", "RATE", "CONNECTION"'
required: false required: false
default: CONNECTION default: CONNECTION
@ -185,8 +185,7 @@ options:
description: description:
- Indicates what kind of load balancing this regional backend service will be - Indicates what kind of load balancing this regional backend service will be
used for. A backend service created for one type of load balancing cannot be used for. A backend service created for one type of load balancing cannot be
used with the other(s). Must be `INTERNAL` or `INTERNAL_MANAGED`. Defaults to used with the other(s).
`INTERNAL`.
- 'Some valid choices include: "INTERNAL", "INTERNAL_MANAGED"' - 'Some valid choices include: "INTERNAL", "INTERNAL_MANAGED"'
required: false required: false
default: INTERNAL default: INTERNAL
@ -204,9 +203,8 @@ options:
protocol: protocol:
description: description:
- The protocol this RegionBackendService uses to communicate with backends. - The protocol this RegionBackendService uses to communicate with backends.
- 'Possible values are HTTP, HTTPS, HTTP2, SSL, TCP, and UDP. The default is HTTP. - 'The default is HTTP. **NOTE**: HTTP2 is only valid for beta HTTP/2 load balancer
**NOTE**: HTTP2 is only valid for beta HTTP/2 load balancer types and may result types and may result in errors if used with the GA API.'
in errors if used with the GA API.'
- 'Some valid choices include: "HTTP", "HTTPS", "HTTP2", "SSL", "TCP", "UDP"' - 'Some valid choices include: "HTTP", "HTTPS", "HTTP2", "SSL", "TCP", "UDP"'
required: false required: false
type: str type: str
@ -331,7 +329,7 @@ backends:
contains: contains:
balancingMode: balancingMode:
description: description:
- Specifies the balancing mode for this backend. Defaults to CONNECTION. - Specifies the balancing mode for this backend.
returned: success returned: success
type: str type: str
capacityScaler: capacityScaler:
@ -470,7 +468,7 @@ loadBalancingScheme:
description: description:
- Indicates what kind of load balancing this regional backend service will be used - Indicates what kind of load balancing this regional backend service will be used
for. A backend service created for one type of load balancing cannot be used with for. A backend service created for one type of load balancing cannot be used with
the other(s). Must be `INTERNAL` or `INTERNAL_MANAGED`. Defaults to `INTERNAL`. the other(s).
returned: success returned: success
type: str type: str
name: name:
@ -486,9 +484,8 @@ name:
protocol: protocol:
description: description:
- The protocol this RegionBackendService uses to communicate with backends. - The protocol this RegionBackendService uses to communicate with backends.
- 'Possible values are HTTP, HTTPS, HTTP2, SSL, TCP, and UDP. The default is HTTP. - 'The default is HTTP. **NOTE**: HTTP2 is only valid for beta HTTP/2 load balancer
**NOTE**: HTTP2 is only valid for beta HTTP/2 load balancer types and may result types and may result in errors if used with the GA API.'
in errors if used with the GA API.'
returned: success returned: success
type: str type: str
sessionAffinity: sessionAffinity:

View file

@ -126,7 +126,7 @@ resources:
contains: contains:
balancingMode: balancingMode:
description: description:
- Specifies the balancing mode for this backend. Defaults to CONNECTION. - Specifies the balancing mode for this backend.
returned: success returned: success
type: str type: str
capacityScaler: capacityScaler:
@ -268,8 +268,7 @@ resources:
description: description:
- Indicates what kind of load balancing this regional backend service will be - Indicates what kind of load balancing this regional backend service will be
used for. A backend service created for one type of load balancing cannot used for. A backend service created for one type of load balancing cannot
be used with the other(s). Must be `INTERNAL` or `INTERNAL_MANAGED`. Defaults be used with the other(s).
to `INTERNAL`.
returned: success returned: success
type: str type: str
name: name:
@ -285,9 +284,8 @@ resources:
protocol: protocol:
description: description:
- The protocol this RegionBackendService uses to communicate with backends. - The protocol this RegionBackendService uses to communicate with backends.
- 'Possible values are HTTP, HTTPS, HTTP2, SSL, TCP, and UDP. The default is - 'The default is HTTP. **NOTE**: HTTP2 is only valid for beta HTTP/2 load balancer
HTTP. **NOTE**: HTTP2 is only valid for beta HTTP/2 load balancer types and types and may result in errors if used with the GA API.'
may result in errors if used with the GA API.'
returned: success returned: success
type: str type: str
sessionAffinity: sessionAffinity:

View file

@ -150,7 +150,7 @@ options:
proxy_header: proxy_header:
description: description:
- Specifies the type of proxy header to append before sending data to the - Specifies the type of proxy header to append before sending data to the
backend, either NONE or PROXY_V1. The default is NONE. backend.
- 'Some valid choices include: "NONE", "PROXY_V1"' - 'Some valid choices include: "NONE", "PROXY_V1"'
required: false required: false
default: NONE default: NONE
@ -211,7 +211,7 @@ options:
proxy_header: proxy_header:
description: description:
- Specifies the type of proxy header to append before sending data to the - Specifies the type of proxy header to append before sending data to the
backend, either NONE or PROXY_V1. The default is NONE. backend.
- 'Some valid choices include: "NONE", "PROXY_V1"' - 'Some valid choices include: "NONE", "PROXY_V1"'
required: false required: false
default: NONE default: NONE
@ -265,7 +265,7 @@ options:
proxy_header: proxy_header:
description: description:
- Specifies the type of proxy header to append before sending data to the - Specifies the type of proxy header to append before sending data to the
backend, either NONE or PROXY_V1. The default is NONE. backend.
- 'Some valid choices include: "NONE", "PROXY_V1"' - 'Some valid choices include: "NONE", "PROXY_V1"'
required: false required: false
default: NONE default: NONE
@ -319,7 +319,7 @@ options:
proxy_header: proxy_header:
description: description:
- Specifies the type of proxy header to append before sending data to the - Specifies the type of proxy header to append before sending data to the
backend, either NONE or PROXY_V1. The default is NONE. backend.
- 'Some valid choices include: "NONE", "PROXY_V1"' - 'Some valid choices include: "NONE", "PROXY_V1"'
required: false required: false
default: NONE default: NONE
@ -380,7 +380,7 @@ options:
proxy_header: proxy_header:
description: description:
- Specifies the type of proxy header to append before sending data to the - Specifies the type of proxy header to append before sending data to the
backend, either NONE or PROXY_V1. The default is NONE. backend.
- 'Some valid choices include: "NONE", "PROXY_V1"' - 'Some valid choices include: "NONE", "PROXY_V1"'
required: false required: false
default: NONE default: NONE
@ -573,8 +573,7 @@ httpHealthCheck:
type: str type: str
proxyHeader: proxyHeader:
description: description:
- Specifies the type of proxy header to append before sending data to the backend, - Specifies the type of proxy header to append before sending data to the backend.
either NONE or PROXY_V1. The default is NONE.
returned: success returned: success
type: str type: str
portSpecification: portSpecification:
@ -629,8 +628,7 @@ httpsHealthCheck:
type: str type: str
proxyHeader: proxyHeader:
description: description:
- Specifies the type of proxy header to append before sending data to the backend, - Specifies the type of proxy header to append before sending data to the backend.
either NONE or PROXY_V1. The default is NONE.
returned: success returned: success
type: str type: str
portSpecification: portSpecification:
@ -679,8 +677,7 @@ tcpHealthCheck:
type: str type: str
proxyHeader: proxyHeader:
description: description:
- Specifies the type of proxy header to append before sending data to the backend, - Specifies the type of proxy header to append before sending data to the backend.
either NONE or PROXY_V1. The default is NONE.
returned: success returned: success
type: str type: str
portSpecification: portSpecification:
@ -729,8 +726,7 @@ sslHealthCheck:
type: str type: str
proxyHeader: proxyHeader:
description: description:
- Specifies the type of proxy header to append before sending data to the backend, - Specifies the type of proxy header to append before sending data to the backend.
either NONE or PROXY_V1. The default is NONE.
returned: success returned: success
type: str type: str
portSpecification: portSpecification:
@ -785,8 +781,7 @@ http2HealthCheck:
type: str type: str
proxyHeader: proxyHeader:
description: description:
- Specifies the type of proxy header to append before sending data to the backend, - Specifies the type of proxy header to append before sending data to the backend.
either NONE or PROXY_V1. The default is NONE.
returned: success returned: success
type: str type: str
portSpecification: portSpecification:

View file

@ -217,7 +217,7 @@ resources:
proxyHeader: proxyHeader:
description: description:
- Specifies the type of proxy header to append before sending data to the - Specifies the type of proxy header to append before sending data to the
backend, either NONE or PROXY_V1. The default is NONE. backend.
returned: success returned: success
type: str type: str
portSpecification: portSpecification:
@ -275,7 +275,7 @@ resources:
proxyHeader: proxyHeader:
description: description:
- Specifies the type of proxy header to append before sending data to the - Specifies the type of proxy header to append before sending data to the
backend, either NONE or PROXY_V1. The default is NONE. backend.
returned: success returned: success
type: str type: str
portSpecification: portSpecification:
@ -328,7 +328,7 @@ resources:
proxyHeader: proxyHeader:
description: description:
- Specifies the type of proxy header to append before sending data to the - Specifies the type of proxy header to append before sending data to the
backend, either NONE or PROXY_V1. The default is NONE. backend.
returned: success returned: success
type: str type: str
portSpecification: portSpecification:
@ -381,7 +381,7 @@ resources:
proxyHeader: proxyHeader:
description: description:
- Specifies the type of proxy header to append before sending data to the - Specifies the type of proxy header to append before sending data to the
backend, either NONE or PROXY_V1. The default is NONE. backend.
returned: success returned: success
type: str type: str
portSpecification: portSpecification:
@ -439,7 +439,7 @@ resources:
proxyHeader: proxyHeader:
description: description:
- Specifies the type of proxy header to append before sending data to the - Specifies the type of proxy header to append before sending data to the
backend, either NONE or PROXY_V1. The default is NONE. backend.
returned: success returned: success
type: str type: str
portSpecification: portSpecification:

View file

@ -135,8 +135,7 @@ options:
suboptions: suboptions:
interface: interface:
description: description:
- The disk interface to use for attaching this disk, one of `SCSI` - The disk interface to use for attaching this disk.
or `NVME`. The default is `SCSI`.
- 'Some valid choices include: "SCSI", "NVME"' - 'Some valid choices include: "SCSI", "NVME"'
required: false required: false
default: SCSI default: SCSI
@ -325,8 +324,7 @@ specificReservation:
contains: contains:
interface: interface:
description: description:
- The disk interface to use for attaching this disk, one of `SCSI` or - The disk interface to use for attaching this disk.
`NVME`. The default is `SCSI`.
returned: success returned: success
type: str type: str
diskSizeGb: diskSizeGb:

View file

@ -223,8 +223,7 @@ resources:
contains: contains:
interface: interface:
description: description:
- The disk interface to use for attaching this disk, one of `SCSI` - The disk interface to use for attaching this disk.
or `NVME`. The default is `SCSI`.
returned: success returned: success
type: str type: str
diskSizeGb: diskSizeGb:

View file

@ -151,7 +151,6 @@ options:
description: description:
- Specifies the behavior to apply to scheduled snapshots when the source - Specifies the behavior to apply to scheduled snapshots when the source
disk is deleted. disk is deleted.
- Valid options are KEEP_AUTO_SNAPSHOTS and APPLY_RETENTION_POLICY .
- 'Some valid choices include: "KEEP_AUTO_SNAPSHOTS", "APPLY_RETENTION_POLICY"' - 'Some valid choices include: "KEEP_AUTO_SNAPSHOTS", "APPLY_RETENTION_POLICY"'
required: false required: false
default: KEEP_AUTO_SNAPSHOTS default: KEEP_AUTO_SNAPSHOTS
@ -366,7 +365,6 @@ snapshotSchedulePolicy:
description: description:
- Specifies the behavior to apply to scheduled snapshots when the source - Specifies the behavior to apply to scheduled snapshots when the source
disk is deleted. disk is deleted.
- Valid options are KEEP_AUTO_SNAPSHOTS and APPLY_RETENTION_POLICY .
returned: success returned: success
type: str type: str
snapshotProperties: snapshotProperties:

View file

@ -217,7 +217,6 @@ resources:
description: description:
- Specifies the behavior to apply to scheduled snapshots when the source - Specifies the behavior to apply to scheduled snapshots when the source
disk is deleted. disk is deleted.
- Valid options are KEEP_AUTO_SNAPSHOTS and APPLY_RETENTION_POLICY .
returned: success returned: success
type: str type: str
snapshotProperties: snapshotProperties:

View file

@ -88,7 +88,6 @@ options:
advertise_mode: advertise_mode:
description: description:
- User-specified flag to indicate which mode to use for advertisement. - User-specified flag to indicate which mode to use for advertisement.
- 'Valid values of this enum field are: DEFAULT, CUSTOM .'
- 'Some valid choices include: "DEFAULT", "CUSTOM"' - 'Some valid choices include: "DEFAULT", "CUSTOM"'
required: false required: false
default: DEFAULT default: DEFAULT
@ -257,7 +256,6 @@ bgp:
advertiseMode: advertiseMode:
description: description:
- User-specified flag to indicate which mode to use for advertisement. - User-specified flag to indicate which mode to use for advertisement.
- 'Valid values of this enum field are: DEFAULT, CUSTOM .'
returned: success returned: success
type: str type: str
advertisedGroups: advertisedGroups:

View file

@ -163,7 +163,6 @@ resources:
advertiseMode: advertiseMode:
description: description:
- User-specified flag to indicate which mode to use for advertisement. - User-specified flag to indicate which mode to use for advertisement.
- 'Valid values of this enum field are: DEFAULT, CUSTOM .'
returned: success returned: success
type: str type: str
advertisedGroups: advertisedGroups:

View file

@ -67,17 +67,15 @@ options:
profile: profile:
description: description:
- Profile specifies the set of SSL features that can be used by the load balancer - Profile specifies the set of SSL features that can be used by the load balancer
when negotiating SSL with clients. This can be one of `COMPATIBLE`, `MODERN`, when negotiating SSL with clients. If using `CUSTOM`, the set of SSL features
`RESTRICTED`, or `CUSTOM`. If using `CUSTOM`, the set of SSL features to enable to enable must be specified in the `customFeatures` field.
must be specified in the `customFeatures` field.
- 'Some valid choices include: "COMPATIBLE", "MODERN", "RESTRICTED", "CUSTOM"' - 'Some valid choices include: "COMPATIBLE", "MODERN", "RESTRICTED", "CUSTOM"'
required: false required: false
type: str type: str
min_tls_version: min_tls_version:
description: description:
- The minimum version of SSL protocol that can be used by the clients to establish - The minimum version of SSL protocol that can be used by the clients to establish
a connection with the load balancer. This can be one of `TLS_1_0`, `TLS_1_1`, a connection with the load balancer.
`TLS_1_2`.
- 'Some valid choices include: "TLS_1_0", "TLS_1_1", "TLS_1_2"' - 'Some valid choices include: "TLS_1_0", "TLS_1_1", "TLS_1_2"'
required: false required: false
type: str type: str
@ -185,16 +183,14 @@ name:
profile: profile:
description: description:
- Profile specifies the set of SSL features that can be used by the load balancer - Profile specifies the set of SSL features that can be used by the load balancer
when negotiating SSL with clients. This can be one of `COMPATIBLE`, `MODERN`, when negotiating SSL with clients. If using `CUSTOM`, the set of SSL features
`RESTRICTED`, or `CUSTOM`. If using `CUSTOM`, the set of SSL features to enable to enable must be specified in the `customFeatures` field.
must be specified in the `customFeatures` field.
returned: success returned: success
type: str type: str
minTlsVersion: minTlsVersion:
description: description:
- The minimum version of SSL protocol that can be used by the clients to establish - The minimum version of SSL protocol that can be used by the clients to establish
a connection with the load balancer. This can be one of `TLS_1_0`, `TLS_1_1`, a connection with the load balancer.
`TLS_1_2`.
returned: success returned: success
type: str type: str
enabledFeatures: enabledFeatures:

View file

@ -140,16 +140,14 @@ resources:
profile: profile:
description: description:
- Profile specifies the set of SSL features that can be used by the load balancer - Profile specifies the set of SSL features that can be used by the load balancer
when negotiating SSL with clients. This can be one of `COMPATIBLE`, `MODERN`, when negotiating SSL with clients. If using `CUSTOM`, the set of SSL features
`RESTRICTED`, or `CUSTOM`. If using `CUSTOM`, the set of SSL features to enable to enable must be specified in the `customFeatures` field.
must be specified in the `customFeatures` field.
returned: success returned: success
type: str type: str
minTlsVersion: minTlsVersion:
description: description:
- The minimum version of SSL protocol that can be used by the clients to establish - The minimum version of SSL protocol that can be used by the clients to establish
a connection with the load balancer. This can be one of `TLS_1_0`, `TLS_1_1`, a connection with the load balancer.
`TLS_1_2`.
returned: success returned: success
type: str type: str
enabledFeatures: enabledFeatures:

View file

@ -69,8 +69,7 @@ options:
- Specifies the QUIC override policy for this resource. This determines whether - Specifies the QUIC override policy for this resource. This determines whether
the load balancer will attempt to negotiate QUIC with clients or not. Can specify the load balancer will attempt to negotiate QUIC with clients or not. Can specify
one of NONE, ENABLE, or DISABLE. If NONE is specified, uses the QUIC policy one of NONE, ENABLE, or DISABLE. If NONE is specified, uses the QUIC policy
with no user overrides, which is equivalent to DISABLE. Not specifying this with no user overrides, which is equivalent to DISABLE.
field is equivalent to specifying NONE.
- 'Some valid choices include: "NONE", "ENABLE", "DISABLE"' - 'Some valid choices include: "NONE", "ENABLE", "DISABLE"'
required: false required: false
type: str type: str
@ -283,8 +282,7 @@ quicOverride:
- Specifies the QUIC override policy for this resource. This determines whether - Specifies the QUIC override policy for this resource. This determines whether
the load balancer will attempt to negotiate QUIC with clients or not. Can specify the load balancer will attempt to negotiate QUIC with clients or not. Can specify
one of NONE, ENABLE, or DISABLE. If NONE is specified, uses the QUIC policy with one of NONE, ENABLE, or DISABLE. If NONE is specified, uses the QUIC policy with
no user overrides, which is equivalent to DISABLE. Not specifying this field is no user overrides, which is equivalent to DISABLE.
equivalent to specifying NONE.
returned: success returned: success
type: str type: str
sslCertificates: sslCertificates:

View file

@ -142,8 +142,7 @@ resources:
- Specifies the QUIC override policy for this resource. This determines whether - Specifies the QUIC override policy for this resource. This determines whether
the load balancer will attempt to negotiate QUIC with clients or not. Can the load balancer will attempt to negotiate QUIC with clients or not. Can
specify one of NONE, ENABLE, or DISABLE. If NONE is specified, uses the QUIC specify one of NONE, ENABLE, or DISABLE. If NONE is specified, uses the QUIC
policy with no user overrides, which is equivalent to DISABLE. Not specifying policy with no user overrides, which is equivalent to DISABLE.
this field is equivalent to specifying NONE.
returned: success returned: success
type: str type: str
sslCertificates: sslCertificates:

View file

@ -66,8 +66,7 @@ options:
type: str type: str
proxy_header: proxy_header:
description: description:
- Specifies the type of proxy header to append before sending data to the backend, - Specifies the type of proxy header to append before sending data to the backend.
either NONE or PROXY_V1. The default is NONE.
- 'Some valid choices include: "NONE", "PROXY_V1"' - 'Some valid choices include: "NONE", "PROXY_V1"'
required: false required: false
type: str type: str
@ -270,8 +269,7 @@ name:
type: str type: str
proxyHeader: proxyHeader:
description: description:
- Specifies the type of proxy header to append before sending data to the backend, - Specifies the type of proxy header to append before sending data to the backend.
either NONE or PROXY_V1. The default is NONE.
returned: success returned: success
type: str type: str
service: service:

View file

@ -139,8 +139,7 @@ resources:
type: str type: str
proxyHeader: proxyHeader:
description: description:
- Specifies the type of proxy header to append before sending data to the backend, - Specifies the type of proxy header to append before sending data to the backend.
either NONE or PROXY_V1. The default is NONE.
returned: success returned: success
type: str type: str
service: service:

View file

@ -66,8 +66,7 @@ options:
type: str type: str
proxy_header: proxy_header:
description: description:
- Specifies the type of proxy header to append before sending data to the backend, - Specifies the type of proxy header to append before sending data to the backend.
either NONE or PROXY_V1. The default is NONE.
- 'Some valid choices include: "NONE", "PROXY_V1"' - 'Some valid choices include: "NONE", "PROXY_V1"'
required: false required: false
type: str type: str
@ -214,8 +213,7 @@ name:
type: str type: str
proxyHeader: proxyHeader:
description: description:
- Specifies the type of proxy header to append before sending data to the backend, - Specifies the type of proxy header to append before sending data to the backend.
either NONE or PROXY_V1. The default is NONE.
returned: success returned: success
type: str type: str
service: service:

View file

@ -139,8 +139,7 @@ resources:
type: str type: str
proxyHeader: proxyHeader:
description: description:
- Specifies the type of proxy header to append before sending data to the backend, - Specifies the type of proxy header to append before sending data to the backend.
either NONE or PROXY_V1. The default is NONE.
returned: success returned: success
type: str type: str
service: service:

View file

@ -148,7 +148,6 @@ options:
description: description:
- 'The zone''s visibility: public zones are exposed to the Internet, while private - 'The zone''s visibility: public zones are exposed to the Internet, while private
zones are visible only to Virtual Private Cloud resources.' zones are visible only to Virtual Private Cloud resources.'
- 'Must be one of: `public`, `private`.'
- 'Some valid choices include: "private", "public"' - 'Some valid choices include: "private", "public"'
required: false required: false
default: public default: public
@ -347,7 +346,6 @@ visibility:
description: description:
- 'The zone''s visibility: public zones are exposed to the Internet, while private - 'The zone''s visibility: public zones are exposed to the Internet, while private
zones are visible only to Virtual Private Cloud resources.' zones are visible only to Virtual Private Cloud resources.'
- 'Must be one of: `public`, `private`.'
returned: success returned: success
type: str type: str
privateVisibilityConfig: privateVisibilityConfig:

View file

@ -215,7 +215,6 @@ resources:
description: description:
- 'The zone''s visibility: public zones are exposed to the Internet, while private - 'The zone''s visibility: public zones are exposed to the Internet, while private
zones are visible only to Virtual Private Cloud resources.' zones are visible only to Virtual Private Cloud resources.'
- 'Must be one of: `public`, `private`.'
returned: success returned: success
type: str type: str
privateVisibilityConfig: privateVisibilityConfig:

View file

@ -63,8 +63,7 @@ options:
type: str type: str
connect_mode: connect_mode:
description: description:
- The connection mode of the Redis instance. Can be either `DIRECT_PEERING` or - The connection mode of the Redis instance.
`PRIVATE_SERVICE_ACCESS`. The default connect mode if not provided is `DIRECT_PEERING`.
- 'Some valid choices include: "DIRECT_PEERING", "PRIVATE_SERVICE_ACCESS"' - 'Some valid choices include: "DIRECT_PEERING", "PRIVATE_SERVICE_ACCESS"'
required: false required: false
default: DIRECT_PEERING default: DIRECT_PEERING
@ -231,8 +230,7 @@ authorizedNetwork:
type: str type: str
connectMode: connectMode:
description: description:
- The connection mode of the Redis instance. Can be either `DIRECT_PEERING` or `PRIVATE_SERVICE_ACCESS`. - The connection mode of the Redis instance.
The default connect mode if not provided is `DIRECT_PEERING`.
returned: success returned: success
type: str type: str
createTime: createTime:

View file

@ -125,8 +125,7 @@ resources:
type: str type: str
connectMode: connectMode:
description: description:
- The connection mode of the Redis instance. Can be either `DIRECT_PEERING` - The connection mode of the Redis instance.
or `PRIVATE_SERVICE_ACCESS`. The default connect mode if not provided is `DIRECT_PEERING`.
returned: success returned: success
type: str type: str
createTime: createTime: