Blame - docs/dyn/compute_v1.backendServices.html - platform/external/python/google-api-python-client

blob: b65de89685d11a6d4f9c059c96a82c6a77f1173f [file] [log] [blame]

Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	1	<html><body>
				2	<style>
				3
				4	body, h1, h2, h3, div, span, p, pre, a {
				5	margin: 0;
				6	padding: 0;
				7	border: 0;
				8	font-weight: inherit;
				9	font-style: inherit;
				10	font-size: 100%;
				11	font-family: inherit;
				12	vertical-align: baseline;
				13	}
				14
				15	body {
				16	font-size: 13px;
				17	padding: 1em;
				18	}
				19
				20	h1 {
				21	font-size: 26px;
				22	margin-bottom: 1em;
				23	}
				24
				25	h2 {
				26	font-size: 24px;
				27	margin-bottom: 1em;
				28	}
				29
				30	h3 {
				31	font-size: 20px;
				32	margin-bottom: 1em;
				33	margin-top: 1em;
				34	}
				35
				36	pre, code {
				37	line-height: 1.5;
				38	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
				39	}
				40
				41	pre {
				42	margin-top: 0.5em;
				43	}
				44
				45	h1, h2, h3, p {
				46	font-family: Arial, sans serif;
				47	}
				48
				49	h1, h2, h3 {
				50	border-bottom: solid #CCC 1px;
				51	}
				52
				53	.toc_element {
				54	margin-top: 0.5em;
				55	}
				56
				57	.firstline {
				58	margin-left: 2 em;
				59	}
				60
				61	.method {
				62	margin-top: 1em;
				63	border: solid 1px #CCC;
				64	padding: 1em;
				65	background: #EEE;
				66	}
				67
				68	.details {
				69	font-weight: bold;
				70	font-size: 14px;
				71	}
				72
				73	</style>
				74
				75	<h1><a href="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.backendServices.html">backendServices</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	78	<code><a href="#addSignedUrlKey">addSignedUrlKey(project, backendService, body=None, requestId=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	79	<p class="firstline">Adds a key for validating requests with signed URLs for this backend service.</p>
				80	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	81	<code><a href="#aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	82	<p class="firstline">Retrieves the list of all BackendService resources, regional and global, available to the specified project.</p>
				83	<p class="toc_element">
				84	<code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
				85	<p class="firstline">Retrieves the next page of results.</p>
				86	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	87	<code><a href="#close">close()</a></code></p>
				88	<p class="firstline">Close httplib2 connections.</p>
				89	<p class="toc_element">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	90	<code><a href="#delete">delete(project, backendService, requestId=None)</a></code></p>
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	91	<p class="firstline">Deletes the specified BackendService resource.</p>
				92	<p class="toc_element">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	93	<code><a href="#deleteSignedUrlKey">deleteSignedUrlKey(project, backendService, keyName, requestId=None)</a></code></p>
				94	<p class="firstline">Deletes a key for validating requests with signed URLs for this backend service.</p>
				95	<p class="toc_element">
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	96	<code><a href="#get">get(project, backendService)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	97	<p class="firstline">Returns the specified BackendService resource. Gets a list of available backend services.</p>
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	98	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	99	<code><a href="#getHealth">getHealth(project, backendService, body=None)</a></code></p>
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	100	<p class="firstline">Gets the most recent health check results for this BackendService.</p>
				101	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	102	<code><a href="#insert">insert(project, body=None, requestId=None)</a></code></p>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	103	<p class="firstline">Creates a BackendService resource in the specified project using the data included in the request. For more information, see Backend services overview.</p>
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	104	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	105	<code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	106	<p class="firstline">Retrieves the list of BackendService resources available to the specified project.</p>
				107	<p class="toc_element">
				108	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				109	<p class="firstline">Retrieves the next page of results.</p>
				110	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	111	<code><a href="#patch">patch(project, backendService, body=None, requestId=None)</a></code></p>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	112	<p class="firstline">Patches the specified BackendService resource with the data included in the request. For more information, see Backend services overview. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.</p>
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	113	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	114	<code><a href="#setSecurityPolicy">setSecurityPolicy(project, backendService, body=None, requestId=None)</a></code></p>
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	115	<p class="firstline">Sets the Google Cloud Armor security policy for the specified backend service. For more information, see Google Cloud Armor Overview</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	116	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	117	<code><a href="#update">update(project, backendService, body=None, requestId=None)</a></code></p>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	118	<p class="firstline">Updates the specified BackendService resource with the data included in the request. For more information, see Backend services overview.</p>
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	119	<h3>Method Details</h3>
				120	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	121	<code class="details" id="addSignedUrlKey">addSignedUrlKey(project, backendService, body=None, requestId=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	122	<pre>Adds a key for validating requests with signed URLs for this backend service.
				123
				124	Args:
				125	project: string, Project ID for this request. (required)
				126	backendService: string, Name of the BackendService resource to which the Signed URL Key should be added. The name should conform to RFC1035. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	127	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	128	The object takes the form of:
				129
				130	{ # Represents a customer-supplied Signing Key used by Cloud CDN Signed URLs
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	131	"keyName": "A String", # Name of the key. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
				132	"keyValue": "A String", # 128-bit key value used for signing the URL. The key value must be a valid RFC 4648 Section 5 base64url encoded string.
				133	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	134
				135	requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
				136
				137	For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
				138
				139	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
				140
				141	Returns:
				142	An object of the form:
				143
				144	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	145	#
				146	# Google Compute Engine has three Operation resources:
				147	#
				148	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				149	#
				150	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				151	#
				152	# Operations can be global, regional or zonal.
				153	# - For global operations, use the `globalOperations` resource.
				154	# - For regional operations, use the `regionOperations` resource.
				155	# - For zonal operations, use the `zonalOperations` resource.
				156	#
				157	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				158	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				159	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				160	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				161	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				162	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				163	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	164	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	165	"code": "A String", # [Output Only] The error type identifier for this error.
				166	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				167	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	168	},
				169	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	170	},
				171	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				172	"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
				173	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				174	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				175	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				176	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	177	"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	178	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				179	"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
				180	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				181	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				182	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				183	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				184	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				185	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				186	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
				187	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				188	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				189	{
				190	"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
				191	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				192	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				193	{
				194	"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
				195	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				196	},
				197	],
				198	"message": "A String", # [Output Only] A human-readable description of the warning code.
				199	},
				200	],
				201	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				202	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	203	</div>
				204
				205	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	206	<code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	207	<pre>Retrieves the list of all BackendService resources, regional and global, available to the specified project.
				208
				209	Args:
				210	project: string, Name of the project scoping this request. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	211	filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	212
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	213	For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	214
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	215	You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	216
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	217	To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	218	includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	219	maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
				220	orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
				221
				222	You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
				223
				224	Currently, only sorting by `name` or `creationTimestamp desc` is supported.
				225	pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	226	returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	227
				228	Returns:
				229	An object of the form:
				230
				231	{ # Contains a list of BackendServicesScopedList.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	232	"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
				233	"items": { # A list of BackendServicesScopedList resources.
				234	"a_key": { # Name of the scope containing this set of BackendServices.
				235	"backendServices": [ # A list of BackendServices contained in this scope.
				236	{ # Represents a Backend Service resource.
				237	#
				238	# A backend service defines how Google Cloud load balancers distribute traffic. The backend service configuration contains a set of values, such as the protocol used to connect to backends, various distribution and session settings, health checks, and timeouts. These settings provide fine-grained control over how your load balancer behaves. Most of the settings have default values that allow for easy configuration if you need to get started quickly.
				239	#
				240	# Backend services in Google Compute Engine can be either regionally or globally scoped.
				241	#
				242	# * [Global](/compute/docs/reference/rest/{$api_version}/backendServices) * [Regional](/compute/docs/reference/rest/{$api_version}/regionBackendServices)
				243	#
				244	# For more information, see Backend Services.
				245	#
				246	# (== resource_for {$api_version}.backendService ==)
				247	"affinityCookieTtlSec": 42, # Lifetime of cookies in seconds. Only applicable if the loadBalancingScheme is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED, the protocol is HTTP or HTTPS, and the sessionAffinity is GENERATED_COOKIE, or HTTP_COOKIE.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	248	#
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	249	# 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 is one day (86,400).
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	250	#
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	251	# Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
				252	"backends": [ # The list of backends that serve this BackendService.
				253	{ # Message containing information of one individual backend.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	254	"balancingMode": "A String", # Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode.
				255	"capacityScaler": 3.14, # A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves 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. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	256	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	257	# Not supported by:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	258	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	259	# - Internal TCP/UDP Load Balancing - Network Load Balancing
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	260	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				261	"failover": True or False, # This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService.
				262	"group": "A String", # The fully-qualified URL of an instance group or network endpoint group (NEG) resource. The type of backend that a backend service supports depends on the backend service's loadBalancingScheme.
				263	#
				264	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	265	# - When the loadBalancingScheme for the backend service is EXTERNAL (except Network Load Balancing), INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED , the backend can be either an instance group or a NEG. The backends on the backend service must be either all instance groups or all NEGs. You cannot mix instance group and NEG backends on the same backend service.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	266	#
				267	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	268	# - When the loadBalancingScheme for the backend service is EXTERNAL for Network Load Balancing or INTERNAL for Internal TCP/UDP Load Balancing, the backend must be an instance group. NEGs are not supported.
				269	#
				270	# For regional services, the backend must be in the same region as the backend service.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	271	#
				272	# You must use the fully-qualified URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	273	"maxConnections": 42, # Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE. Not supported by:
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	274	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	275	# - Internal TCP/UDP Load Balancing - Network Load Balancing
				276	"maxConnectionsPerEndpoint": 42, # Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	277	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	278	# Not available if the backend's balancingMode is RATE. Not supported by:
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	279	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	280	# - Internal TCP/UDP Load Balancing - Network Load Balancing.
				281	"maxConnectionsPerInstance": 42, # Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	282	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	283	# Not available if the backend's balancingMode is RATE. Not supported by:
				284	#
				285	# - Internal TCP/UDP Load Balancing - Network Load Balancing.
				286	"maxRate": 42, # Defines a maximum number of HTTP requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	287	#
				288	# Not available if the backend's balancingMode is CONNECTION.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	289	"maxRatePerEndpoint": 3.14, # Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	290	#
				291	# Not available if the backend's balancingMode is CONNECTION.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	292	"maxRatePerInstance": 3.14, # Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	293	#
				294	# Not available if the backend's balancingMode is CONNECTION.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	295	"maxUtilization": 3.14,
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	296	},
				297	],
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	298	"cdnPolicy": { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. Only available for external HTTP(S) Load Balancing.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	299	"bypassCacheOnRequestHeaders": [ # Bypass the cache when the specified request headers are matched - e.g. Pragma or Authorization headers. Up to 5 headers can be specified. The cache is bypassed for all cdnPolicy.cacheMode settings.
				300	{ # Bypass the cache when the specified request headers are present, e.g. Pragma or Authorization headers. Values are case insensitive. The presence of such a header overrides the cache_mode setting.
				301	"headerName": "A String", # The header field name to match on when bypassing cache. Values are case-insensitive.
				302	},
				303	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	304	"cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cloud CDN. # The CacheKeyPolicy for this CdnPolicy.
				305	"includeHost": True or False, # If true, requests to different hosts will be cached separately.
				306	"includeProtocol": True or False, # If true, http and https requests will be cached separately.
				307	"includeQueryString": True or False, # 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.
				308	"queryStringBlacklist": [ # 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.
				309	"A String",
				310	],
				311	"queryStringWhitelist": [ # 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.
				312	"A String",
				313	],
				314	},
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	315	"cacheMode": "A String", # Specifies the cache setting for all responses from this backend. The possible values are:
				316	#
				317	# USE_ORIGIN_HEADERS Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server.
				318	#
				319	# FORCE_CACHE_ALL Cache all content, ignoring any "private", "no-store" or "no-cache" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content.
				320	#
				321	# CACHE_ALL_STATIC Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached.
				322	"clientTtl": 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is used to clamp the max-age (or Expires) value sent to the client. With FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the response max-age directive, along with a "public" directive. For cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age from the origin (if specified), or else sets the response max-age directive to the lesser of the client_ttl and default_ttl, and also ensures a "public" cache-control directive is present. If a client TTL is not specified, a default value (1 hour) will be used. The maximum allowed value is 86400s (1 day).
				323	"defaultTtl": 42, # Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age). Setting a TTL of "0" means "always revalidate". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
				324	"maxTtl": 42, # Specifies the maximum allowed TTL for cached content served by this origin. Cache directives that attempt to set a max-age or s-maxage higher than this, or an Expires header more than maxTTL seconds in the future will be capped at the value of maxTTL, as if it were the value of an s-maxage Cache-Control directive. Headers sent to the client will not be modified. Setting a TTL of "0" means "always revalidate". The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	325	"negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected Request), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy.
				326	"negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. negative_caching must be enabled to configure negative_caching_policy. Omitting the policy and leaving negative_caching enabled will use Cloud CDN's default cache TTLs. Note that when specifying an explicit negative_caching_policy, you should take care to specify a cache TTL for all response codes that you wish to cache. Cloud CDN will not apply any default negative caching when a policy exists.
				327	{ # Specify CDN TTLs for response error codes.
				328	"code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be specified as values, and you cannot specify a status code more than once.
				329	"ttl": 42, # The TTL (in seconds) for which to cache responses with the corresponding status code. The maximum allowed value is 1800s (30 minutes), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
				330	},
				331	],
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame]	332	"requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	333	"serveWhileStale": 42, # Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default "max-stale" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-max-age) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	334	"signedUrlCacheMaxAgeSec": "A String", # Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.
				335	"signedUrlKeyNames": [ # [Output Only] Names of the keys for signing request URLs.
				336	"A String",
				337	],
				338	},
yoshi-code-bot	c2cd326	2021-05-16 02:16:04 -0700	[diff] [blame]	339	"circuitBreakers": { # Settings controlling the volume of connections to a backend service.
				340	"maxConnections": 42, # Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
				341	"maxPendingRequests": 42, # Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	342	"maxRequests": 42, # The maximum number of parallel requests that allowed to the backend service. If not specified, there is no limit.
yoshi-code-bot	c2cd326	2021-05-16 02:16:04 -0700	[diff] [blame]	343	"maxRequestsPerConnection": 42, # Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
				344	"maxRetries": 42, # Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	345	},
				346	"connectionDraining": { # Message containing connection draining configuration.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	347	"drainingTimeoutSec": 42, # Configures a duration timeout for existing requests on a removed backend instance. For supported load balancers and protocols, as described in Enabling connection draining.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	348	},
				349	"consistentHash": { # This message defines settings for a consistent hash style load balancer. # Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties. This load balancing policy is applicable only for HTTP connections. The affinity to a particular destination host will be lost when one or more hosts are added/removed from the destination service. This field specifies parameters that control consistent hashing. This field is only applicable when localityLbPolicy is set to MAGLEV or RING_HASH.
				350	#
				351	# This field is applicable to either:
				352	# - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.
				353	# - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
				354	#
				355	# Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
				356	"httpCookie": { # The information about the HTTP Cookie on which the hash function is based for load balancing policies that use a consistent hash. # Hash is based on HTTP Cookie. This field describes a HTTP cookie that will be used as the hash key for the consistent hash load balancer. If the cookie is not present, it will be generated. This field is applicable if the sessionAffinity is set to HTTP_COOKIE.
				357	"name": "A String", # Name of the cookie.
				358	"path": "A String", # Path to set for the cookie.
				359	"ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie.
				360	"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
				361	"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
				362	},
				363	},
				364	"httpHeaderName": "A String", # The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.
				365	"minimumRingSize": "A String", # The minimum number of virtual nodes to use for the hash ring. Defaults to 1024. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node.
				366	},
				367	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				368	"customRequestHeaders": [ # Headers that the HTTP/S load balancer should add to proxied requests.
				369	"A String",
				370	],
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	371	"customResponseHeaders": [ # Headers that the HTTP/S load balancer should add to proxied responses.
				372	"A String",
				373	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	374	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				375	"enableCDN": True or False, # If true, enables Cloud CDN for the backend service. Only applicable if the loadBalancingScheme is EXTERNAL and the protocol is HTTP or HTTPS.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	376	"failoverPolicy": { # Applicable only to Failover for Internal TCP/UDP Load Balancing and Network Load Balancing. On failover or failback, this field indicates whether connection draining will be honored. GCP has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes). # Applicable only to Failover for Internal TCP/UDP Load Balancing and Network Load Balancing. Requires at least one backend instance group to be defined as a backup (failover) backend.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	377	"disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol is TCP.
				378	#
				379	# The default is false.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	380	"dropTrafficIfUnhealthy": True or False, # Applicable only to Failover for Internal TCP/UDP Load Balancing and Network Load Balancing, If set to true, connections to the load balancer are dropped when all primary and all backup backend VMs are unhealthy.If set to false, connections are distributed among all primary VMs when all primary and all backup backend VMs are unhealthy. The default is false.
				381	"failoverRatio": 3.14, # Applicable only to Failover for Internal TCP/UDP Load Balancing and Network Load Balancing. The value of the field must be in the range [0, 1]. If the value is 0, the load balancer performs a failover when the number of healthy primary VMs equals zero. For all other values, the load balancer performs a failover when the total number of healthy primary VMs is less than this ratio.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	382	},
				383	"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet.
				384	#
				385	# To see the latest fingerprint, make a get() request to retrieve a BackendService.
				386	"healthChecks": [ # The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently, at most one health check can be specified for each backend service. Backend services with instance group or zonal NEG backends must have a health check. Backend services with internet or serverless NEG backends must not have a health check.
				387	"A String",
				388	],
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	389	"iap": { # Identity-Aware Proxy # The configurations for Identity-Aware Proxy on this resource. Not available for Internal TCP/UDP Load Balancing and Network Load Balancing.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	390	"enabled": True or False, # Whether the serving infrastructure will authenticate and authorize all incoming requests. If true, the oauth2ClientId and oauth2ClientSecret fields must be non-empty.
				391	"oauth2ClientId": "A String", # OAuth2 client ID to use for the authentication flow.
				392	"oauth2ClientSecret": "A String", # OAuth2 client secret to use for the authentication flow. For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2ClientSecretSha256 field.
				393	"oauth2ClientSecretSha256": "A String", # [Output Only] SHA256 hash value for the field oauth2_client_secret above.
				394	},
				395	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				396	"kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	397	"loadBalancingScheme": "A String", # Specifies the load balancer type. Choose EXTERNAL for external HTTP(S), SSL Proxy, TCP Proxy and Network Load Balancing. Choose INTERNAL for Internal TCP/UDP Load Balancing. Choose INTERNAL_MANAGED for Internal HTTP(S) Load Balancing. INTERNAL_SELF_MANAGED for Traffic Director. A backend service created for one type of load balancer cannot be used with another. For more information, refer to Choosing a load balancer.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	398	"localityLbPolicy": "A String", # The load balancing algorithm used within the scope of the locality. The possible values are:
				399	# - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default.
				400	# - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests.
				401	# - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests.
				402	# - RANDOM: The load balancer selects a random healthy host.
				403	# - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer.
				404	# - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824
				405	#
				406	# This field is applicable to either:
				407	# - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.
				408	# - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
				409	#
				410	# If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect.
				411	#
				412	# Only the default ROUND_ROBIN policy is supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
				413	"logConfig": { # The available logging options for the load balancer traffic served by this backend service. # This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver.
				414	"enable": True or False, # This field denotes whether to enable logging for the load balancer traffic served by this backend service.
				415	"sampleRate": 3.14, # This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.
				416	},
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	417	"maxStreamDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the default maximum duration (timeout) for streams to this service. Duration is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed.
				418	# If not specified, there will be no timeout limit, i.e. the maximum duration is infinite.
yoshi-code-bot	c2cd326	2021-05-16 02:16:04 -0700	[diff] [blame]	419	# This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	420	# This field is only allowed when the loadBalancingScheme of the backend service is INTERNAL_SELF_MANAGED.
				421	"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
				422	"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
				423	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	424	"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	425	"network": "A String", # The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	426	"outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. If not set, this feature is considered disabled.
				427	#
				428	# This field is applicable to either:
				429	# - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.
				430	# - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
				431	#
				432	# Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
				433	"baseEjectionTime": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # The base time that a host is ejected for. The real ejection time is equal to the base ejection time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s.
				434	"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
				435	"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
				436	},
				437	"consecutiveErrors": 42, # Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.
				438	"consecutiveGatewayFailure": 42, # The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3.
				439	"enforcingConsecutiveErrors": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0.
				440	"enforcingConsecutiveGatewayFailure": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.
				441	"enforcingSuccessRate": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.
				442	"interval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Time interval between ejection analysis sweeps. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 second.
				443	"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
				444	"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
				445	},
				446	"maxEjectionPercent": 42, # Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 50%.
				447	"successRateMinimumHosts": 42, # The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5.
				448	"successRateRequestVolume": 42, # The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100.
				449	"successRateStdevFactor": 42, # This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900.
				450	},
				451	"port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
				452	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	453	# Backend services for Internal TCP/UDP Load Balancing and Network Load Balancing require you omit port.
				454	"portName": "A String", # A named port on a backend instance group representing the port for communication to the backend VMs in that group. Required when the loadBalancingScheme is EXTERNAL (except Network Load Balancing), INTERNAL_MANAGED, or INTERNAL_SELF_MANAGED and the backends are instance groups. The named port must be defined on each backend instance group. This parameter has no meaning if the backends are NEGs.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	455	#
				456	#
				457	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	458	# Backend services for Internal TCP/UDP Load Balancing and Network Load Balancing require you omit port_name.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	459	"protocol": "A String", # The protocol this BackendService uses to communicate with backends.
				460	#
				461	# Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, UDP or GRPC. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancer or for Traffic Director for more information.
				462	#
				463	# Must be set to GRPC when the backend service is referenced by a URL map that is bound to target gRPC proxy.
				464	"region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
				465	"securityPolicy": "A String", # [Output Only] The resource URL for the security policy associated with this backend service.
				466	"securitySettings": { # The authentication and authorization settings for a BackendService. # This field specifies the security policy that applies to this backend service. This field is applicable to either:
				467	# - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.
				468	# - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
				469	"clientTlsPolicy": "A String", # Optional. A URL referring to a networksecurity.ClientTlsPolicy resource that describes how clients should authenticate with this service's backends.
				470	# clientTlsPolicy only applies to a global BackendService with the loadBalancingScheme set to INTERNAL_SELF_MANAGED.
				471	# If left blank, communications are not encrypted.
				472	# Note: This field currently has no impact.
				473	"subjectAltNames": [ # Optional. A list of Subject Alternative Names (SANs) that the client verifies during a mutual TLS handshake with an server/endpoint for this BackendService. When the server presents its X.509 certificate to the client, the client inspects the certificate's subjectAltName field. If the field contains one of the specified values, the communication continues. Otherwise, it fails. This additional check enables the client to verify that the server is authorized to run the requested service.
				474	# Note that the contents of the server certificate's subjectAltName field are configured by the Public Key Infrastructure which provisions server identities.
				475	# Only applies to a global BackendService with loadBalancingScheme set to INTERNAL_SELF_MANAGED. Only applies when BackendService has an attached clientTlsPolicy with clientCertificate (mTLS mode).
				476	# Note: This field currently has no impact.
				477	"A String",
				478	],
				479	},
				480	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	481	"sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	482	#
yoshi-code-bot	8759538	2021-06-05 00:38:05 -0700	[diff] [blame]	483	# When the loadBalancingScheme is EXTERNAL:
				484	#
				485	# * For Network Load Balancing, the possible values are NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO. * For all other load balancers that use loadBalancingScheme=EXTERNAL, the possible values are NONE, CLIENT_IP, or GENERATED_COOKIE. * You can use GENERATED_COOKIE if the protocol is HTTP, HTTP2, or HTTPS.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	486	#
				487	# When the loadBalancingScheme is INTERNAL, possible values are NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
				488	#
				489	# When the loadBalancingScheme is INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED, possible values are NONE, CLIENT_IP, GENERATED_COOKIE, HEADER_FIELD, or HTTP_COOKIE.
				490	#
				491	# Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
yoshi-code-bot	c2cd326	2021-05-16 02:16:04 -0700	[diff] [blame]	492	"timeoutSec": 42, # Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	493	},
				494	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	495	"warning": { # Informational warning which replaces the list of backend services when the list is empty.
				496	"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
				497	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				498	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				499	{
				500	"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
				501	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				502	},
				503	],
				504	"message": "A String", # [Output Only] A human-readable description of the warning code.
				505	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	506	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	507	},
				508	"kind": "compute#backendServiceAggregatedList", # Type of resource.
				509	"nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
				510	"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
				511	"unreachables": [ # [Output Only] Unreachable resources.
				512	"A String",
				513	],
				514	"warning": { # [Output Only] Informational warning message.
				515	"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
				516	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				517	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				518	{
				519	"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
				520	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				521	},
				522	],
				523	"message": "A String", # [Output Only] A human-readable description of the warning code.
				524	},
				525	}</pre>
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	526	</div>
				527
				528	<div class="method">
				529	<code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
				530	<pre>Retrieves the next page of results.
				531
				532	Args:
				533	previous_request: The request for the previous page. (required)
				534	previous_response: The response from the request for the previous page. (required)
				535
				536	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	537	A request object that you can call 'execute()' on to request the next
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	538	page. Returns None if there are no more items in the collection.
				539	</pre>
				540	</div>
				541
				542	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	543	<code class="details" id="close">close()</code>
				544	<pre>Close httplib2 connections.</pre>
				545	</div>
				546
				547	<div class="method">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	548	<code class="details" id="delete">delete(project, backendService, requestId=None)</code>
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	549	<pre>Deletes the specified BackendService resource.
				550
				551	Args:
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	552	project: string, Project ID for this request. (required)
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	553	backendService: string, Name of the BackendService resource to delete. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	554	requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
				555
				556	For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
				557
				558	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	559
				560	Returns:
				561	An object of the form:
				562
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	563	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	564	#
				565	# Google Compute Engine has three Operation resources:
				566	#
				567	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				568	#
				569	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				570	#
				571	# Operations can be global, regional or zonal.
				572	# - For global operations, use the `globalOperations` resource.
				573	# - For regional operations, use the `regionOperations` resource.
				574	# - For zonal operations, use the `zonalOperations` resource.
				575	#
				576	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				577	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				578	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				579	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				580	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				581	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				582	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	583	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	584	"code": "A String", # [Output Only] The error type identifier for this error.
				585	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				586	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	587	},
				588	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	589	},
				590	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				591	"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
				592	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				593	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				594	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				595	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	596	"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	597	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				598	"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
				599	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				600	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				601	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				602	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				603	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				604	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				605	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
				606	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				607	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				608	{
				609	"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
				610	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				611	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				612	{
				613	"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
				614	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				615	},
				616	],
				617	"message": "A String", # [Output Only] A human-readable description of the warning code.
				618	},
				619	],
				620	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				621	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	622	</div>
				623
				624	<div class="method">
				625	<code class="details" id="deleteSignedUrlKey">deleteSignedUrlKey(project, backendService, keyName, requestId=None)</code>
				626	<pre>Deletes a key for validating requests with signed URLs for this backend service.
				627
				628	Args:
				629	project: string, Project ID for this request. (required)
				630	backendService: string, Name of the BackendService resource to which the Signed URL Key should be added. The name should conform to RFC1035. (required)
				631	keyName: string, The name of the Signed URL Key to delete. (required)
				632	requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
				633
				634	For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
				635
				636	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
				637
				638	Returns:
				639	An object of the form:
				640
				641	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	642	#
				643	# Google Compute Engine has three Operation resources:
				644	#
				645	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				646	#
				647	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				648	#
				649	# Operations can be global, regional or zonal.
				650	# - For global operations, use the `globalOperations` resource.
				651	# - For regional operations, use the `regionOperations` resource.
				652	# - For zonal operations, use the `zonalOperations` resource.
				653	#
				654	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				655	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				656	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				657	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				658	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				659	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				660	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	661	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	662	"code": "A String", # [Output Only] The error type identifier for this error.
				663	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				664	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	665	},
				666	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	667	},
				668	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				669	"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
				670	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				671	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				672	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				673	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	674	"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	675	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				676	"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
				677	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				678	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				679	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				680	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				681	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				682	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				683	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
				684	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				685	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				686	{
				687	"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
				688	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				689	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				690	{
				691	"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
				692	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				693	},
				694	],
				695	"message": "A String", # [Output Only] A human-readable description of the warning code.
				696	},
				697	],
				698	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				699	}</pre>
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	700	</div>
				701
				702	<div class="method">
				703	<code class="details" id="get">get(project, backendService)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	704	<pre>Returns the specified BackendService resource. Gets a list of available backend services.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	705
				706	Args:
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	707	project: string, Project ID for this request. (required)
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	708	backendService: string, Name of the BackendService resource to return. (required)
				709
				710	Returns:
				711	An object of the form:
				712
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	713	{ # Represents a Backend Service resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	714	#
				715	# A backend service defines how Google Cloud load balancers distribute traffic. The backend service configuration contains a set of values, such as the protocol used to connect to backends, various distribution and session settings, health checks, and timeouts. These settings provide fine-grained control over how your load balancer behaves. Most of the settings have default values that allow for easy configuration if you need to get started quickly.
				716	#
				717	# Backend services in Google Compute Engine can be either regionally or globally scoped.
				718	#
				719	# * [Global](/compute/docs/reference/rest/{$api_version}/backendServices) * [Regional](/compute/docs/reference/rest/{$api_version}/regionBackendServices)
				720	#
				721	# For more information, see Backend Services.
				722	#
				723	# (== resource_for {$api_version}.backendService ==)
				724	"affinityCookieTtlSec": 42, # Lifetime of cookies in seconds. Only applicable if the loadBalancingScheme is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED, the protocol is HTTP or HTTPS, and the sessionAffinity is GENERATED_COOKIE, or HTTP_COOKIE.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	725	#
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	726	# 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 is one day (86,400).
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	727	#
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	728	# Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
				729	"backends": [ # The list of backends that serve this BackendService.
				730	{ # Message containing information of one individual backend.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	731	"balancingMode": "A String", # Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode.
				732	"capacityScaler": 3.14, # A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves 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. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	733	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	734	# Not supported by:
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	735	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	736	# - Internal TCP/UDP Load Balancing - Network Load Balancing
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	737	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				738	"failover": True or False, # This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService.
				739	"group": "A String", # The fully-qualified URL of an instance group or network endpoint group (NEG) resource. The type of backend that a backend service supports depends on the backend service's loadBalancingScheme.
				740	#
				741	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	742	# - When the loadBalancingScheme for the backend service is EXTERNAL (except Network Load Balancing), INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED , the backend can be either an instance group or a NEG. The backends on the backend service must be either all instance groups or all NEGs. You cannot mix instance group and NEG backends on the same backend service.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	743	#
				744	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	745	# - When the loadBalancingScheme for the backend service is EXTERNAL for Network Load Balancing or INTERNAL for Internal TCP/UDP Load Balancing, the backend must be an instance group. NEGs are not supported.
				746	#
				747	# For regional services, the backend must be in the same region as the backend service.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	748	#
				749	# You must use the fully-qualified URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	750	"maxConnections": 42, # Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE. Not supported by:
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	751	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	752	# - Internal TCP/UDP Load Balancing - Network Load Balancing
				753	"maxConnectionsPerEndpoint": 42, # Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	754	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	755	# Not available if the backend's balancingMode is RATE. Not supported by:
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	756	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	757	# - Internal TCP/UDP Load Balancing - Network Load Balancing.
				758	"maxConnectionsPerInstance": 42, # Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	759	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	760	# Not available if the backend's balancingMode is RATE. Not supported by:
				761	#
				762	# - Internal TCP/UDP Load Balancing - Network Load Balancing.
				763	"maxRate": 42, # Defines a maximum number of HTTP requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	764	#
				765	# Not available if the backend's balancingMode is CONNECTION.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	766	"maxRatePerEndpoint": 3.14, # Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	767	#
				768	# Not available if the backend's balancingMode is CONNECTION.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	769	"maxRatePerInstance": 3.14, # Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	770	#
				771	# Not available if the backend's balancingMode is CONNECTION.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	772	"maxUtilization": 3.14,
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	773	},
				774	],
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	775	"cdnPolicy": { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. Only available for external HTTP(S) Load Balancing.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	776	"bypassCacheOnRequestHeaders": [ # Bypass the cache when the specified request headers are matched - e.g. Pragma or Authorization headers. Up to 5 headers can be specified. The cache is bypassed for all cdnPolicy.cacheMode settings.
				777	{ # Bypass the cache when the specified request headers are present, e.g. Pragma or Authorization headers. Values are case insensitive. The presence of such a header overrides the cache_mode setting.
				778	"headerName": "A String", # The header field name to match on when bypassing cache. Values are case-insensitive.
				779	},
				780	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	781	"cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cloud CDN. # The CacheKeyPolicy for this CdnPolicy.
				782	"includeHost": True or False, # If true, requests to different hosts will be cached separately.
				783	"includeProtocol": True or False, # If true, http and https requests will be cached separately.
				784	"includeQueryString": True or False, # 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.
				785	"queryStringBlacklist": [ # 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.
				786	"A String",
				787	],
				788	"queryStringWhitelist": [ # 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.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	789	"A String",
				790	],
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	791	},
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	792	"cacheMode": "A String", # Specifies the cache setting for all responses from this backend. The possible values are:
				793	#
				794	# USE_ORIGIN_HEADERS Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server.
				795	#
				796	# FORCE_CACHE_ALL Cache all content, ignoring any "private", "no-store" or "no-cache" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content.
				797	#
				798	# CACHE_ALL_STATIC Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached.
				799	"clientTtl": 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is used to clamp the max-age (or Expires) value sent to the client. With FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the response max-age directive, along with a "public" directive. For cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age from the origin (if specified), or else sets the response max-age directive to the lesser of the client_ttl and default_ttl, and also ensures a "public" cache-control directive is present. If a client TTL is not specified, a default value (1 hour) will be used. The maximum allowed value is 86400s (1 day).
				800	"defaultTtl": 42, # Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age). Setting a TTL of "0" means "always revalidate". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
				801	"maxTtl": 42, # Specifies the maximum allowed TTL for cached content served by this origin. Cache directives that attempt to set a max-age or s-maxage higher than this, or an Expires header more than maxTTL seconds in the future will be capped at the value of maxTTL, as if it were the value of an s-maxage Cache-Control directive. Headers sent to the client will not be modified. Setting a TTL of "0" means "always revalidate". The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	802	"negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected Request), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy.
				803	"negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. negative_caching must be enabled to configure negative_caching_policy. Omitting the policy and leaving negative_caching enabled will use Cloud CDN's default cache TTLs. Note that when specifying an explicit negative_caching_policy, you should take care to specify a cache TTL for all response codes that you wish to cache. Cloud CDN will not apply any default negative caching when a policy exists.
				804	{ # Specify CDN TTLs for response error codes.
				805	"code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be specified as values, and you cannot specify a status code more than once.
				806	"ttl": 42, # The TTL (in seconds) for which to cache responses with the corresponding status code. The maximum allowed value is 1800s (30 minutes), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
				807	},
				808	],
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame]	809	"requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	810	"serveWhileStale": 42, # Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default "max-stale" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-max-age) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	811	"signedUrlCacheMaxAgeSec": "A String", # Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.
				812	"signedUrlKeyNames": [ # [Output Only] Names of the keys for signing request URLs.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	813	"A String",
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	814	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	815	},
yoshi-code-bot	c2cd326	2021-05-16 02:16:04 -0700	[diff] [blame]	816	"circuitBreakers": { # Settings controlling the volume of connections to a backend service.
				817	"maxConnections": 42, # Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
				818	"maxPendingRequests": 42, # Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	819	"maxRequests": 42, # The maximum number of parallel requests that allowed to the backend service. If not specified, there is no limit.
yoshi-code-bot	c2cd326	2021-05-16 02:16:04 -0700	[diff] [blame]	820	"maxRequestsPerConnection": 42, # Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
				821	"maxRetries": 42, # Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	822	},
				823	"connectionDraining": { # Message containing connection draining configuration.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	824	"drainingTimeoutSec": 42, # Configures a duration timeout for existing requests on a removed backend instance. For supported load balancers and protocols, as described in Enabling connection draining.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	825	},
				826	"consistentHash": { # This message defines settings for a consistent hash style load balancer. # Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties. This load balancing policy is applicable only for HTTP connections. The affinity to a particular destination host will be lost when one or more hosts are added/removed from the destination service. This field specifies parameters that control consistent hashing. This field is only applicable when localityLbPolicy is set to MAGLEV or RING_HASH.
				827	#
				828	# This field is applicable to either:
				829	# - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.
				830	# - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
				831	#
				832	# Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
				833	"httpCookie": { # The information about the HTTP Cookie on which the hash function is based for load balancing policies that use a consistent hash. # Hash is based on HTTP Cookie. This field describes a HTTP cookie that will be used as the hash key for the consistent hash load balancer. If the cookie is not present, it will be generated. This field is applicable if the sessionAffinity is set to HTTP_COOKIE.
				834	"name": "A String", # Name of the cookie.
				835	"path": "A String", # Path to set for the cookie.
				836	"ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	837	"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
				838	"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
				839	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	840	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	841	"httpHeaderName": "A String", # The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.
				842	"minimumRingSize": "A String", # The minimum number of virtual nodes to use for the hash ring. Defaults to 1024. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node.
				843	},
				844	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				845	"customRequestHeaders": [ # Headers that the HTTP/S load balancer should add to proxied requests.
				846	"A String",
				847	],
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	848	"customResponseHeaders": [ # Headers that the HTTP/S load balancer should add to proxied responses.
				849	"A String",
				850	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	851	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				852	"enableCDN": True or False, # If true, enables Cloud CDN for the backend service. Only applicable if the loadBalancingScheme is EXTERNAL and the protocol is HTTP or HTTPS.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	853	"failoverPolicy": { # Applicable only to Failover for Internal TCP/UDP Load Balancing and Network Load Balancing. On failover or failback, this field indicates whether connection draining will be honored. GCP has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes). # Applicable only to Failover for Internal TCP/UDP Load Balancing and Network Load Balancing. Requires at least one backend instance group to be defined as a backup (failover) backend.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	854	"disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol is TCP.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	855	#
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	856	# The default is false.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	857	"dropTrafficIfUnhealthy": True or False, # Applicable only to Failover for Internal TCP/UDP Load Balancing and Network Load Balancing, If set to true, connections to the load balancer are dropped when all primary and all backup backend VMs are unhealthy.If set to false, connections are distributed among all primary VMs when all primary and all backup backend VMs are unhealthy. The default is false.
				858	"failoverRatio": 3.14, # Applicable only to Failover for Internal TCP/UDP Load Balancing and Network Load Balancing. The value of the field must be in the range [0, 1]. If the value is 0, the load balancer performs a failover when the number of healthy primary VMs equals zero. For all other values, the load balancer performs a failover when the total number of healthy primary VMs is less than this ratio.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	859	},
				860	"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet.
				861	#
				862	# To see the latest fingerprint, make a get() request to retrieve a BackendService.
				863	"healthChecks": [ # The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently, at most one health check can be specified for each backend service. Backend services with instance group or zonal NEG backends must have a health check. Backend services with internet or serverless NEG backends must not have a health check.
				864	"A String",
				865	],
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	866	"iap": { # Identity-Aware Proxy # The configurations for Identity-Aware Proxy on this resource. Not available for Internal TCP/UDP Load Balancing and Network Load Balancing.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	867	"enabled": True or False, # Whether the serving infrastructure will authenticate and authorize all incoming requests. If true, the oauth2ClientId and oauth2ClientSecret fields must be non-empty.
				868	"oauth2ClientId": "A String", # OAuth2 client ID to use for the authentication flow.
				869	"oauth2ClientSecret": "A String", # OAuth2 client secret to use for the authentication flow. For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2ClientSecretSha256 field.
				870	"oauth2ClientSecretSha256": "A String", # [Output Only] SHA256 hash value for the field oauth2_client_secret above.
				871	},
				872	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				873	"kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	874	"loadBalancingScheme": "A String", # Specifies the load balancer type. Choose EXTERNAL for external HTTP(S), SSL Proxy, TCP Proxy and Network Load Balancing. Choose INTERNAL for Internal TCP/UDP Load Balancing. Choose INTERNAL_MANAGED for Internal HTTP(S) Load Balancing. INTERNAL_SELF_MANAGED for Traffic Director. A backend service created for one type of load balancer cannot be used with another. For more information, refer to Choosing a load balancer.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	875	"localityLbPolicy": "A String", # The load balancing algorithm used within the scope of the locality. The possible values are:
				876	# - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default.
				877	# - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests.
				878	# - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests.
				879	# - RANDOM: The load balancer selects a random healthy host.
				880	# - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer.
				881	# - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824
				882	#
				883	# This field is applicable to either:
				884	# - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.
				885	# - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
				886	#
				887	# If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect.
				888	#
				889	# Only the default ROUND_ROBIN policy is supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
				890	"logConfig": { # The available logging options for the load balancer traffic served by this backend service. # This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver.
				891	"enable": True or False, # This field denotes whether to enable logging for the load balancer traffic served by this backend service.
				892	"sampleRate": 3.14, # This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.
				893	},
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	894	"maxStreamDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the default maximum duration (timeout) for streams to this service. Duration is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed.
				895	# If not specified, there will be no timeout limit, i.e. the maximum duration is infinite.
yoshi-code-bot	c2cd326	2021-05-16 02:16:04 -0700	[diff] [blame]	896	# This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	897	# This field is only allowed when the loadBalancingScheme of the backend service is INTERNAL_SELF_MANAGED.
				898	"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
				899	"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
				900	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	901	"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	902	"network": "A String", # The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	903	"outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. If not set, this feature is considered disabled.
				904	#
				905	# This field is applicable to either:
				906	# - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.
				907	# - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
				908	#
				909	# Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
				910	"baseEjectionTime": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # The base time that a host is ejected for. The real ejection time is equal to the base ejection time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s.
				911	"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
				912	"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	913	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	914	"consecutiveErrors": 42, # Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.
				915	"consecutiveGatewayFailure": 42, # The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3.
				916	"enforcingConsecutiveErrors": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0.
				917	"enforcingConsecutiveGatewayFailure": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.
				918	"enforcingSuccessRate": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.
				919	"interval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Time interval between ejection analysis sweeps. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 second.
				920	"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
				921	"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
				922	},
				923	"maxEjectionPercent": 42, # Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 50%.
				924	"successRateMinimumHosts": 42, # The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5.
				925	"successRateRequestVolume": 42, # The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100.
				926	"successRateStdevFactor": 42, # This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900.
				927	},
				928	"port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
				929	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	930	# Backend services for Internal TCP/UDP Load Balancing and Network Load Balancing require you omit port.
				931	"portName": "A String", # A named port on a backend instance group representing the port for communication to the backend VMs in that group. Required when the loadBalancingScheme is EXTERNAL (except Network Load Balancing), INTERNAL_MANAGED, or INTERNAL_SELF_MANAGED and the backends are instance groups. The named port must be defined on each backend instance group. This parameter has no meaning if the backends are NEGs.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	932	#
				933	#
				934	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	935	# Backend services for Internal TCP/UDP Load Balancing and Network Load Balancing require you omit port_name.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	936	"protocol": "A String", # The protocol this BackendService uses to communicate with backends.
				937	#
				938	# Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, UDP or GRPC. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancer or for Traffic Director for more information.
				939	#
				940	# Must be set to GRPC when the backend service is referenced by a URL map that is bound to target gRPC proxy.
				941	"region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
				942	"securityPolicy": "A String", # [Output Only] The resource URL for the security policy associated with this backend service.
				943	"securitySettings": { # The authentication and authorization settings for a BackendService. # This field specifies the security policy that applies to this backend service. This field is applicable to either:
				944	# - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.
				945	# - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
				946	"clientTlsPolicy": "A String", # Optional. A URL referring to a networksecurity.ClientTlsPolicy resource that describes how clients should authenticate with this service's backends.
				947	# clientTlsPolicy only applies to a global BackendService with the loadBalancingScheme set to INTERNAL_SELF_MANAGED.
				948	# If left blank, communications are not encrypted.
				949	# Note: This field currently has no impact.
				950	"subjectAltNames": [ # Optional. A list of Subject Alternative Names (SANs) that the client verifies during a mutual TLS handshake with an server/endpoint for this BackendService. When the server presents its X.509 certificate to the client, the client inspects the certificate's subjectAltName field. If the field contains one of the specified values, the communication continues. Otherwise, it fails. This additional check enables the client to verify that the server is authorized to run the requested service.
				951	# Note that the contents of the server certificate's subjectAltName field are configured by the Public Key Infrastructure which provisions server identities.
				952	# Only applies to a global BackendService with loadBalancingScheme set to INTERNAL_SELF_MANAGED. Only applies when BackendService has an attached clientTlsPolicy with clientCertificate (mTLS mode).
				953	# Note: This field currently has no impact.
				954	"A String",
				955	],
				956	},
				957	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	958	"sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	959	#
yoshi-code-bot	8759538	2021-06-05 00:38:05 -0700	[diff] [blame]	960	# When the loadBalancingScheme is EXTERNAL:
				961	#
				962	# * For Network Load Balancing, the possible values are NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO. * For all other load balancers that use loadBalancingScheme=EXTERNAL, the possible values are NONE, CLIENT_IP, or GENERATED_COOKIE. * You can use GENERATED_COOKIE if the protocol is HTTP, HTTP2, or HTTPS.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	963	#
				964	# When the loadBalancingScheme is INTERNAL, possible values are NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
				965	#
				966	# When the loadBalancingScheme is INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED, possible values are NONE, CLIENT_IP, GENERATED_COOKIE, HEADER_FIELD, or HTTP_COOKIE.
				967	#
				968	# Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
yoshi-code-bot	c2cd326	2021-05-16 02:16:04 -0700	[diff] [blame]	969	"timeoutSec": 42, # Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	970	}</pre>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	971	</div>
				972
				973	<div class="method">
				974	<code class="details" id="getHealth">getHealth(project, backendService, body=None)</code>
				975	<pre>Gets the most recent health check results for this BackendService.
				976
				977	Example request body:
				978
				979	{ "group": "/zones/us-east1-b/instanceGroups/lb-backend-example" }
				980
				981	Args:
				982	project: string, A parameter (required)
				983	backendService: string, Name of the BackendService resource to which the queried instance belongs. (required)
				984	body: object, The request body.
				985	The object takes the form of:
				986
				987	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	988	"group": "A String", # A URI referencing one of the instance groups or network endpoint groups listed in the backend service.
				989	}
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	990
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	991
				992	Returns:
				993	An object of the form:
				994
				995	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	996	"annotations": { # Metadata defined as annotations on the network endpoint group.
				997	"a_key": "A String",
				998	},
				999	"healthStatus": [ # Health state of the backend instances or endpoints in requested instance or network endpoint group, determined based on configured health checks.
				1000	{
				1001	"annotations": { # Metadata defined as annotations for network endpoint.
				1002	"a_key": "A String",
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1003	},
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame]	1004	"forwardingRule": "A String", # URL of the forwarding rule associated with the health status of the instance.
				1005	"forwardingRuleIp": "A String", # A forwarding rule IP address assigned to this instance.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1006	"healthState": "A String", # Health state of the instance.
				1007	"instance": "A String", # URL of the instance resource.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1008	"ipAddress": "A String", # For target pool based Network Load Balancing, it indicates the forwarding rule's IP address assigned to this instance. For other types of load balancing, the field indicates VM internal ip.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1009	"port": 42, # The named port of the instance group, not necessarily the port that is health-checked.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1010	"weight": "A String",
				1011	"weightError": "A String",
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1012	},
				1013	],
				1014	"kind": "compute#backendServiceGroupHealth", # [Output Only] Type of resource. Always compute#backendServiceGroupHealth for the health of backend services.
				1015	}</pre>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1016	</div>
				1017
				1018	<div class="method">
				1019	<code class="details" id="insert">insert(project, body=None, requestId=None)</code>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	1020	<pre>Creates a BackendService resource in the specified project using the data included in the request. For more information, see Backend services overview.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1021
				1022	Args:
				1023	project: string, Project ID for this request. (required)
				1024	body: object, The request body.
				1025	The object takes the form of:
				1026
				1027	{ # Represents a Backend Service resource.
				1028	#
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	1029	# A backend service defines how Google Cloud load balancers distribute traffic. The backend service configuration contains a set of values, such as the protocol used to connect to backends, various distribution and session settings, health checks, and timeouts. These settings provide fine-grained control over how your load balancer behaves. Most of the settings have default values that allow for easy configuration if you need to get started quickly.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1030	#
				1031	# Backend services in Google Compute Engine can be either regionally or globally scoped.
				1032	#
				1033	# * [Global](/compute/docs/reference/rest/{$api_version}/backendServices) * [Regional](/compute/docs/reference/rest/{$api_version}/regionBackendServices)
				1034	#
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	1035	# For more information, see Backend Services.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1036	#
				1037	# (== resource_for {$api_version}.backendService ==)
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	1038	"affinityCookieTtlSec": 42, # Lifetime of cookies in seconds. Only applicable if the loadBalancingScheme is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED, the protocol is HTTP or HTTPS, and the sessionAffinity is GENERATED_COOKIE, or HTTP_COOKIE.
				1039	#
				1040	# 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 is one day (86,400).
				1041	#
				1042	# Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1043	"backends": [ # The list of backends that serve this BackendService.
				1044	{ # Message containing information of one individual backend.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1045	"balancingMode": "A String", # Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode.
				1046	"capacityScaler": 3.14, # A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves 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. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1047	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1048	# Not supported by:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1049	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1050	# - Internal TCP/UDP Load Balancing - Network Load Balancing
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1051	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				1052	"failover": True or False, # This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService.
				1053	"group": "A String", # The fully-qualified URL of an instance group or network endpoint group (NEG) resource. The type of backend that a backend service supports depends on the backend service's loadBalancingScheme.
				1054	#
				1055	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1056	# - When the loadBalancingScheme for the backend service is EXTERNAL (except Network Load Balancing), INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED , the backend can be either an instance group or a NEG. The backends on the backend service must be either all instance groups or all NEGs. You cannot mix instance group and NEG backends on the same backend service.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1057	#
				1058	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1059	# - When the loadBalancingScheme for the backend service is EXTERNAL for Network Load Balancing or INTERNAL for Internal TCP/UDP Load Balancing, the backend must be an instance group. NEGs are not supported.
				1060	#
				1061	# For regional services, the backend must be in the same region as the backend service.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1062	#
				1063	# You must use the fully-qualified URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1064	"maxConnections": 42, # Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE. Not supported by:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1065	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1066	# - Internal TCP/UDP Load Balancing - Network Load Balancing
				1067	"maxConnectionsPerEndpoint": 42, # Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1068	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1069	# Not available if the backend's balancingMode is RATE. Not supported by:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1070	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1071	# - Internal TCP/UDP Load Balancing - Network Load Balancing.
				1072	"maxConnectionsPerInstance": 42, # Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1073	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1074	# Not available if the backend's balancingMode is RATE. Not supported by:
				1075	#
				1076	# - Internal TCP/UDP Load Balancing - Network Load Balancing.
				1077	"maxRate": 42, # Defines a maximum number of HTTP requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1078	#
				1079	# Not available if the backend's balancingMode is CONNECTION.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1080	"maxRatePerEndpoint": 3.14, # Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1081	#
				1082	# Not available if the backend's balancingMode is CONNECTION.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1083	"maxRatePerInstance": 3.14, # Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1084	#
				1085	# Not available if the backend's balancingMode is CONNECTION.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1086	"maxUtilization": 3.14,
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1087	},
				1088	],
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1089	"cdnPolicy": { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. Only available for external HTTP(S) Load Balancing.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	1090	"bypassCacheOnRequestHeaders": [ # Bypass the cache when the specified request headers are matched - e.g. Pragma or Authorization headers. Up to 5 headers can be specified. The cache is bypassed for all cdnPolicy.cacheMode settings.
				1091	{ # Bypass the cache when the specified request headers are present, e.g. Pragma or Authorization headers. Values are case insensitive. The presence of such a header overrides the cache_mode setting.
				1092	"headerName": "A String", # The header field name to match on when bypassing cache. Values are case-insensitive.
				1093	},
				1094	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1095	"cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cloud CDN. # The CacheKeyPolicy for this CdnPolicy.
				1096	"includeHost": True or False, # If true, requests to different hosts will be cached separately.
				1097	"includeProtocol": True or False, # If true, http and https requests will be cached separately.
				1098	"includeQueryString": True or False, # 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.
				1099	"queryStringBlacklist": [ # 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.
				1100	"A String",
				1101	],
				1102	"queryStringWhitelist": [ # 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.
				1103	"A String",
				1104	],
				1105	},
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1106	"cacheMode": "A String", # Specifies the cache setting for all responses from this backend. The possible values are:
				1107	#
				1108	# USE_ORIGIN_HEADERS Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server.
				1109	#
				1110	# FORCE_CACHE_ALL Cache all content, ignoring any "private", "no-store" or "no-cache" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content.
				1111	#
				1112	# CACHE_ALL_STATIC Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached.
				1113	"clientTtl": 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is used to clamp the max-age (or Expires) value sent to the client. With FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the response max-age directive, along with a "public" directive. For cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age from the origin (if specified), or else sets the response max-age directive to the lesser of the client_ttl and default_ttl, and also ensures a "public" cache-control directive is present. If a client TTL is not specified, a default value (1 hour) will be used. The maximum allowed value is 86400s (1 day).
				1114	"defaultTtl": 42, # Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age). Setting a TTL of "0" means "always revalidate". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
				1115	"maxTtl": 42, # Specifies the maximum allowed TTL for cached content served by this origin. Cache directives that attempt to set a max-age or s-maxage higher than this, or an Expires header more than maxTTL seconds in the future will be capped at the value of maxTTL, as if it were the value of an s-maxage Cache-Control directive. Headers sent to the client will not be modified. Setting a TTL of "0" means "always revalidate". The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	1116	"negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected Request), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy.
				1117	"negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. negative_caching must be enabled to configure negative_caching_policy. Omitting the policy and leaving negative_caching enabled will use Cloud CDN's default cache TTLs. Note that when specifying an explicit negative_caching_policy, you should take care to specify a cache TTL for all response codes that you wish to cache. Cloud CDN will not apply any default negative caching when a policy exists.
				1118	{ # Specify CDN TTLs for response error codes.
				1119	"code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be specified as values, and you cannot specify a status code more than once.
				1120	"ttl": 42, # The TTL (in seconds) for which to cache responses with the corresponding status code. The maximum allowed value is 1800s (30 minutes), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
				1121	},
				1122	],
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame]	1123	"requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	1124	"serveWhileStale": 42, # Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default "max-stale" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-max-age) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1125	"signedUrlCacheMaxAgeSec": "A String", # Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.
				1126	"signedUrlKeyNames": [ # [Output Only] Names of the keys for signing request URLs.
				1127	"A String",
				1128	],
				1129	},
yoshi-code-bot	c2cd326	2021-05-16 02:16:04 -0700	[diff] [blame]	1130	"circuitBreakers": { # Settings controlling the volume of connections to a backend service.
				1131	"maxConnections": 42, # Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
				1132	"maxPendingRequests": 42, # Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1133	"maxRequests": 42, # The maximum number of parallel requests that allowed to the backend service. If not specified, there is no limit.
yoshi-code-bot	c2cd326	2021-05-16 02:16:04 -0700	[diff] [blame]	1134	"maxRequestsPerConnection": 42, # Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
				1135	"maxRetries": 42, # Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1136	},
				1137	"connectionDraining": { # Message containing connection draining configuration.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1138	"drainingTimeoutSec": 42, # Configures a duration timeout for existing requests on a removed backend instance. For supported load balancers and protocols, as described in Enabling connection draining.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1139	},
				1140	"consistentHash": { # This message defines settings for a consistent hash style load balancer. # Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties. This load balancing policy is applicable only for HTTP connections. The affinity to a particular destination host will be lost when one or more hosts are added/removed from the destination service. This field specifies parameters that control consistent hashing. This field is only applicable when localityLbPolicy is set to MAGLEV or RING_HASH.
				1141	#
				1142	# This field is applicable to either:
				1143	# - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.
				1144	# - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	1145	#
				1146	# Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1147	"httpCookie": { # The information about the HTTP Cookie on which the hash function is based for load balancing policies that use a consistent hash. # Hash is based on HTTP Cookie. This field describes a HTTP cookie that will be used as the hash key for the consistent hash load balancer. If the cookie is not present, it will be generated. This field is applicable if the sessionAffinity is set to HTTP_COOKIE.
				1148	"name": "A String", # Name of the cookie.
				1149	"path": "A String", # Path to set for the cookie.
				1150	"ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie.
				1151	"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
				1152	"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
				1153	},
				1154	},
				1155	"httpHeaderName": "A String", # The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.
				1156	"minimumRingSize": "A String", # The minimum number of virtual nodes to use for the hash ring. Defaults to 1024. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node.
				1157	},
				1158	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				1159	"customRequestHeaders": [ # Headers that the HTTP/S load balancer should add to proxied requests.
				1160	"A String",
				1161	],
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1162	"customResponseHeaders": [ # Headers that the HTTP/S load balancer should add to proxied responses.
				1163	"A String",
				1164	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1165	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				1166	"enableCDN": True or False, # If true, enables Cloud CDN for the backend service. Only applicable if the loadBalancingScheme is EXTERNAL and the protocol is HTTP or HTTPS.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1167	"failoverPolicy": { # Applicable only to Failover for Internal TCP/UDP Load Balancing and Network Load Balancing. On failover or failback, this field indicates whether connection draining will be honored. GCP has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes). # Applicable only to Failover for Internal TCP/UDP Load Balancing and Network Load Balancing. Requires at least one backend instance group to be defined as a backup (failover) backend.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1168	"disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol is TCP.
				1169	#
				1170	# The default is false.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1171	"dropTrafficIfUnhealthy": True or False, # Applicable only to Failover for Internal TCP/UDP Load Balancing and Network Load Balancing, If set to true, connections to the load balancer are dropped when all primary and all backup backend VMs are unhealthy.If set to false, connections are distributed among all primary VMs when all primary and all backup backend VMs are unhealthy. The default is false.
				1172	"failoverRatio": 3.14, # Applicable only to Failover for Internal TCP/UDP Load Balancing and Network Load Balancing. The value of the field must be in the range [0, 1]. If the value is 0, the load balancer performs a failover when the number of healthy primary VMs equals zero. For all other values, the load balancer performs a failover when the total number of healthy primary VMs is less than this ratio.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1173	},
				1174	"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet.
				1175	#
				1176	# To see the latest fingerprint, make a get() request to retrieve a BackendService.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	1177	"healthChecks": [ # The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently, at most one health check can be specified for each backend service. Backend services with instance group or zonal NEG backends must have a health check. Backend services with internet or serverless NEG backends must not have a health check.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1178	"A String",
				1179	],
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1180	"iap": { # Identity-Aware Proxy # The configurations for Identity-Aware Proxy on this resource. Not available for Internal TCP/UDP Load Balancing and Network Load Balancing.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	1181	"enabled": True or False, # Whether the serving infrastructure will authenticate and authorize all incoming requests. If true, the oauth2ClientId and oauth2ClientSecret fields must be non-empty.
				1182	"oauth2ClientId": "A String", # OAuth2 client ID to use for the authentication flow.
				1183	"oauth2ClientSecret": "A String", # OAuth2 client secret to use for the authentication flow. For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2ClientSecretSha256 field.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1184	"oauth2ClientSecretSha256": "A String", # [Output Only] SHA256 hash value for the field oauth2_client_secret above.
				1185	},
				1186	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				1187	"kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1188	"loadBalancingScheme": "A String", # Specifies the load balancer type. Choose EXTERNAL for external HTTP(S), SSL Proxy, TCP Proxy and Network Load Balancing. Choose INTERNAL for Internal TCP/UDP Load Balancing. Choose INTERNAL_MANAGED for Internal HTTP(S) Load Balancing. INTERNAL_SELF_MANAGED for Traffic Director. A backend service created for one type of load balancer cannot be used with another. For more information, refer to Choosing a load balancer.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1189	"localityLbPolicy": "A String", # The load balancing algorithm used within the scope of the locality. The possible values are:
				1190	# - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default.
				1191	# - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests.
				1192	# - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests.
				1193	# - RANDOM: The load balancer selects a random healthy host.
				1194	# - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	1195	# - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1196	#
				1197	# This field is applicable to either:
				1198	# - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.
				1199	# - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
				1200	#
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	1201	# If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect.
				1202	#
				1203	# Only the default ROUND_ROBIN policy is supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1204	"logConfig": { # The available logging options for the load balancer traffic served by this backend service. # This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver.
				1205	"enable": True or False, # This field denotes whether to enable logging for the load balancer traffic served by this backend service.
				1206	"sampleRate": 3.14, # This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.
				1207	},
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	1208	"maxStreamDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the default maximum duration (timeout) for streams to this service. Duration is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed.
				1209	# If not specified, there will be no timeout limit, i.e. the maximum duration is infinite.
yoshi-code-bot	c2cd326	2021-05-16 02:16:04 -0700	[diff] [blame]	1210	# This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	1211	# This field is only allowed when the loadBalancingScheme of the backend service is INTERNAL_SELF_MANAGED.
				1212	"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
				1213	"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
				1214	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1215	"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1216	"network": "A String", # The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1217	"outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. If not set, this feature is considered disabled.
				1218	#
				1219	# This field is applicable to either:
				1220	# - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.
				1221	# - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	1222	#
				1223	# Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1224	"baseEjectionTime": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # The base time that a host is ejected for. The real ejection time is equal to the base ejection time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s.
				1225	"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
				1226	"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
				1227	},
				1228	"consecutiveErrors": 42, # Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.
				1229	"consecutiveGatewayFailure": 42, # The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3.
				1230	"enforcingConsecutiveErrors": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0.
				1231	"enforcingConsecutiveGatewayFailure": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.
				1232	"enforcingSuccessRate": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.
				1233	"interval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Time interval between ejection analysis sweeps. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 second.
				1234	"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
				1235	"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
				1236	},
				1237	"maxEjectionPercent": 42, # Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 50%.
				1238	"successRateMinimumHosts": 42, # The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5.
				1239	"successRateRequestVolume": 42, # The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100.
				1240	"successRateStdevFactor": 42, # This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900.
				1241	},
				1242	"port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
				1243	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1244	# Backend services for Internal TCP/UDP Load Balancing and Network Load Balancing require you omit port.
				1245	"portName": "A String", # A named port on a backend instance group representing the port for communication to the backend VMs in that group. Required when the loadBalancingScheme is EXTERNAL (except Network Load Balancing), INTERNAL_MANAGED, or INTERNAL_SELF_MANAGED and the backends are instance groups. The named port must be defined on each backend instance group. This parameter has no meaning if the backends are NEGs.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1246	#
				1247	#
				1248	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1249	# Backend services for Internal TCP/UDP Load Balancing and Network Load Balancing require you omit port_name.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1250	"protocol": "A String", # The protocol this BackendService uses to communicate with backends.
				1251	#
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	1252	# Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, UDP or GRPC. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancer or for Traffic Director for more information.
				1253	#
				1254	# Must be set to GRPC when the backend service is referenced by a URL map that is bound to target gRPC proxy.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1255	"region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
				1256	"securityPolicy": "A String", # [Output Only] The resource URL for the security policy associated with this backend service.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	1257	"securitySettings": { # The authentication and authorization settings for a BackendService. # This field specifies the security policy that applies to this backend service. This field is applicable to either:
				1258	# - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.
				1259	# - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
				1260	"clientTlsPolicy": "A String", # Optional. A URL referring to a networksecurity.ClientTlsPolicy resource that describes how clients should authenticate with this service's backends.
				1261	# clientTlsPolicy only applies to a global BackendService with the loadBalancingScheme set to INTERNAL_SELF_MANAGED.
				1262	# If left blank, communications are not encrypted.
				1263	# Note: This field currently has no impact.
				1264	"subjectAltNames": [ # Optional. A list of Subject Alternative Names (SANs) that the client verifies during a mutual TLS handshake with an server/endpoint for this BackendService. When the server presents its X.509 certificate to the client, the client inspects the certificate's subjectAltName field. If the field contains one of the specified values, the communication continues. Otherwise, it fails. This additional check enables the client to verify that the server is authorized to run the requested service.
				1265	# Note that the contents of the server certificate's subjectAltName field are configured by the Public Key Infrastructure which provisions server identities.
				1266	# Only applies to a global BackendService with loadBalancingScheme set to INTERNAL_SELF_MANAGED. Only applies when BackendService has an attached clientTlsPolicy with clientCertificate (mTLS mode).
				1267	# Note: This field currently has no impact.
				1268	"A String",
				1269	],
				1270	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1271	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1272	"sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1273	#
yoshi-code-bot	8759538	2021-06-05 00:38:05 -0700	[diff] [blame]	1274	# When the loadBalancingScheme is EXTERNAL:
				1275	#
				1276	# * For Network Load Balancing, the possible values are NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO. * For all other load balancers that use loadBalancingScheme=EXTERNAL, the possible values are NONE, CLIENT_IP, or GENERATED_COOKIE. * You can use GENERATED_COOKIE if the protocol is HTTP, HTTP2, or HTTPS.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1277	#
				1278	# When the loadBalancingScheme is INTERNAL, possible values are NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
				1279	#
				1280	# When the loadBalancingScheme is INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED, possible values are NONE, CLIENT_IP, GENERATED_COOKIE, HEADER_FIELD, or HTTP_COOKIE.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	1281	#
				1282	# Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
yoshi-code-bot	c2cd326	2021-05-16 02:16:04 -0700	[diff] [blame]	1283	"timeoutSec": 42, # Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1284	}
				1285
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	1286	requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
				1287
				1288	For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
				1289
				1290	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	1291
				1292	Returns:
				1293	An object of the form:
				1294
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	1295	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1296	#
				1297	# Google Compute Engine has three Operation resources:
				1298	#
				1299	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				1300	#
				1301	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				1302	#
				1303	# Operations can be global, regional or zonal.
				1304	# - For global operations, use the `globalOperations` resource.
				1305	# - For regional operations, use the `regionOperations` resource.
				1306	# - For zonal operations, use the `zonalOperations` resource.
				1307	#
				1308	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				1309	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				1310	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				1311	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				1312	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				1313	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				1314	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1315	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1316	"code": "A String", # [Output Only] The error type identifier for this error.
				1317	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				1318	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1319	},
				1320	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1321	},
				1322	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				1323	"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
				1324	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				1325	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				1326	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				1327	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1328	"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1329	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				1330	"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
				1331	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				1332	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				1333	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				1334	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				1335	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				1336	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				1337	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
				1338	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				1339	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				1340	{
				1341	"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
				1342	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				1343	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				1344	{
				1345	"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
				1346	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				1347	},
				1348	],
				1349	"message": "A String", # [Output Only] A human-readable description of the warning code.
				1350	},
				1351	],
				1352	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				1353	}</pre>
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	1354	</div>
				1355
				1356	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	1357	<code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	1358	<pre>Retrieves the list of BackendService resources available to the specified project.
				1359
				1360	Args:
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1361	project: string, Project ID for this request. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1362	filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	1363
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1364	For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	1365
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1366	You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1367
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1368	To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```
				1369	maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
				1370	orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
				1371
				1372	You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
				1373
				1374	Currently, only sorting by `name` or `creationTimestamp desc` is supported.
				1375	pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1376	returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	1377
				1378	Returns:
				1379	An object of the form:
				1380
				1381	{ # Contains a list of BackendService resources.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1382	"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
				1383	"items": [ # A list of BackendService resources.
				1384	{ # Represents a Backend Service resource.
				1385	#
				1386	# A backend service defines how Google Cloud load balancers distribute traffic. The backend service configuration contains a set of values, such as the protocol used to connect to backends, various distribution and session settings, health checks, and timeouts. These settings provide fine-grained control over how your load balancer behaves. Most of the settings have default values that allow for easy configuration if you need to get started quickly.
				1387	#
				1388	# Backend services in Google Compute Engine can be either regionally or globally scoped.
				1389	#
				1390	# * [Global](/compute/docs/reference/rest/{$api_version}/backendServices) * [Regional](/compute/docs/reference/rest/{$api_version}/regionBackendServices)
				1391	#
				1392	# For more information, see Backend Services.
				1393	#
				1394	# (== resource_for {$api_version}.backendService ==)
				1395	"affinityCookieTtlSec": 42, # Lifetime of cookies in seconds. Only applicable if the loadBalancingScheme is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED, the protocol is HTTP or HTTPS, and the sessionAffinity is GENERATED_COOKIE, or HTTP_COOKIE.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1396	#
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1397	# 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 is one day (86,400).
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1398	#
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1399	# Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
				1400	"backends": [ # The list of backends that serve this BackendService.
				1401	{ # Message containing information of one individual backend.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1402	"balancingMode": "A String", # Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode.
				1403	"capacityScaler": 3.14, # A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves 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. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1404	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1405	# Not supported by:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1406	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1407	# - Internal TCP/UDP Load Balancing - Network Load Balancing
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1408	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				1409	"failover": True or False, # This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService.
				1410	"group": "A String", # The fully-qualified URL of an instance group or network endpoint group (NEG) resource. The type of backend that a backend service supports depends on the backend service's loadBalancingScheme.
				1411	#
				1412	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1413	# - When the loadBalancingScheme for the backend service is EXTERNAL (except Network Load Balancing), INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED , the backend can be either an instance group or a NEG. The backends on the backend service must be either all instance groups or all NEGs. You cannot mix instance group and NEG backends on the same backend service.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1414	#
				1415	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1416	# - When the loadBalancingScheme for the backend service is EXTERNAL for Network Load Balancing or INTERNAL for Internal TCP/UDP Load Balancing, the backend must be an instance group. NEGs are not supported.
				1417	#
				1418	# For regional services, the backend must be in the same region as the backend service.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1419	#
				1420	# You must use the fully-qualified URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1421	"maxConnections": 42, # Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE. Not supported by:
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1422	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1423	# - Internal TCP/UDP Load Balancing - Network Load Balancing
				1424	"maxConnectionsPerEndpoint": 42, # Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1425	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1426	# Not available if the backend's balancingMode is RATE. Not supported by:
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1427	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1428	# - Internal TCP/UDP Load Balancing - Network Load Balancing.
				1429	"maxConnectionsPerInstance": 42, # Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1430	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1431	# Not available if the backend's balancingMode is RATE. Not supported by:
				1432	#
				1433	# - Internal TCP/UDP Load Balancing - Network Load Balancing.
				1434	"maxRate": 42, # Defines a maximum number of HTTP requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1435	#
				1436	# Not available if the backend's balancingMode is CONNECTION.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1437	"maxRatePerEndpoint": 3.14, # Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1438	#
				1439	# Not available if the backend's balancingMode is CONNECTION.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1440	"maxRatePerInstance": 3.14, # Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1441	#
				1442	# Not available if the backend's balancingMode is CONNECTION.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1443	"maxUtilization": 3.14,
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	1444	},
				1445	],
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1446	"cdnPolicy": { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. Only available for external HTTP(S) Load Balancing.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	1447	"bypassCacheOnRequestHeaders": [ # Bypass the cache when the specified request headers are matched - e.g. Pragma or Authorization headers. Up to 5 headers can be specified. The cache is bypassed for all cdnPolicy.cacheMode settings.
				1448	{ # Bypass the cache when the specified request headers are present, e.g. Pragma or Authorization headers. Values are case insensitive. The presence of such a header overrides the cache_mode setting.
				1449	"headerName": "A String", # The header field name to match on when bypassing cache. Values are case-insensitive.
				1450	},
				1451	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1452	"cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cloud CDN. # The CacheKeyPolicy for this CdnPolicy.
				1453	"includeHost": True or False, # If true, requests to different hosts will be cached separately.
				1454	"includeProtocol": True or False, # If true, http and https requests will be cached separately.
				1455	"includeQueryString": True or False, # 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.
				1456	"queryStringBlacklist": [ # 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.
				1457	"A String",
				1458	],
				1459	"queryStringWhitelist": [ # 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.
				1460	"A String",
				1461	],
				1462	},
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1463	"cacheMode": "A String", # Specifies the cache setting for all responses from this backend. The possible values are:
				1464	#
				1465	# USE_ORIGIN_HEADERS Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server.
				1466	#
				1467	# FORCE_CACHE_ALL Cache all content, ignoring any "private", "no-store" or "no-cache" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content.
				1468	#
				1469	# CACHE_ALL_STATIC Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached.
				1470	"clientTtl": 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is used to clamp the max-age (or Expires) value sent to the client. With FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the response max-age directive, along with a "public" directive. For cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age from the origin (if specified), or else sets the response max-age directive to the lesser of the client_ttl and default_ttl, and also ensures a "public" cache-control directive is present. If a client TTL is not specified, a default value (1 hour) will be used. The maximum allowed value is 86400s (1 day).
				1471	"defaultTtl": 42, # Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age). Setting a TTL of "0" means "always revalidate". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
				1472	"maxTtl": 42, # Specifies the maximum allowed TTL for cached content served by this origin. Cache directives that attempt to set a max-age or s-maxage higher than this, or an Expires header more than maxTTL seconds in the future will be capped at the value of maxTTL, as if it were the value of an s-maxage Cache-Control directive. Headers sent to the client will not be modified. Setting a TTL of "0" means "always revalidate". The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	1473	"negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected Request), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy.
				1474	"negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. negative_caching must be enabled to configure negative_caching_policy. Omitting the policy and leaving negative_caching enabled will use Cloud CDN's default cache TTLs. Note that when specifying an explicit negative_caching_policy, you should take care to specify a cache TTL for all response codes that you wish to cache. Cloud CDN will not apply any default negative caching when a policy exists.
				1475	{ # Specify CDN TTLs for response error codes.
				1476	"code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be specified as values, and you cannot specify a status code more than once.
				1477	"ttl": 42, # The TTL (in seconds) for which to cache responses with the corresponding status code. The maximum allowed value is 1800s (30 minutes), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
				1478	},
				1479	],
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame]	1480	"requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	1481	"serveWhileStale": 42, # Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default "max-stale" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-max-age) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1482	"signedUrlCacheMaxAgeSec": "A String", # Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.
				1483	"signedUrlKeyNames": [ # [Output Only] Names of the keys for signing request URLs.
				1484	"A String",
				1485	],
				1486	},
yoshi-code-bot	c2cd326	2021-05-16 02:16:04 -0700	[diff] [blame]	1487	"circuitBreakers": { # Settings controlling the volume of connections to a backend service.
				1488	"maxConnections": 42, # Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
				1489	"maxPendingRequests": 42, # Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1490	"maxRequests": 42, # The maximum number of parallel requests that allowed to the backend service. If not specified, there is no limit.
yoshi-code-bot	c2cd326	2021-05-16 02:16:04 -0700	[diff] [blame]	1491	"maxRequestsPerConnection": 42, # Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
				1492	"maxRetries": 42, # Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1493	},
				1494	"connectionDraining": { # Message containing connection draining configuration.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1495	"drainingTimeoutSec": 42, # Configures a duration timeout for existing requests on a removed backend instance. For supported load balancers and protocols, as described in Enabling connection draining.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1496	},
				1497	"consistentHash": { # This message defines settings for a consistent hash style load balancer. # Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties. This load balancing policy is applicable only for HTTP connections. The affinity to a particular destination host will be lost when one or more hosts are added/removed from the destination service. This field specifies parameters that control consistent hashing. This field is only applicable when localityLbPolicy is set to MAGLEV or RING_HASH.
				1498	#
				1499	# This field is applicable to either:
				1500	# - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.
				1501	# - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
				1502	#
				1503	# Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
				1504	"httpCookie": { # The information about the HTTP Cookie on which the hash function is based for load balancing policies that use a consistent hash. # Hash is based on HTTP Cookie. This field describes a HTTP cookie that will be used as the hash key for the consistent hash load balancer. If the cookie is not present, it will be generated. This field is applicable if the sessionAffinity is set to HTTP_COOKIE.
				1505	"name": "A String", # Name of the cookie.
				1506	"path": "A String", # Path to set for the cookie.
				1507	"ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie.
				1508	"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
				1509	"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
				1510	},
				1511	},
				1512	"httpHeaderName": "A String", # The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.
				1513	"minimumRingSize": "A String", # The minimum number of virtual nodes to use for the hash ring. Defaults to 1024. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node.
				1514	},
				1515	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				1516	"customRequestHeaders": [ # Headers that the HTTP/S load balancer should add to proxied requests.
				1517	"A String",
				1518	],
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1519	"customResponseHeaders": [ # Headers that the HTTP/S load balancer should add to proxied responses.
				1520	"A String",
				1521	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1522	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				1523	"enableCDN": True or False, # If true, enables Cloud CDN for the backend service. Only applicable if the loadBalancingScheme is EXTERNAL and the protocol is HTTP or HTTPS.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1524	"failoverPolicy": { # Applicable only to Failover for Internal TCP/UDP Load Balancing and Network Load Balancing. On failover or failback, this field indicates whether connection draining will be honored. GCP has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes). # Applicable only to Failover for Internal TCP/UDP Load Balancing and Network Load Balancing. Requires at least one backend instance group to be defined as a backup (failover) backend.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1525	"disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol is TCP.
				1526	#
				1527	# The default is false.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1528	"dropTrafficIfUnhealthy": True or False, # Applicable only to Failover for Internal TCP/UDP Load Balancing and Network Load Balancing, If set to true, connections to the load balancer are dropped when all primary and all backup backend VMs are unhealthy.If set to false, connections are distributed among all primary VMs when all primary and all backup backend VMs are unhealthy. The default is false.
				1529	"failoverRatio": 3.14, # Applicable only to Failover for Internal TCP/UDP Load Balancing and Network Load Balancing. The value of the field must be in the range [0, 1]. If the value is 0, the load balancer performs a failover when the number of healthy primary VMs equals zero. For all other values, the load balancer performs a failover when the total number of healthy primary VMs is less than this ratio.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1530	},
				1531	"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet.
				1532	#
				1533	# To see the latest fingerprint, make a get() request to retrieve a BackendService.
				1534	"healthChecks": [ # The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently, at most one health check can be specified for each backend service. Backend services with instance group or zonal NEG backends must have a health check. Backend services with internet or serverless NEG backends must not have a health check.
				1535	"A String",
				1536	],
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1537	"iap": { # Identity-Aware Proxy # The configurations for Identity-Aware Proxy on this resource. Not available for Internal TCP/UDP Load Balancing and Network Load Balancing.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1538	"enabled": True or False, # Whether the serving infrastructure will authenticate and authorize all incoming requests. If true, the oauth2ClientId and oauth2ClientSecret fields must be non-empty.
				1539	"oauth2ClientId": "A String", # OAuth2 client ID to use for the authentication flow.
				1540	"oauth2ClientSecret": "A String", # OAuth2 client secret to use for the authentication flow. For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2ClientSecretSha256 field.
				1541	"oauth2ClientSecretSha256": "A String", # [Output Only] SHA256 hash value for the field oauth2_client_secret above.
				1542	},
				1543	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				1544	"kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1545	"loadBalancingScheme": "A String", # Specifies the load balancer type. Choose EXTERNAL for external HTTP(S), SSL Proxy, TCP Proxy and Network Load Balancing. Choose INTERNAL for Internal TCP/UDP Load Balancing. Choose INTERNAL_MANAGED for Internal HTTP(S) Load Balancing. INTERNAL_SELF_MANAGED for Traffic Director. A backend service created for one type of load balancer cannot be used with another. For more information, refer to Choosing a load balancer.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1546	"localityLbPolicy": "A String", # The load balancing algorithm used within the scope of the locality. The possible values are:
				1547	# - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default.
				1548	# - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests.
				1549	# - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests.
				1550	# - RANDOM: The load balancer selects a random healthy host.
				1551	# - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer.
				1552	# - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824
				1553	#
				1554	# This field is applicable to either:
				1555	# - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.
				1556	# - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
				1557	#
				1558	# If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect.
				1559	#
				1560	# Only the default ROUND_ROBIN policy is supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
				1561	"logConfig": { # The available logging options for the load balancer traffic served by this backend service. # This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver.
				1562	"enable": True or False, # This field denotes whether to enable logging for the load balancer traffic served by this backend service.
				1563	"sampleRate": 3.14, # This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.
				1564	},
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	1565	"maxStreamDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the default maximum duration (timeout) for streams to this service. Duration is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed.
				1566	# If not specified, there will be no timeout limit, i.e. the maximum duration is infinite.
yoshi-code-bot	c2cd326	2021-05-16 02:16:04 -0700	[diff] [blame]	1567	# This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	1568	# This field is only allowed when the loadBalancingScheme of the backend service is INTERNAL_SELF_MANAGED.
				1569	"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
				1570	"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
				1571	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1572	"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1573	"network": "A String", # The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1574	"outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. If not set, this feature is considered disabled.
				1575	#
				1576	# This field is applicable to either:
				1577	# - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.
				1578	# - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
				1579	#
				1580	# Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
				1581	"baseEjectionTime": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # The base time that a host is ejected for. The real ejection time is equal to the base ejection time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s.
				1582	"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
				1583	"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
				1584	},
				1585	"consecutiveErrors": 42, # Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.
				1586	"consecutiveGatewayFailure": 42, # The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3.
				1587	"enforcingConsecutiveErrors": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0.
				1588	"enforcingConsecutiveGatewayFailure": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.
				1589	"enforcingSuccessRate": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.
				1590	"interval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Time interval between ejection analysis sweeps. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 second.
				1591	"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
				1592	"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
				1593	},
				1594	"maxEjectionPercent": 42, # Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 50%.
				1595	"successRateMinimumHosts": 42, # The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5.
				1596	"successRateRequestVolume": 42, # The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100.
				1597	"successRateStdevFactor": 42, # This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900.
				1598	},
				1599	"port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
				1600	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1601	# Backend services for Internal TCP/UDP Load Balancing and Network Load Balancing require you omit port.
				1602	"portName": "A String", # A named port on a backend instance group representing the port for communication to the backend VMs in that group. Required when the loadBalancingScheme is EXTERNAL (except Network Load Balancing), INTERNAL_MANAGED, or INTERNAL_SELF_MANAGED and the backends are instance groups. The named port must be defined on each backend instance group. This parameter has no meaning if the backends are NEGs.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1603	#
				1604	#
				1605	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1606	# Backend services for Internal TCP/UDP Load Balancing and Network Load Balancing require you omit port_name.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1607	"protocol": "A String", # The protocol this BackendService uses to communicate with backends.
				1608	#
				1609	# Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, UDP or GRPC. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancer or for Traffic Director for more information.
				1610	#
				1611	# Must be set to GRPC when the backend service is referenced by a URL map that is bound to target gRPC proxy.
				1612	"region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
				1613	"securityPolicy": "A String", # [Output Only] The resource URL for the security policy associated with this backend service.
				1614	"securitySettings": { # The authentication and authorization settings for a BackendService. # This field specifies the security policy that applies to this backend service. This field is applicable to either:
				1615	# - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.
				1616	# - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
				1617	"clientTlsPolicy": "A String", # Optional. A URL referring to a networksecurity.ClientTlsPolicy resource that describes how clients should authenticate with this service's backends.
				1618	# clientTlsPolicy only applies to a global BackendService with the loadBalancingScheme set to INTERNAL_SELF_MANAGED.
				1619	# If left blank, communications are not encrypted.
				1620	# Note: This field currently has no impact.
				1621	"subjectAltNames": [ # Optional. A list of Subject Alternative Names (SANs) that the client verifies during a mutual TLS handshake with an server/endpoint for this BackendService. When the server presents its X.509 certificate to the client, the client inspects the certificate's subjectAltName field. If the field contains one of the specified values, the communication continues. Otherwise, it fails. This additional check enables the client to verify that the server is authorized to run the requested service.
				1622	# Note that the contents of the server certificate's subjectAltName field are configured by the Public Key Infrastructure which provisions server identities.
				1623	# Only applies to a global BackendService with loadBalancingScheme set to INTERNAL_SELF_MANAGED. Only applies when BackendService has an attached clientTlsPolicy with clientCertificate (mTLS mode).
				1624	# Note: This field currently has no impact.
				1625	"A String",
				1626	],
				1627	},
				1628	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1629	"sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1630	#
yoshi-code-bot	8759538	2021-06-05 00:38:05 -0700	[diff] [blame]	1631	# When the loadBalancingScheme is EXTERNAL:
				1632	#
				1633	# * For Network Load Balancing, the possible values are NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO. * For all other load balancers that use loadBalancingScheme=EXTERNAL, the possible values are NONE, CLIENT_IP, or GENERATED_COOKIE. * You can use GENERATED_COOKIE if the protocol is HTTP, HTTP2, or HTTPS.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1634	#
				1635	# When the loadBalancingScheme is INTERNAL, possible values are NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
				1636	#
				1637	# When the loadBalancingScheme is INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED, possible values are NONE, CLIENT_IP, GENERATED_COOKIE, HEADER_FIELD, or HTTP_COOKIE.
				1638	#
				1639	# Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
yoshi-code-bot	c2cd326	2021-05-16 02:16:04 -0700	[diff] [blame]	1640	"timeoutSec": 42, # Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	1641	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1642	],
				1643	"kind": "compute#backendServiceList", # [Output Only] Type of resource. Always compute#backendServiceList for lists of backend services.
				1644	"nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
				1645	"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
				1646	"warning": { # [Output Only] Informational warning message.
				1647	"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
				1648	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				1649	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				1650	{
				1651	"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
				1652	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				1653	},
				1654	],
				1655	"message": "A String", # [Output Only] A human-readable description of the warning code.
				1656	},
				1657	}</pre>
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	1658	</div>
				1659
				1660	<div class="method">
				1661	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				1662	<pre>Retrieves the next page of results.
				1663
				1664	Args:
				1665	previous_request: The request for the previous page. (required)
				1666	previous_response: The response from the request for the previous page. (required)
				1667
				1668	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1669	A request object that you can call 'execute()' on to request the next
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	1670	page. Returns None if there are no more items in the collection.
				1671	</pre>
				1672	</div>
				1673
				1674	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1675	<code class="details" id="patch">patch(project, backendService, body=None, requestId=None)</code>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	1676	<pre>Patches the specified BackendService resource with the data included in the request. For more information, see Backend services overview. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	1677
				1678	Args:
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	1679	project: string, Project ID for this request. (required)
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	1680	backendService: string, Name of the BackendService resource to patch. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1681	body: object, The request body.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	1682	The object takes the form of:
				1683
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1684	{ # Represents a Backend Service resource.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1685	#
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	1686	# A backend service defines how Google Cloud load balancers distribute traffic. The backend service configuration contains a set of values, such as the protocol used to connect to backends, various distribution and session settings, health checks, and timeouts. These settings provide fine-grained control over how your load balancer behaves. Most of the settings have default values that allow for easy configuration if you need to get started quickly.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1687	#
				1688	# Backend services in Google Compute Engine can be either regionally or globally scoped.
				1689	#
				1690	# * [Global](/compute/docs/reference/rest/{$api_version}/backendServices) * [Regional](/compute/docs/reference/rest/{$api_version}/regionBackendServices)
				1691	#
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	1692	# For more information, see Backend Services.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1693	#
				1694	# (== resource_for {$api_version}.backendService ==)
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	1695	"affinityCookieTtlSec": 42, # Lifetime of cookies in seconds. Only applicable if the loadBalancingScheme is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED, the protocol is HTTP or HTTPS, and the sessionAffinity is GENERATED_COOKIE, or HTTP_COOKIE.
				1696	#
				1697	# 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 is one day (86,400).
				1698	#
				1699	# Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1700	"backends": [ # The list of backends that serve this BackendService.
				1701	{ # Message containing information of one individual backend.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1702	"balancingMode": "A String", # Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode.
				1703	"capacityScaler": 3.14, # A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves 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. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1704	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1705	# Not supported by:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1706	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1707	# - Internal TCP/UDP Load Balancing - Network Load Balancing
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1708	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				1709	"failover": True or False, # This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService.
				1710	"group": "A String", # The fully-qualified URL of an instance group or network endpoint group (NEG) resource. The type of backend that a backend service supports depends on the backend service's loadBalancingScheme.
				1711	#
				1712	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1713	# - When the loadBalancingScheme for the backend service is EXTERNAL (except Network Load Balancing), INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED , the backend can be either an instance group or a NEG. The backends on the backend service must be either all instance groups or all NEGs. You cannot mix instance group and NEG backends on the same backend service.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1714	#
				1715	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1716	# - When the loadBalancingScheme for the backend service is EXTERNAL for Network Load Balancing or INTERNAL for Internal TCP/UDP Load Balancing, the backend must be an instance group. NEGs are not supported.
				1717	#
				1718	# For regional services, the backend must be in the same region as the backend service.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1719	#
				1720	# You must use the fully-qualified URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1721	"maxConnections": 42, # Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE. Not supported by:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1722	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1723	# - Internal TCP/UDP Load Balancing - Network Load Balancing
				1724	"maxConnectionsPerEndpoint": 42, # Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1725	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1726	# Not available if the backend's balancingMode is RATE. Not supported by:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1727	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1728	# - Internal TCP/UDP Load Balancing - Network Load Balancing.
				1729	"maxConnectionsPerInstance": 42, # Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1730	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1731	# Not available if the backend's balancingMode is RATE. Not supported by:
				1732	#
				1733	# - Internal TCP/UDP Load Balancing - Network Load Balancing.
				1734	"maxRate": 42, # Defines a maximum number of HTTP requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1735	#
				1736	# Not available if the backend's balancingMode is CONNECTION.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1737	"maxRatePerEndpoint": 3.14, # Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1738	#
				1739	# Not available if the backend's balancingMode is CONNECTION.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1740	"maxRatePerInstance": 3.14, # Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1741	#
				1742	# Not available if the backend's balancingMode is CONNECTION.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1743	"maxUtilization": 3.14,
Sai Cheemalapati	ea3a5e1	2016-10-12 14:05:53 -0700	[diff] [blame]	1744	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1745	],
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1746	"cdnPolicy": { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. Only available for external HTTP(S) Load Balancing.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	1747	"bypassCacheOnRequestHeaders": [ # Bypass the cache when the specified request headers are matched - e.g. Pragma or Authorization headers. Up to 5 headers can be specified. The cache is bypassed for all cdnPolicy.cacheMode settings.
				1748	{ # Bypass the cache when the specified request headers are present, e.g. Pragma or Authorization headers. Values are case insensitive. The presence of such a header overrides the cache_mode setting.
				1749	"headerName": "A String", # The header field name to match on when bypassing cache. Values are case-insensitive.
				1750	},
				1751	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1752	"cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cloud CDN. # The CacheKeyPolicy for this CdnPolicy.
				1753	"includeHost": True or False, # If true, requests to different hosts will be cached separately.
				1754	"includeProtocol": True or False, # If true, http and https requests will be cached separately.
				1755	"includeQueryString": True or False, # 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.
				1756	"queryStringBlacklist": [ # 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.
				1757	"A String",
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	1758	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1759	"queryStringWhitelist": [ # 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.
				1760	"A String",
				1761	],
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	1762	},
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1763	"cacheMode": "A String", # Specifies the cache setting for all responses from this backend. The possible values are:
				1764	#
				1765	# USE_ORIGIN_HEADERS Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server.
				1766	#
				1767	# FORCE_CACHE_ALL Cache all content, ignoring any "private", "no-store" or "no-cache" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content.
				1768	#
				1769	# CACHE_ALL_STATIC Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached.
				1770	"clientTtl": 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is used to clamp the max-age (or Expires) value sent to the client. With FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the response max-age directive, along with a "public" directive. For cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age from the origin (if specified), or else sets the response max-age directive to the lesser of the client_ttl and default_ttl, and also ensures a "public" cache-control directive is present. If a client TTL is not specified, a default value (1 hour) will be used. The maximum allowed value is 86400s (1 day).
				1771	"defaultTtl": 42, # Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age). Setting a TTL of "0" means "always revalidate". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
				1772	"maxTtl": 42, # Specifies the maximum allowed TTL for cached content served by this origin. Cache directives that attempt to set a max-age or s-maxage higher than this, or an Expires header more than maxTTL seconds in the future will be capped at the value of maxTTL, as if it were the value of an s-maxage Cache-Control directive. Headers sent to the client will not be modified. Setting a TTL of "0" means "always revalidate". The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	1773	"negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected Request), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy.
				1774	"negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. negative_caching must be enabled to configure negative_caching_policy. Omitting the policy and leaving negative_caching enabled will use Cloud CDN's default cache TTLs. Note that when specifying an explicit negative_caching_policy, you should take care to specify a cache TTL for all response codes that you wish to cache. Cloud CDN will not apply any default negative caching when a policy exists.
				1775	{ # Specify CDN TTLs for response error codes.
				1776	"code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be specified as values, and you cannot specify a status code more than once.
				1777	"ttl": 42, # The TTL (in seconds) for which to cache responses with the corresponding status code. The maximum allowed value is 1800s (30 minutes), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
				1778	},
				1779	],
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame]	1780	"requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	1781	"serveWhileStale": 42, # Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default "max-stale" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-max-age) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1782	"signedUrlCacheMaxAgeSec": "A String", # Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.
				1783	"signedUrlKeyNames": [ # [Output Only] Names of the keys for signing request URLs.
				1784	"A String",
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	1785	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1786	},
yoshi-code-bot	c2cd326	2021-05-16 02:16:04 -0700	[diff] [blame]	1787	"circuitBreakers": { # Settings controlling the volume of connections to a backend service.
				1788	"maxConnections": 42, # Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
				1789	"maxPendingRequests": 42, # Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1790	"maxRequests": 42, # The maximum number of parallel requests that allowed to the backend service. If not specified, there is no limit.
yoshi-code-bot	c2cd326	2021-05-16 02:16:04 -0700	[diff] [blame]	1791	"maxRequestsPerConnection": 42, # Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
				1792	"maxRetries": 42, # Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1793	},
				1794	"connectionDraining": { # Message containing connection draining configuration.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1795	"drainingTimeoutSec": 42, # Configures a duration timeout for existing requests on a removed backend instance. For supported load balancers and protocols, as described in Enabling connection draining.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1796	},
				1797	"consistentHash": { # This message defines settings for a consistent hash style load balancer. # Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties. This load balancing policy is applicable only for HTTP connections. The affinity to a particular destination host will be lost when one or more hosts are added/removed from the destination service. This field specifies parameters that control consistent hashing. This field is only applicable when localityLbPolicy is set to MAGLEV or RING_HASH.
				1798	#
				1799	# This field is applicable to either:
				1800	# - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.
				1801	# - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	1802	#
				1803	# Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1804	"httpCookie": { # The information about the HTTP Cookie on which the hash function is based for load balancing policies that use a consistent hash. # Hash is based on HTTP Cookie. This field describes a HTTP cookie that will be used as the hash key for the consistent hash load balancer. If the cookie is not present, it will be generated. This field is applicable if the sessionAffinity is set to HTTP_COOKIE.
				1805	"name": "A String", # Name of the cookie.
				1806	"path": "A String", # Path to set for the cookie.
				1807	"ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie.
				1808	"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
				1809	"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
				1810	},
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	1811	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1812	"httpHeaderName": "A String", # The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.
				1813	"minimumRingSize": "A String", # The minimum number of virtual nodes to use for the hash ring. Defaults to 1024. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node.
				1814	},
				1815	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				1816	"customRequestHeaders": [ # Headers that the HTTP/S load balancer should add to proxied requests.
				1817	"A String",
				1818	],
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1819	"customResponseHeaders": [ # Headers that the HTTP/S load balancer should add to proxied responses.
				1820	"A String",
				1821	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1822	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				1823	"enableCDN": True or False, # If true, enables Cloud CDN for the backend service. Only applicable if the loadBalancingScheme is EXTERNAL and the protocol is HTTP or HTTPS.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1824	"failoverPolicy": { # Applicable only to Failover for Internal TCP/UDP Load Balancing and Network Load Balancing. On failover or failback, this field indicates whether connection draining will be honored. GCP has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes). # Applicable only to Failover for Internal TCP/UDP Load Balancing and Network Load Balancing. Requires at least one backend instance group to be defined as a backup (failover) backend.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1825	"disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol is TCP.
				1826	#
				1827	# The default is false.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1828	"dropTrafficIfUnhealthy": True or False, # Applicable only to Failover for Internal TCP/UDP Load Balancing and Network Load Balancing, If set to true, connections to the load balancer are dropped when all primary and all backup backend VMs are unhealthy.If set to false, connections are distributed among all primary VMs when all primary and all backup backend VMs are unhealthy. The default is false.
				1829	"failoverRatio": 3.14, # Applicable only to Failover for Internal TCP/UDP Load Balancing and Network Load Balancing. The value of the field must be in the range [0, 1]. If the value is 0, the load balancer performs a failover when the number of healthy primary VMs equals zero. For all other values, the load balancer performs a failover when the total number of healthy primary VMs is less than this ratio.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1830	},
				1831	"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet.
				1832	#
				1833	# To see the latest fingerprint, make a get() request to retrieve a BackendService.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	1834	"healthChecks": [ # The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently, at most one health check can be specified for each backend service. Backend services with instance group or zonal NEG backends must have a health check. Backend services with internet or serverless NEG backends must not have a health check.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1835	"A String",
				1836	],
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1837	"iap": { # Identity-Aware Proxy # The configurations for Identity-Aware Proxy on this resource. Not available for Internal TCP/UDP Load Balancing and Network Load Balancing.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	1838	"enabled": True or False, # Whether the serving infrastructure will authenticate and authorize all incoming requests. If true, the oauth2ClientId and oauth2ClientSecret fields must be non-empty.
				1839	"oauth2ClientId": "A String", # OAuth2 client ID to use for the authentication flow.
				1840	"oauth2ClientSecret": "A String", # OAuth2 client secret to use for the authentication flow. For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2ClientSecretSha256 field.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1841	"oauth2ClientSecretSha256": "A String", # [Output Only] SHA256 hash value for the field oauth2_client_secret above.
				1842	},
				1843	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				1844	"kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1845	"loadBalancingScheme": "A String", # Specifies the load balancer type. Choose EXTERNAL for external HTTP(S), SSL Proxy, TCP Proxy and Network Load Balancing. Choose INTERNAL for Internal TCP/UDP Load Balancing. Choose INTERNAL_MANAGED for Internal HTTP(S) Load Balancing. INTERNAL_SELF_MANAGED for Traffic Director. A backend service created for one type of load balancer cannot be used with another. For more information, refer to Choosing a load balancer.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1846	"localityLbPolicy": "A String", # The load balancing algorithm used within the scope of the locality. The possible values are:
				1847	# - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default.
				1848	# - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests.
				1849	# - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests.
				1850	# - RANDOM: The load balancer selects a random healthy host.
				1851	# - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	1852	# - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1853	#
				1854	# This field is applicable to either:
				1855	# - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.
				1856	# - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
				1857	#
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	1858	# If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect.
				1859	#
				1860	# Only the default ROUND_ROBIN policy is supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1861	"logConfig": { # The available logging options for the load balancer traffic served by this backend service. # This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver.
				1862	"enable": True or False, # This field denotes whether to enable logging for the load balancer traffic served by this backend service.
				1863	"sampleRate": 3.14, # This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.
				1864	},
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	1865	"maxStreamDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the default maximum duration (timeout) for streams to this service. Duration is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed.
				1866	# If not specified, there will be no timeout limit, i.e. the maximum duration is infinite.
yoshi-code-bot	c2cd326	2021-05-16 02:16:04 -0700	[diff] [blame]	1867	# This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	1868	# This field is only allowed when the loadBalancingScheme of the backend service is INTERNAL_SELF_MANAGED.
				1869	"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
				1870	"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
				1871	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1872	"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1873	"network": "A String", # The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1874	"outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. If not set, this feature is considered disabled.
				1875	#
				1876	# This field is applicable to either:
				1877	# - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.
				1878	# - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	1879	#
				1880	# Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1881	"baseEjectionTime": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # The base time that a host is ejected for. The real ejection time is equal to the base ejection time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s.
				1882	"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
				1883	"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1884	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1885	"consecutiveErrors": 42, # Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.
				1886	"consecutiveGatewayFailure": 42, # The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3.
				1887	"enforcingConsecutiveErrors": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0.
				1888	"enforcingConsecutiveGatewayFailure": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.
				1889	"enforcingSuccessRate": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.
				1890	"interval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Time interval between ejection analysis sweeps. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 second.
				1891	"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
				1892	"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1893	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1894	"maxEjectionPercent": 42, # Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 50%.
				1895	"successRateMinimumHosts": 42, # The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5.
				1896	"successRateRequestVolume": 42, # The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100.
				1897	"successRateStdevFactor": 42, # This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900.
				1898	},
				1899	"port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
				1900	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1901	# Backend services for Internal TCP/UDP Load Balancing and Network Load Balancing require you omit port.
				1902	"portName": "A String", # A named port on a backend instance group representing the port for communication to the backend VMs in that group. Required when the loadBalancingScheme is EXTERNAL (except Network Load Balancing), INTERNAL_MANAGED, or INTERNAL_SELF_MANAGED and the backends are instance groups. The named port must be defined on each backend instance group. This parameter has no meaning if the backends are NEGs.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1903	#
				1904	#
				1905	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1906	# Backend services for Internal TCP/UDP Load Balancing and Network Load Balancing require you omit port_name.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1907	"protocol": "A String", # The protocol this BackendService uses to communicate with backends.
				1908	#
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	1909	# Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, UDP or GRPC. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancer or for Traffic Director for more information.
				1910	#
				1911	# Must be set to GRPC when the backend service is referenced by a URL map that is bound to target gRPC proxy.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1912	"region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
				1913	"securityPolicy": "A String", # [Output Only] The resource URL for the security policy associated with this backend service.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	1914	"securitySettings": { # The authentication and authorization settings for a BackendService. # This field specifies the security policy that applies to this backend service. This field is applicable to either:
				1915	# - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.
				1916	# - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
				1917	"clientTlsPolicy": "A String", # Optional. A URL referring to a networksecurity.ClientTlsPolicy resource that describes how clients should authenticate with this service's backends.
				1918	# clientTlsPolicy only applies to a global BackendService with the loadBalancingScheme set to INTERNAL_SELF_MANAGED.
				1919	# If left blank, communications are not encrypted.
				1920	# Note: This field currently has no impact.
				1921	"subjectAltNames": [ # Optional. A list of Subject Alternative Names (SANs) that the client verifies during a mutual TLS handshake with an server/endpoint for this BackendService. When the server presents its X.509 certificate to the client, the client inspects the certificate's subjectAltName field. If the field contains one of the specified values, the communication continues. Otherwise, it fails. This additional check enables the client to verify that the server is authorized to run the requested service.
				1922	# Note that the contents of the server certificate's subjectAltName field are configured by the Public Key Infrastructure which provisions server identities.
				1923	# Only applies to a global BackendService with loadBalancingScheme set to INTERNAL_SELF_MANAGED. Only applies when BackendService has an attached clientTlsPolicy with clientCertificate (mTLS mode).
				1924	# Note: This field currently has no impact.
				1925	"A String",
				1926	],
				1927	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1928	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1929	"sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1930	#
yoshi-code-bot	8759538	2021-06-05 00:38:05 -0700	[diff] [blame]	1931	# When the loadBalancingScheme is EXTERNAL:
				1932	#
				1933	# * For Network Load Balancing, the possible values are NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO. * For all other load balancers that use loadBalancingScheme=EXTERNAL, the possible values are NONE, CLIENT_IP, or GENERATED_COOKIE. * You can use GENERATED_COOKIE if the protocol is HTTP, HTTP2, or HTTPS.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1934	#
				1935	# When the loadBalancingScheme is INTERNAL, possible values are NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
				1936	#
				1937	# When the loadBalancingScheme is INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED, possible values are NONE, CLIENT_IP, GENERATED_COOKIE, HEADER_FIELD, or HTTP_COOKIE.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	1938	#
				1939	# Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
yoshi-code-bot	c2cd326	2021-05-16 02:16:04 -0700	[diff] [blame]	1940	"timeoutSec": 42, # Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1941	}
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	1942
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	1943	requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
				1944
				1945	For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
				1946
				1947	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	1948
				1949	Returns:
				1950	An object of the form:
				1951
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	1952	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1953	#
				1954	# Google Compute Engine has three Operation resources:
				1955	#
				1956	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				1957	#
				1958	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				1959	#
				1960	# Operations can be global, regional or zonal.
				1961	# - For global operations, use the `globalOperations` resource.
				1962	# - For regional operations, use the `regionOperations` resource.
				1963	# - For zonal operations, use the `zonalOperations` resource.
				1964	#
				1965	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				1966	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				1967	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				1968	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				1969	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				1970	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				1971	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1972	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1973	"code": "A String", # [Output Only] The error type identifier for this error.
				1974	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				1975	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1976	},
				1977	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1978	},
				1979	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				1980	"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
				1981	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				1982	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				1983	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				1984	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1985	"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1986	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				1987	"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
				1988	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				1989	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				1990	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				1991	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				1992	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				1993	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				1994	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
				1995	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				1996	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				1997	{
				1998	"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
				1999	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				2000	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				2001	{
				2002	"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
				2003	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				2004	},
				2005	],
				2006	"message": "A String", # [Output Only] A human-readable description of the warning code.
				2007	},
				2008	],
				2009	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				2010	}</pre>
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	2011	</div>
				2012
				2013	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	2014	<code class="details" id="setSecurityPolicy">setSecurityPolicy(project, backendService, body=None, requestId=None)</code>
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	2015	<pre>Sets the Google Cloud Armor security policy for the specified backend service. For more information, see Google Cloud Armor Overview
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	2016
				2017	Args:
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	2018	project: string, Project ID for this request. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	2019	backendService: string, Name of the BackendService resource to which the security policy should be set. The name should conform to RFC1035. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	2020	body: object, The request body.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	2021	The object takes the form of:
				2022
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	2023	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	2024	"securityPolicy": "A String",
				2025	}
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	2026
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	2027	requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
				2028
				2029	For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
				2030
				2031	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	2032
				2033	Returns:
				2034	An object of the form:
				2035
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	2036	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	2037	#
				2038	# Google Compute Engine has three Operation resources:
				2039	#
				2040	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				2041	#
				2042	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				2043	#
				2044	# Operations can be global, regional or zonal.
				2045	# - For global operations, use the `globalOperations` resource.
				2046	# - For regional operations, use the `regionOperations` resource.
				2047	# - For zonal operations, use the `zonalOperations` resource.
				2048	#
				2049	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				2050	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				2051	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				2052	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				2053	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				2054	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				2055	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2056	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	2057	"code": "A String", # [Output Only] The error type identifier for this error.
				2058	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				2059	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2060	},
				2061	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	2062	},
				2063	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				2064	"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
				2065	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				2066	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				2067	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				2068	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	2069	"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	2070	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				2071	"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
				2072	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				2073	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				2074	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				2075	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				2076	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				2077	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				2078	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
				2079	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				2080	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				2081	{
				2082	"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
				2083	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				2084	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				2085	{
				2086	"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
				2087	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				2088	},
				2089	],
				2090	"message": "A String", # [Output Only] A human-readable description of the warning code.
				2091	},
				2092	],
				2093	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				2094	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	2095	</div>
				2096
				2097	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	2098	<code class="details" id="update">update(project, backendService, body=None, requestId=None)</code>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	2099	<pre>Updates the specified BackendService resource with the data included in the request. For more information, see Backend services overview.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	2100
				2101	Args:
				2102	project: string, Project ID for this request. (required)
				2103	backendService: string, Name of the BackendService resource to update. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	2104	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	2105	The object takes the form of:
				2106
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	2107	{ # Represents a Backend Service resource.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2108	#
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	2109	# A backend service defines how Google Cloud load balancers distribute traffic. The backend service configuration contains a set of values, such as the protocol used to connect to backends, various distribution and session settings, health checks, and timeouts. These settings provide fine-grained control over how your load balancer behaves. Most of the settings have default values that allow for easy configuration if you need to get started quickly.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2110	#
				2111	# Backend services in Google Compute Engine can be either regionally or globally scoped.
				2112	#
				2113	# * [Global](/compute/docs/reference/rest/{$api_version}/backendServices) * [Regional](/compute/docs/reference/rest/{$api_version}/regionBackendServices)
				2114	#
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	2115	# For more information, see Backend Services.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2116	#
				2117	# (== resource_for {$api_version}.backendService ==)
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	2118	"affinityCookieTtlSec": 42, # Lifetime of cookies in seconds. Only applicable if the loadBalancingScheme is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED, the protocol is HTTP or HTTPS, and the sessionAffinity is GENERATED_COOKIE, or HTTP_COOKIE.
				2119	#
				2120	# 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 is one day (86,400).
				2121	#
				2122	# Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2123	"backends": [ # The list of backends that serve this BackendService.
				2124	{ # Message containing information of one individual backend.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	2125	"balancingMode": "A String", # Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode.
				2126	"capacityScaler": 3.14, # A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves 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. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2127	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	2128	# Not supported by:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2129	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	2130	# - Internal TCP/UDP Load Balancing - Network Load Balancing
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2131	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				2132	"failover": True or False, # This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService.
				2133	"group": "A String", # The fully-qualified URL of an instance group or network endpoint group (NEG) resource. The type of backend that a backend service supports depends on the backend service's loadBalancingScheme.
				2134	#
				2135	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	2136	# - When the loadBalancingScheme for the backend service is EXTERNAL (except Network Load Balancing), INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED , the backend can be either an instance group or a NEG. The backends on the backend service must be either all instance groups or all NEGs. You cannot mix instance group and NEG backends on the same backend service.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2137	#
				2138	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	2139	# - When the loadBalancingScheme for the backend service is EXTERNAL for Network Load Balancing or INTERNAL for Internal TCP/UDP Load Balancing, the backend must be an instance group. NEGs are not supported.
				2140	#
				2141	# For regional services, the backend must be in the same region as the backend service.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2142	#
				2143	# You must use the fully-qualified URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	2144	"maxConnections": 42, # Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE. Not supported by:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2145	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	2146	# - Internal TCP/UDP Load Balancing - Network Load Balancing
				2147	"maxConnectionsPerEndpoint": 42, # Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2148	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	2149	# Not available if the backend's balancingMode is RATE. Not supported by:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2150	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	2151	# - Internal TCP/UDP Load Balancing - Network Load Balancing.
				2152	"maxConnectionsPerInstance": 42, # Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2153	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	2154	# Not available if the backend's balancingMode is RATE. Not supported by:
				2155	#
				2156	# - Internal TCP/UDP Load Balancing - Network Load Balancing.
				2157	"maxRate": 42, # Defines a maximum number of HTTP requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2158	#
				2159	# Not available if the backend's balancingMode is CONNECTION.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	2160	"maxRatePerEndpoint": 3.14, # Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2161	#
				2162	# Not available if the backend's balancingMode is CONNECTION.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	2163	"maxRatePerInstance": 3.14, # Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2164	#
				2165	# Not available if the backend's balancingMode is CONNECTION.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	2166	"maxUtilization": 3.14,
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	2167	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2168	],
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	2169	"cdnPolicy": { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. Only available for external HTTP(S) Load Balancing.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	2170	"bypassCacheOnRequestHeaders": [ # Bypass the cache when the specified request headers are matched - e.g. Pragma or Authorization headers. Up to 5 headers can be specified. The cache is bypassed for all cdnPolicy.cacheMode settings.
				2171	{ # Bypass the cache when the specified request headers are present, e.g. Pragma or Authorization headers. Values are case insensitive. The presence of such a header overrides the cache_mode setting.
				2172	"headerName": "A String", # The header field name to match on when bypassing cache. Values are case-insensitive.
				2173	},
				2174	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2175	"cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cloud CDN. # The CacheKeyPolicy for this CdnPolicy.
				2176	"includeHost": True or False, # If true, requests to different hosts will be cached separately.
				2177	"includeProtocol": True or False, # If true, http and https requests will be cached separately.
				2178	"includeQueryString": True or False, # 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.
				2179	"queryStringBlacklist": [ # 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.
				2180	"A String",
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	2181	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2182	"queryStringWhitelist": [ # 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.
				2183	"A String",
				2184	],
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	2185	},
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	2186	"cacheMode": "A String", # Specifies the cache setting for all responses from this backend. The possible values are:
				2187	#
				2188	# USE_ORIGIN_HEADERS Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server.
				2189	#
				2190	# FORCE_CACHE_ALL Cache all content, ignoring any "private", "no-store" or "no-cache" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content.
				2191	#
				2192	# CACHE_ALL_STATIC Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached.
				2193	"clientTtl": 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is used to clamp the max-age (or Expires) value sent to the client. With FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the response max-age directive, along with a "public" directive. For cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age from the origin (if specified), or else sets the response max-age directive to the lesser of the client_ttl and default_ttl, and also ensures a "public" cache-control directive is present. If a client TTL is not specified, a default value (1 hour) will be used. The maximum allowed value is 86400s (1 day).
				2194	"defaultTtl": 42, # Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age). Setting a TTL of "0" means "always revalidate". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
				2195	"maxTtl": 42, # Specifies the maximum allowed TTL for cached content served by this origin. Cache directives that attempt to set a max-age or s-maxage higher than this, or an Expires header more than maxTTL seconds in the future will be capped at the value of maxTTL, as if it were the value of an s-maxage Cache-Control directive. Headers sent to the client will not be modified. Setting a TTL of "0" means "always revalidate". The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	2196	"negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected Request), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy.
				2197	"negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. negative_caching must be enabled to configure negative_caching_policy. Omitting the policy and leaving negative_caching enabled will use Cloud CDN's default cache TTLs. Note that when specifying an explicit negative_caching_policy, you should take care to specify a cache TTL for all response codes that you wish to cache. Cloud CDN will not apply any default negative caching when a policy exists.
				2198	{ # Specify CDN TTLs for response error codes.
				2199	"code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be specified as values, and you cannot specify a status code more than once.
				2200	"ttl": 42, # The TTL (in seconds) for which to cache responses with the corresponding status code. The maximum allowed value is 1800s (30 minutes), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.
				2201	},
				2202	],
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame]	2203	"requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	2204	"serveWhileStale": 42, # Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default "max-stale" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-max-age) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2205	"signedUrlCacheMaxAgeSec": "A String", # Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.
				2206	"signedUrlKeyNames": [ # [Output Only] Names of the keys for signing request URLs.
				2207	"A String",
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	2208	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2209	},
yoshi-code-bot	c2cd326	2021-05-16 02:16:04 -0700	[diff] [blame]	2210	"circuitBreakers": { # Settings controlling the volume of connections to a backend service.
				2211	"maxConnections": 42, # Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
				2212	"maxPendingRequests": 42, # Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2213	"maxRequests": 42, # The maximum number of parallel requests that allowed to the backend service. If not specified, there is no limit.
yoshi-code-bot	c2cd326	2021-05-16 02:16:04 -0700	[diff] [blame]	2214	"maxRequestsPerConnection": 42, # Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
				2215	"maxRetries": 42, # Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2216	},
				2217	"connectionDraining": { # Message containing connection draining configuration.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	2218	"drainingTimeoutSec": 42, # Configures a duration timeout for existing requests on a removed backend instance. For supported load balancers and protocols, as described in Enabling connection draining.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2219	},
				2220	"consistentHash": { # This message defines settings for a consistent hash style load balancer. # Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties. This load balancing policy is applicable only for HTTP connections. The affinity to a particular destination host will be lost when one or more hosts are added/removed from the destination service. This field specifies parameters that control consistent hashing. This field is only applicable when localityLbPolicy is set to MAGLEV or RING_HASH.
				2221	#
				2222	# This field is applicable to either:
				2223	# - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.
				2224	# - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	2225	#
				2226	# Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2227	"httpCookie": { # The information about the HTTP Cookie on which the hash function is based for load balancing policies that use a consistent hash. # Hash is based on HTTP Cookie. This field describes a HTTP cookie that will be used as the hash key for the consistent hash load balancer. If the cookie is not present, it will be generated. This field is applicable if the sessionAffinity is set to HTTP_COOKIE.
				2228	"name": "A String", # Name of the cookie.
				2229	"path": "A String", # Path to set for the cookie.
				2230	"ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie.
				2231	"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
				2232	"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
				2233	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	2234	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2235	"httpHeaderName": "A String", # The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.
				2236	"minimumRingSize": "A String", # The minimum number of virtual nodes to use for the hash ring. Defaults to 1024. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node.
				2237	},
				2238	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				2239	"customRequestHeaders": [ # Headers that the HTTP/S load balancer should add to proxied requests.
				2240	"A String",
				2241	],
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	2242	"customResponseHeaders": [ # Headers that the HTTP/S load balancer should add to proxied responses.
				2243	"A String",
				2244	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2245	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				2246	"enableCDN": True or False, # If true, enables Cloud CDN for the backend service. Only applicable if the loadBalancingScheme is EXTERNAL and the protocol is HTTP or HTTPS.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	2247	"failoverPolicy": { # Applicable only to Failover for Internal TCP/UDP Load Balancing and Network Load Balancing. On failover or failback, this field indicates whether connection draining will be honored. GCP has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes). # Applicable only to Failover for Internal TCP/UDP Load Balancing and Network Load Balancing. Requires at least one backend instance group to be defined as a backup (failover) backend.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2248	"disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol is TCP.
				2249	#
				2250	# The default is false.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	2251	"dropTrafficIfUnhealthy": True or False, # Applicable only to Failover for Internal TCP/UDP Load Balancing and Network Load Balancing, If set to true, connections to the load balancer are dropped when all primary and all backup backend VMs are unhealthy.If set to false, connections are distributed among all primary VMs when all primary and all backup backend VMs are unhealthy. The default is false.
				2252	"failoverRatio": 3.14, # Applicable only to Failover for Internal TCP/UDP Load Balancing and Network Load Balancing. The value of the field must be in the range [0, 1]. If the value is 0, the load balancer performs a failover when the number of healthy primary VMs equals zero. For all other values, the load balancer performs a failover when the total number of healthy primary VMs is less than this ratio.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2253	},
				2254	"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet.
				2255	#
				2256	# To see the latest fingerprint, make a get() request to retrieve a BackendService.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	2257	"healthChecks": [ # The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently, at most one health check can be specified for each backend service. Backend services with instance group or zonal NEG backends must have a health check. Backend services with internet or serverless NEG backends must not have a health check.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2258	"A String",
				2259	],
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	2260	"iap": { # Identity-Aware Proxy # The configurations for Identity-Aware Proxy on this resource. Not available for Internal TCP/UDP Load Balancing and Network Load Balancing.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	2261	"enabled": True or False, # Whether the serving infrastructure will authenticate and authorize all incoming requests. If true, the oauth2ClientId and oauth2ClientSecret fields must be non-empty.
				2262	"oauth2ClientId": "A String", # OAuth2 client ID to use for the authentication flow.
				2263	"oauth2ClientSecret": "A String", # OAuth2 client secret to use for the authentication flow. For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2ClientSecretSha256 field.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2264	"oauth2ClientSecretSha256": "A String", # [Output Only] SHA256 hash value for the field oauth2_client_secret above.
				2265	},
				2266	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				2267	"kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	2268	"loadBalancingScheme": "A String", # Specifies the load balancer type. Choose EXTERNAL for external HTTP(S), SSL Proxy, TCP Proxy and Network Load Balancing. Choose INTERNAL for Internal TCP/UDP Load Balancing. Choose INTERNAL_MANAGED for Internal HTTP(S) Load Balancing. INTERNAL_SELF_MANAGED for Traffic Director. A backend service created for one type of load balancer cannot be used with another. For more information, refer to Choosing a load balancer.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2269	"localityLbPolicy": "A String", # The load balancing algorithm used within the scope of the locality. The possible values are:
				2270	# - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default.
				2271	# - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests.
				2272	# - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests.
				2273	# - RANDOM: The load balancer selects a random healthy host.
				2274	# - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	2275	# - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2276	#
				2277	# This field is applicable to either:
				2278	# - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.
				2279	# - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
				2280	#
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	2281	# If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect.
				2282	#
				2283	# Only the default ROUND_ROBIN policy is supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2284	"logConfig": { # The available logging options for the load balancer traffic served by this backend service. # This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver.
				2285	"enable": True or False, # This field denotes whether to enable logging for the load balancer traffic served by this backend service.
				2286	"sampleRate": 3.14, # This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.
				2287	},
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	2288	"maxStreamDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the default maximum duration (timeout) for streams to this service. Duration is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed.
				2289	# If not specified, there will be no timeout limit, i.e. the maximum duration is infinite.
yoshi-code-bot	c2cd326	2021-05-16 02:16:04 -0700	[diff] [blame]	2290	# This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	2291	# This field is only allowed when the loadBalancingScheme of the backend service is INTERNAL_SELF_MANAGED.
				2292	"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
				2293	"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
				2294	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2295	"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	2296	"network": "A String", # The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2297	"outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. If not set, this feature is considered disabled.
				2298	#
				2299	# This field is applicable to either:
				2300	# - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.
				2301	# - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	2302	#
				2303	# Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2304	"baseEjectionTime": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # The base time that a host is ejected for. The real ejection time is equal to the base ejection time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s.
				2305	"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
				2306	"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	2307	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2308	"consecutiveErrors": 42, # Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.
				2309	"consecutiveGatewayFailure": 42, # The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3.
				2310	"enforcingConsecutiveErrors": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0.
				2311	"enforcingConsecutiveGatewayFailure": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.
				2312	"enforcingSuccessRate": 42, # The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.
				2313	"interval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Time interval between ejection analysis sweeps. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 second.
				2314	"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
				2315	"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	2316	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2317	"maxEjectionPercent": 42, # Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 50%.
				2318	"successRateMinimumHosts": 42, # The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5.
				2319	"successRateRequestVolume": 42, # The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100.
				2320	"successRateStdevFactor": 42, # This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900.
				2321	},
				2322	"port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
				2323	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	2324	# Backend services for Internal TCP/UDP Load Balancing and Network Load Balancing require you omit port.
				2325	"portName": "A String", # A named port on a backend instance group representing the port for communication to the backend VMs in that group. Required when the loadBalancingScheme is EXTERNAL (except Network Load Balancing), INTERNAL_MANAGED, or INTERNAL_SELF_MANAGED and the backends are instance groups. The named port must be defined on each backend instance group. This parameter has no meaning if the backends are NEGs.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2326	#
				2327	#
				2328	#
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	2329	# Backend services for Internal TCP/UDP Load Balancing and Network Load Balancing require you omit port_name.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2330	"protocol": "A String", # The protocol this BackendService uses to communicate with backends.
				2331	#
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	2332	# Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, UDP or GRPC. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancer or for Traffic Director for more information.
				2333	#
				2334	# Must be set to GRPC when the backend service is referenced by a URL map that is bound to target gRPC proxy.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2335	"region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
				2336	"securityPolicy": "A String", # [Output Only] The resource URL for the security policy associated with this backend service.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	2337	"securitySettings": { # The authentication and authorization settings for a BackendService. # This field specifies the security policy that applies to this backend service. This field is applicable to either:
				2338	# - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.
				2339	# - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
				2340	"clientTlsPolicy": "A String", # Optional. A URL referring to a networksecurity.ClientTlsPolicy resource that describes how clients should authenticate with this service's backends.
				2341	# clientTlsPolicy only applies to a global BackendService with the loadBalancingScheme set to INTERNAL_SELF_MANAGED.
				2342	# If left blank, communications are not encrypted.
				2343	# Note: This field currently has no impact.
				2344	"subjectAltNames": [ # Optional. A list of Subject Alternative Names (SANs) that the client verifies during a mutual TLS handshake with an server/endpoint for this BackendService. When the server presents its X.509 certificate to the client, the client inspects the certificate's subjectAltName field. If the field contains one of the specified values, the communication continues. Otherwise, it fails. This additional check enables the client to verify that the server is authorized to run the requested service.
				2345	# Note that the contents of the server certificate's subjectAltName field are configured by the Public Key Infrastructure which provisions server identities.
				2346	# Only applies to a global BackendService with loadBalancingScheme set to INTERNAL_SELF_MANAGED. Only applies when BackendService has an attached clientTlsPolicy with clientCertificate (mTLS mode).
				2347	# Note: This field currently has no impact.
				2348	"A String",
				2349	],
				2350	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2351	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	2352	"sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2353	#
yoshi-code-bot	8759538	2021-06-05 00:38:05 -0700	[diff] [blame]	2354	# When the loadBalancingScheme is EXTERNAL:
				2355	#
				2356	# * For Network Load Balancing, the possible values are NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO. * For all other load balancers that use loadBalancingScheme=EXTERNAL, the possible values are NONE, CLIENT_IP, or GENERATED_COOKIE. * You can use GENERATED_COOKIE if the protocol is HTTP, HTTP2, or HTTPS.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2357	#
				2358	# When the loadBalancingScheme is INTERNAL, possible values are NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
				2359	#
				2360	# When the loadBalancingScheme is INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED, possible values are NONE, CLIENT_IP, GENERATED_COOKIE, HEADER_FIELD, or HTTP_COOKIE.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	2361	#
				2362	# Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
yoshi-code-bot	c2cd326	2021-05-16 02:16:04 -0700	[diff] [blame]	2363	"timeoutSec": 42, # Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2364	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	2365
				2366	requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
				2367
				2368	For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
				2369
				2370	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
				2371
				2372	Returns:
				2373	An object of the form:
				2374
				2375	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	2376	#
				2377	# Google Compute Engine has three Operation resources:
				2378	#
				2379	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				2380	#
				2381	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				2382	#
				2383	# Operations can be global, regional or zonal.
				2384	# - For global operations, use the `globalOperations` resource.
				2385	# - For regional operations, use the `regionOperations` resource.
				2386	# - For zonal operations, use the `zonalOperations` resource.
				2387	#
				2388	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				2389	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				2390	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				2391	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				2392	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				2393	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				2394	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2395	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	2396	"code": "A String", # [Output Only] The error type identifier for this error.
				2397	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				2398	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2399	},
				2400	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	2401	},
				2402	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				2403	"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
				2404	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				2405	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				2406	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				2407	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	2408	"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	2409	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				2410	"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
				2411	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				2412	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				2413	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				2414	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				2415	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				2416	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				2417	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
				2418	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				2419	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				2420	{
				2421	"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
				2422	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				2423	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				2424	{
				2425	"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
				2426	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				2427	},
				2428	],
				2429	"message": "A String", # [Output Only] A human-readable description of the warning code.
				2430	},
				2431	],
				2432	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				2433	}</pre>
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	2434	</div>
				2435
				2436	</body></html>