mirror of
https://github.com/ansible-collections/google.cloud.git
synced 2025-07-28 15:41:32 -07:00
Return values should be camelcase instead of underscored (#95)
This commit is contained in:
The Magician
Alex Stephen
parent
2a6c1e408e
commit
b3c1afe126
71 changed files with 6574 additions and 6906 deletions
|
|
@ -59,55 +59,175 @@ EXAMPLES = '''
|
|||
'''
|
||||
|
||||
RETURN = '''
|
||||
resources:
|
||||
description: List of resources
|
||||
returned: always
|
||||
type: complex
|
||||
contains:
|
||||
affinityCookieTtlSec:
|
||||
description:
|
||||
- Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If
|
||||
set to 0, the cookie is non-persistent and lasts only until the end of the
|
||||
browser session (or equivalent). The maximum allowed value for TTL is one
|
||||
day.
|
||||
- When the load balancing scheme is INTERNAL, this field is not used.
|
||||
returned: success
|
||||
type: int
|
||||
backends:
|
||||
description:
|
||||
- The list of backends that serve this BackendService.
|
||||
returned: success
|
||||
type: complex
|
||||
contains:
|
||||
balancingMode:
|
||||
description:
|
||||
- Specifies the balancing mode for this backend.
|
||||
- For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION.
|
||||
Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
|
||||
returned: success
|
||||
type: str
|
||||
capacityScaler:
|
||||
description:
|
||||
- A multiplier applied to the group's maximum servicing capacity (based
|
||||
on UTILIZATION, RATE or CONNECTION).
|
||||
- Default value is 1, which means the group will serve up to 100% of its
|
||||
configured capacity (depending on balancingMode). A setting of 0 means
|
||||
the group is completely drained, offering 0% of its available Capacity.
|
||||
Valid range is [0.0,1.0].
|
||||
returned: success
|
||||
type: str
|
||||
items:
|
||||
description: List of items
|
||||
returned: always
|
||||
type: complex
|
||||
contains:
|
||||
affinityCookieTtlSec:
|
||||
description:
|
||||
- Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to
|
||||
0, the cookie is non-persistent and lasts only until the end of the browser session
|
||||
(or equivalent). The maximum allowed value for TTL is one day.
|
||||
- When the load balancing scheme is INTERNAL, this field is not used.
|
||||
returned: success
|
||||
type: int
|
||||
backends:
|
||||
description:
|
||||
- The list of backends that serve this BackendService.
|
||||
returned: success
|
||||
type: complex
|
||||
contains:
|
||||
balancingMode:
|
||||
description:
|
||||
- Specifies the balancing mode for this backend.
|
||||
- For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid
|
||||
values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
|
||||
- This cannot be used for internal load balancing.
|
||||
returned: success
|
||||
type: str
|
||||
capacityScaler:
|
||||
description:
|
||||
- A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION,
|
||||
RATE or CONNECTION).
|
||||
- Default value is 1, which means the group will serve up to 100% of its configured
|
||||
capacity (depending on balancingMode). A setting of 0 means the group is completely
|
||||
drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
|
||||
- This cannot be used for internal load balancing.
|
||||
returned: success
|
||||
type: str
|
||||
description:
|
||||
description:
|
||||
- An optional description of this resource.
|
||||
- Provide this property when you create the resource.
|
||||
returned: success
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- This instance group defines the list of instances that serve traffic. Member virtual
|
||||
machine instances from each instance group must live in the same zone as the instance
|
||||
group itself.
|
||||
- No two backends in a backend service are allowed to use same Instance Group resource.
|
||||
- When the BackendService has load balancing scheme INTERNAL, the instance group must
|
||||
be in a zone within the same region as the BackendService.
|
||||
returned: success
|
||||
type: dict
|
||||
maxConnections:
|
||||
description:
|
||||
- The max number of simultaneous connections for the group. Can be used with either
|
||||
CONNECTION or UTILIZATION balancing modes.
|
||||
- For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be
|
||||
set.
|
||||
- This cannot be used for internal load balancing.
|
||||
returned: success
|
||||
type: int
|
||||
maxConnectionsPerInstance:
|
||||
description:
|
||||
- The max number of simultaneous connections that a single backend instance can handle.
|
||||
This is used to calculate the capacity of the group. Can be used in either CONNECTION
|
||||
or UTILIZATION balancing modes.
|
||||
- For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be
|
||||
set.
|
||||
- This cannot be used for internal load balancing.
|
||||
returned: success
|
||||
type: int
|
||||
maxRate:
|
||||
description:
|
||||
- The max requests per second (RPS) of the group.
|
||||
- Can be used with either RATE or UTILIZATION balancing modes, but required if RATE
|
||||
mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
|
||||
- This cannot be used for internal load balancing.
|
||||
returned: success
|
||||
type: int
|
||||
maxRatePerInstance:
|
||||
description:
|
||||
- The max requests per second (RPS) that a single backend instance can handle. This
|
||||
is used to calculate the capacity of the group. Can be used in either balancing
|
||||
mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
|
||||
- This cannot be used for internal load balancing.
|
||||
returned: success
|
||||
type: str
|
||||
maxUtilization:
|
||||
description:
|
||||
- Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target
|
||||
for the group. The default is 0.8. Valid range is [0.0, 1.0].
|
||||
- This cannot be used for internal load balancing.
|
||||
returned: success
|
||||
type: str
|
||||
cdnPolicy:
|
||||
description:
|
||||
- Cloud CDN configuration for this BackendService.
|
||||
returned: success
|
||||
type: complex
|
||||
contains:
|
||||
cacheKeyPolicy:
|
||||
description:
|
||||
- The CacheKeyPolicy for this CdnPolicy.
|
||||
returned: success
|
||||
type: complex
|
||||
contains:
|
||||
includeHost:
|
||||
description:
|
||||
- If true requests to different hosts will be cached separately.
|
||||
returned: success
|
||||
type: bool
|
||||
includeProtocol:
|
||||
description:
|
||||
- If true, http and https requests will be cached separately.
|
||||
returned: success
|
||||
type: bool
|
||||
includeQueryString:
|
||||
description:
|
||||
- If true, include query string parameters in the cache key according to query_string_whitelist
|
||||
and query_string_blacklist. If neither is set, the entire query string will be included.
|
||||
- If false, the query string will be excluded from the cache key entirely.
|
||||
returned: success
|
||||
type: bool
|
||||
queryStringBlacklist:
|
||||
description:
|
||||
- Names of query string parameters to exclude in cache keys.
|
||||
- All other parameters will be included. Either specify query_string_whitelist or
|
||||
query_string_blacklist, not both.
|
||||
- "'&' and '=' will be percent encoded and not treated as delimiters."
|
||||
returned: success
|
||||
type: list
|
||||
queryStringWhitelist:
|
||||
description:
|
||||
- Names of query string parameters to include in cache keys.
|
||||
- All other parameters will be excluded. Either specify query_string_whitelist or
|
||||
query_string_blacklist, not both.
|
||||
- "'&' and '=' will be percent encoded and not treated as delimiters."
|
||||
returned: success
|
||||
type: list
|
||||
connectionDraining:
|
||||
description:
|
||||
- Settings for connection draining.
|
||||
returned: success
|
||||
type: complex
|
||||
contains:
|
||||
drainingTimeoutSec:
|
||||
description:
|
||||
- Time for which instance will be drained (not accept new connections, but still work
|
||||
to finish started).
|
||||
returned: success
|
||||
type: int
|
||||
creationTimestamp:
|
||||
description:
|
||||
- Creation timestamp in RFC3339 text format.
|
||||
returned: success
|
||||
type: str
|
||||
description:
|
||||
description:
|
||||
- An optional description of this resource.
|
||||
returned: success
|
||||
type: str
|
||||
enable_cdn:
|
||||
enableCDN:
|
||||
description:
|
||||
- If true, enable Cloud CDN for this BackendService.
|
||||
- When the load balancing scheme is INTERNAL, this field is not used.
|
||||
returned: success
|
||||
type: bool
|
||||
health_checks:
|
||||
healthChecks:
|
||||
description:
|
||||
- The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health
|
||||
checking this BackendService. Currently at most one health check can be specified,
|
||||
|
|
@ -131,22 +251,22 @@ resources:
|
|||
- Enables IAP.
|
||||
returned: success
|
||||
type: bool
|
||||
oauth2_client_id:
|
||||
oauth2ClientId:
|
||||
description:
|
||||
- OAuth2 Client ID for IAP.
|
||||
returned: success
|
||||
type: str
|
||||
oauth2_client_secret:
|
||||
oauth2ClientSecret:
|
||||
description:
|
||||
- OAuth2 Client Secret for IAP.
|
||||
returned: success
|
||||
type: str
|
||||
oauth2_client_secret_sha256:
|
||||
oauth2ClientSecretSha256:
|
||||
description:
|
||||
- OAuth2 Client Secret SHA-256 for IAP.
|
||||
returned: success
|
||||
type: str
|
||||
load_balancing_scheme:
|
||||
loadBalancingScheme:
|
||||
description:
|
||||
- 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 used
|
||||
|
|
@ -163,7 +283,7 @@ resources:
|
|||
be a dash.
|
||||
returned: success
|
||||
type: str
|
||||
port_name:
|
||||
portName:
|
||||
description:
|
||||
- Name of backend port. The same name should appear in the instance groups referenced
|
||||
by this service. Required when the load balancing scheme is EXTERNAL.
|
||||
|
|
@ -184,7 +304,7 @@ resources:
|
|||
- This field is not applicable to global backend services.
|
||||
returned: success
|
||||
type: str
|
||||
session_affinity:
|
||||
sessionAffinity:
|
||||
description:
|
||||
- Type of session affinity to use. The default is NONE.
|
||||
- When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
|
||||
|
|
@ -193,7 +313,7 @@ resources:
|
|||
- When the protocol is UDP, this field is not used.
|
||||
returned: success
|
||||
type: str
|
||||
timeout_sec:
|
||||
timeoutSec:
|
||||
description:
|
||||
- How many seconds to wait for the backend before considering it a failed request.
|
||||
Default is 30 seconds. Valid range is [1, 86400].
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue