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

blob: dc04bc5dea653cb1e7668f7345a3180cb1a3cf46 [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">
				78	<code><a href="#delete">delete(project, backendService)</a></code></p>
				79	<p class="firstline">Deletes the specified BackendService resource.</p>
				80	<p class="toc_element">
				81	<code><a href="#get">get(project, backendService)</a></code></p>
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	82	<p class="firstline">Returns the specified BackendService resource. Get a list of available backend services by making a list() request.</p>
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	83	<p class="toc_element">
				84	<code><a href="#getHealth">getHealth(project, backendService, body)</a></code></p>
				85	<p class="firstline">Gets the most recent health check results for this BackendService.</p>
				86	<p class="toc_element">
				87	<code><a href="#insert">insert(project, body)</a></code></p>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	88	<p class="firstline">Creates a BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a backend service. Read Restrictions and Guidelines for more information.</p>
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	89	<p class="toc_element">
Sai Cheemalapati	ea3a5e1	2016-10-12 14:05:53 -0700	[diff] [blame^]	90	<code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	91	<p class="firstline">Retrieves the list of BackendService resources available to the specified project.</p>
				92	<p class="toc_element">
				93	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				94	<p class="firstline">Retrieves the next page of results.</p>
				95	<p class="toc_element">
				96	<code><a href="#patch">patch(project, backendService, body)</a></code></p>
Sai Cheemalapati	ea3a5e1	2016-10-12 14:05:53 -0700	[diff] [blame^]	97	<p class="firstline">Updates the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports patch semantics.</p>
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	98	<p class="toc_element">
				99	<code><a href="#update">update(project, backendService, body)</a></code></p>
Sai Cheemalapati	ea3a5e1	2016-10-12 14:05:53 -0700	[diff] [blame^]	100	<p class="firstline">Updates the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information.</p>
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	101	<h3>Method Details</h3>
				102	<div class="method">
				103	<code class="details" id="delete">delete(project, backendService)</code>
				104	<pre>Deletes the specified BackendService resource.
				105
				106	Args:
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	107	project: string, Project ID for this request. (required)
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	108	backendService: string, Name of the BackendService resource to delete. (required)
				109
				110	Returns:
				111	An object of the form:
				112
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	113	{ # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	114	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				115	"clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	116	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	117	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				118	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				119	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				120	"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	121	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	122	"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.
				123	"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.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	124	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	125	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				126	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	127	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	128	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	129	"message": "A String", # [Output Only] A human-readable description of the warning code.
				130	"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.
				131	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				132	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	133	{
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	134	"value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	135	"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).
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	136	},
				137	],
				138	},
				139	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	140	"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	141	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				142	"kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	143	"name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	144	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	145	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	146	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	147	{
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	148	"message": "A String", # [Output Only] An optional, human-readable error message.
				149	"code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	150	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	151	},
				152	],
				153	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	154	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	155	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Sai Cheemalapati	ea3a5e1	2016-10-12 14:05:53 -0700	[diff] [blame^]	156	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	157	}</pre>
				158	</div>
				159
				160	<div class="method">
				161	<code class="details" id="get">get(project, backendService)</code>
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	162	<pre>Returns the specified BackendService resource. Get a list of available backend services by making a list() request.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	163
				164	Args:
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	165	project: string, Project ID for this request. (required)
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	166	backendService: string, Name of the BackendService resource to return. (required)
				167
				168	Returns:
				169	An object of the form:
				170
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	171	{ # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
Sai Cheemalapati	ea3a5e1	2016-10-12 14:05:53 -0700	[diff] [blame^]	172	"connectionDraining": { # Message containing connection draining configuration.
				173	"drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
				174	},
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	175	"kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	176	"protocol": "A String", # The protocol this BackendService uses to communicate with backends.
				177	#
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	178	# Possible values are HTTP, HTTPS, HTTP2, TCP and SSL. The default is HTTP.
				179	#
				180	# For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	181	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	182	"timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	183	"enableCDN": True or False, # If true, enable Cloud CDN for this BackendService.
				184	#
				185	# When the load balancing scheme is INTERNAL, this field is not used.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	186	"region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	187	"affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
				188	#
				189	# When the load balancing scheme is INTERNAL, this field is not used.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	190	"port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	191	#
				192	# This cannot be used for internal load balancing.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	193	"backends": [ # The list of backends that serve this BackendService.
				194	{ # Message containing information of one individual backend.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	195	"group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
				196	#
				197	# Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	198	#
				199	# When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	200	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	201	"maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	202	#
				203	# This cannot be used for internal load balancing.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	204	"maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	205	#
				206	# This cannot be used for internal load balancing.
Sai Cheemalapati	ea3a5e1	2016-10-12 14:05:53 -0700	[diff] [blame^]	207	"maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
				208	#
				209	# This cannot be used for internal load balancing.
				210	"capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	211	#
				212	# This cannot be used for internal load balancing.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	213	"maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	214	#
				215	# This cannot be used for internal load balancing.
Sai Cheemalapati	ea3a5e1	2016-10-12 14:05:53 -0700	[diff] [blame^]	216	"maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
				217	#
				218	# This cannot be used for internal load balancing.
				219	"balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	220	#
				221	# This cannot be used for internal load balancing.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	222	},
				223	],
				224	"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.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	225	"portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
				226	#
				227	# When the load balancing scheme is INTERNAL, this field is not used.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	228	"healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	229	#
				230	# For internal load balancing, a URL to a HealthCheck resource must be specified instead.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	231	"A String",
				232	],
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	233	"sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
				234	#
				235	# When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
				236	#
				237	# When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
				238	#
				239	# When the protocol is UDP, this field is not used.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	240	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	241	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	242	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				243	"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.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	244	}</pre>
				245	</div>
				246
				247	<div class="method">
				248	<code class="details" id="getHealth">getHealth(project, backendService, body)</code>
				249	<pre>Gets the most recent health check results for this BackendService.
				250
				251	Args:
				252	project: string, A parameter (required)
				253	backendService: string, Name of the BackendService resource to which the queried instance belongs. (required)
				254	body: object, The request body. (required)
				255	The object takes the form of:
				256
				257	{
Sai Cheemalapati	ea3a5e1	2016-10-12 14:05:53 -0700	[diff] [blame^]	258	"group": "A String", # A URI referencing one of the instance groups listed in the backend service.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	259	}
				260
				261
				262	Returns:
				263	An object of the form:
				264
				265	{
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	266	"kind": "compute#backendServiceGroupHealth", # [Output Only] Type of resource. Always compute#backendServiceGroupHealth for the health of backend services.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	267	"healthStatus": [
				268	{
				269	"instance": "A String", # URL of the instance resource.
				270	"healthState": "A String", # Health state of the instance.
				271	"ipAddress": "A String", # The IP address represented by this resource.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	272	"port": 42, # The port on the instance.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	273	},
				274	],
				275	}</pre>
				276	</div>
				277
				278	<div class="method">
				279	<code class="details" id="insert">insert(project, body)</code>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	280	<pre>Creates a BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a backend service. Read Restrictions and Guidelines for more information.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	281
				282	Args:
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	283	project: string, Project ID for this request. (required)
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	284	body: object, The request body. (required)
				285	The object takes the form of:
				286
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	287	{ # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
Sai Cheemalapati	ea3a5e1	2016-10-12 14:05:53 -0700	[diff] [blame^]	288	"connectionDraining": { # Message containing connection draining configuration.
				289	"drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
				290	},
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	291	"kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	292	"protocol": "A String", # The protocol this BackendService uses to communicate with backends.
				293	#
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	294	# Possible values are HTTP, HTTPS, HTTP2, TCP and SSL. The default is HTTP.
				295	#
				296	# For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	297	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	298	"timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	299	"enableCDN": True or False, # If true, enable Cloud CDN for this BackendService.
				300	#
				301	# When the load balancing scheme is INTERNAL, this field is not used.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	302	"region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	303	"affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
				304	#
				305	# When the load balancing scheme is INTERNAL, this field is not used.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	306	"port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	307	#
				308	# This cannot be used for internal load balancing.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	309	"backends": [ # The list of backends that serve this BackendService.
				310	{ # Message containing information of one individual backend.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	311	"group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
				312	#
				313	# Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	314	#
				315	# When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	316	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	317	"maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	318	#
				319	# This cannot be used for internal load balancing.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	320	"maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	321	#
				322	# This cannot be used for internal load balancing.
Sai Cheemalapati	ea3a5e1	2016-10-12 14:05:53 -0700	[diff] [blame^]	323	"maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
				324	#
				325	# This cannot be used for internal load balancing.
				326	"capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	327	#
				328	# This cannot be used for internal load balancing.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	329	"maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	330	#
				331	# This cannot be used for internal load balancing.
Sai Cheemalapati	ea3a5e1	2016-10-12 14:05:53 -0700	[diff] [blame^]	332	"maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
				333	#
				334	# This cannot be used for internal load balancing.
				335	"balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	336	#
				337	# This cannot be used for internal load balancing.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	338	},
				339	],
				340	"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.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	341	"portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
				342	#
				343	# When the load balancing scheme is INTERNAL, this field is not used.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	344	"healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	345	#
				346	# For internal load balancing, a URL to a HealthCheck resource must be specified instead.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	347	"A String",
				348	],
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	349	"sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
				350	#
				351	# When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
				352	#
				353	# When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
				354	#
				355	# When the protocol is UDP, this field is not used.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	356	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	357	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	358	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				359	"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.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	360	}
				361
				362
				363	Returns:
				364	An object of the form:
				365
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	366	{ # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	367	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				368	"clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	369	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	370	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				371	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				372	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				373	"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	374	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	375	"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.
				376	"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.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	377	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	378	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				379	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	380	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	381	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	382	"message": "A String", # [Output Only] A human-readable description of the warning code.
				383	"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.
				384	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				385	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	386	{
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	387	"value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	388	"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).
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	389	},
				390	],
				391	},
				392	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	393	"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	394	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				395	"kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	396	"name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	397	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	398	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	399	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	400	{
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	401	"message": "A String", # [Output Only] An optional, human-readable error message.
				402	"code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	403	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	404	},
				405	],
				406	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	407	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	408	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Sai Cheemalapati	ea3a5e1	2016-10-12 14:05:53 -0700	[diff] [blame^]	409	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	410	}</pre>
				411	</div>
				412
				413	<div class="method">
Sai Cheemalapati	ea3a5e1	2016-10-12 14:05:53 -0700	[diff] [blame^]	414	<code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	415	<pre>Retrieves the list of BackendService resources available to the specified project.
				416
				417	Args:
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	418	project: string, Project ID for this request. (required)
Sai Cheemalapati	ea3a5e1	2016-10-12 14:05:53 -0700	[diff] [blame^]	419	orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
				420
				421	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.
				422
				423	Currently, only sorting by name or creationTimestamp desc is supported.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	424	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.
				425	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.
				426	filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	427
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	428	The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	429
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	430	For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	431
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	432	You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	433
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	434	To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	435
				436	Returns:
				437	An object of the form:
				438
				439	{ # Contains a list of BackendService resources.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	440	"nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	441	"items": [ # A list of BackendService resources.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	442	{ # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
Sai Cheemalapati	ea3a5e1	2016-10-12 14:05:53 -0700	[diff] [blame^]	443	"connectionDraining": { # Message containing connection draining configuration.
				444	"drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
				445	},
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	446	"kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	447	"protocol": "A String", # The protocol this BackendService uses to communicate with backends.
				448	#
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	449	# Possible values are HTTP, HTTPS, HTTP2, TCP and SSL. The default is HTTP.
				450	#
				451	# For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	452	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	453	"timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	454	"enableCDN": True or False, # If true, enable Cloud CDN for this BackendService.
				455	#
				456	# When the load balancing scheme is INTERNAL, this field is not used.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	457	"region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	458	"affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
				459	#
				460	# When the load balancing scheme is INTERNAL, this field is not used.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	461	"port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	462	#
				463	# This cannot be used for internal load balancing.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	464	"backends": [ # The list of backends that serve this BackendService.
				465	{ # Message containing information of one individual backend.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	466	"group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
				467	#
				468	# Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	469	#
				470	# When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	471	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	472	"maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	473	#
				474	# This cannot be used for internal load balancing.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	475	"maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	476	#
				477	# This cannot be used for internal load balancing.
Sai Cheemalapati	ea3a5e1	2016-10-12 14:05:53 -0700	[diff] [blame^]	478	"maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
				479	#
				480	# This cannot be used for internal load balancing.
				481	"capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	482	#
				483	# This cannot be used for internal load balancing.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	484	"maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	485	#
				486	# This cannot be used for internal load balancing.
Sai Cheemalapati	ea3a5e1	2016-10-12 14:05:53 -0700	[diff] [blame^]	487	"maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
				488	#
				489	# This cannot be used for internal load balancing.
				490	"balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	491	#
				492	# This cannot be used for internal load balancing.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	493	},
				494	],
				495	"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.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	496	"portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
				497	#
				498	# When the load balancing scheme is INTERNAL, this field is not used.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	499	"healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	500	#
				501	# For internal load balancing, a URL to a HealthCheck resource must be specified instead.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	502	"A String",
				503	],
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	504	"sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
				505	#
				506	# When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
				507	#
				508	# When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
				509	#
				510	# When the protocol is UDP, this field is not used.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	511	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	512	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	513	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				514	"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.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	515	},
				516	],
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	517	"kind": "compute#backendServiceList", # [Output Only] Type of resource. Always compute#backendServiceList for lists of backend services.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	518	"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	519	"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	520	}</pre>
				521	</div>
				522
				523	<div class="method">
				524	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				525	<pre>Retrieves the next page of results.
				526
				527	Args:
				528	previous_request: The request for the previous page. (required)
				529	previous_response: The response from the request for the previous page. (required)
				530
				531	Returns:
				532	A request object that you can call 'execute()' on to request the next
				533	page. Returns None if there are no more items in the collection.
				534	</pre>
				535	</div>
				536
				537	<div class="method">
				538	<code class="details" id="patch">patch(project, backendService, body)</code>
Sai Cheemalapati	ea3a5e1	2016-10-12 14:05:53 -0700	[diff] [blame^]	539	<pre>Updates the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports patch semantics.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	540
				541	Args:
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	542	project: string, Project ID for this request. (required)
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	543	backendService: string, Name of the BackendService resource to update. (required)
				544	body: object, The request body. (required)
				545	The object takes the form of:
				546
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	547	{ # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
Sai Cheemalapati	ea3a5e1	2016-10-12 14:05:53 -0700	[diff] [blame^]	548	"connectionDraining": { # Message containing connection draining configuration.
				549	"drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
				550	},
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	551	"kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	552	"protocol": "A String", # The protocol this BackendService uses to communicate with backends.
				553	#
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	554	# Possible values are HTTP, HTTPS, HTTP2, TCP and SSL. The default is HTTP.
				555	#
				556	# For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	557	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	558	"timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	559	"enableCDN": True or False, # If true, enable Cloud CDN for this BackendService.
				560	#
				561	# When the load balancing scheme is INTERNAL, this field is not used.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	562	"region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	563	"affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
				564	#
				565	# When the load balancing scheme is INTERNAL, this field is not used.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	566	"port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	567	#
				568	# This cannot be used for internal load balancing.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	569	"backends": [ # The list of backends that serve this BackendService.
				570	{ # Message containing information of one individual backend.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	571	"group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
				572	#
				573	# Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	574	#
				575	# When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	576	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	577	"maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	578	#
				579	# This cannot be used for internal load balancing.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	580	"maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	581	#
				582	# This cannot be used for internal load balancing.
Sai Cheemalapati	ea3a5e1	2016-10-12 14:05:53 -0700	[diff] [blame^]	583	"maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
				584	#
				585	# This cannot be used for internal load balancing.
				586	"capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	587	#
				588	# This cannot be used for internal load balancing.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	589	"maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	590	#
				591	# This cannot be used for internal load balancing.
Sai Cheemalapati	ea3a5e1	2016-10-12 14:05:53 -0700	[diff] [blame^]	592	"maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
				593	#
				594	# This cannot be used for internal load balancing.
				595	"balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	596	#
				597	# This cannot be used for internal load balancing.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	598	},
				599	],
				600	"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.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	601	"portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
				602	#
				603	# When the load balancing scheme is INTERNAL, this field is not used.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	604	"healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	605	#
				606	# For internal load balancing, a URL to a HealthCheck resource must be specified instead.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	607	"A String",
				608	],
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	609	"sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
				610	#
				611	# When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
				612	#
				613	# When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
				614	#
				615	# When the protocol is UDP, this field is not used.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	616	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	617	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	618	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				619	"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.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	620	}
				621
				622
				623	Returns:
				624	An object of the form:
				625
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	626	{ # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	627	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				628	"clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	629	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	630	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				631	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				632	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				633	"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	634	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	635	"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.
				636	"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.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	637	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	638	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				639	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	640	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	641	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	642	"message": "A String", # [Output Only] A human-readable description of the warning code.
				643	"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.
				644	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				645	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	646	{
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	647	"value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	648	"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).
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	649	},
				650	],
				651	},
				652	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	653	"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	654	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				655	"kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	656	"name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	657	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	658	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	659	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	660	{
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	661	"message": "A String", # [Output Only] An optional, human-readable error message.
				662	"code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	663	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	664	},
				665	],
				666	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	667	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	668	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Sai Cheemalapati	ea3a5e1	2016-10-12 14:05:53 -0700	[diff] [blame^]	669	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	670	}</pre>
				671	</div>
				672
				673	<div class="method">
				674	<code class="details" id="update">update(project, backendService, body)</code>
Sai Cheemalapati	ea3a5e1	2016-10-12 14:05:53 -0700	[diff] [blame^]	675	<pre>Updates the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	676
				677	Args:
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	678	project: string, Project ID for this request. (required)
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	679	backendService: string, Name of the BackendService resource to update. (required)
				680	body: object, The request body. (required)
				681	The object takes the form of:
				682
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	683	{ # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
Sai Cheemalapati	ea3a5e1	2016-10-12 14:05:53 -0700	[diff] [blame^]	684	"connectionDraining": { # Message containing connection draining configuration.
				685	"drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started).
				686	},
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	687	"kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	688	"protocol": "A String", # The protocol this BackendService uses to communicate with backends.
				689	#
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	690	# Possible values are HTTP, HTTPS, HTTP2, TCP and SSL. The default is HTTP.
				691	#
				692	# For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	693	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	694	"timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	695	"enableCDN": True or False, # If true, enable Cloud CDN for this BackendService.
				696	#
				697	# When the load balancing scheme is INTERNAL, this field is not used.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	698	"region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	699	"affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
				700	#
				701	# When the load balancing scheme is INTERNAL, this field is not used.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	702	"port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	703	#
				704	# This cannot be used for internal load balancing.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	705	"backends": [ # The list of backends that serve this BackendService.
				706	{ # Message containing information of one individual backend.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	707	"group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
				708	#
				709	# Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	710	#
				711	# When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	712	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	713	"maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	714	#
				715	# This cannot be used for internal load balancing.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	716	"maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	717	#
				718	# This cannot be used for internal load balancing.
Sai Cheemalapati	ea3a5e1	2016-10-12 14:05:53 -0700	[diff] [blame^]	719	"maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
				720	#
				721	# This cannot be used for internal load balancing.
				722	"capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	723	#
				724	# This cannot be used for internal load balancing.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	725	"maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	726	#
				727	# This cannot be used for internal load balancing.
Sai Cheemalapati	ea3a5e1	2016-10-12 14:05:53 -0700	[diff] [blame^]	728	"maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
				729	#
				730	# This cannot be used for internal load balancing.
				731	"balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	732	#
				733	# This cannot be used for internal load balancing.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	734	},
				735	],
				736	"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.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	737	"portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
				738	#
				739	# When the load balancing scheme is INTERNAL, this field is not used.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	740	"healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	741	#
				742	# For internal load balancing, a URL to a HealthCheck resource must be specified instead.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	743	"A String",
				744	],
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	745	"sessionAffinity": "A String", # Type of session affinity to use. The default is NONE.
				746	#
				747	# When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
				748	#
				749	# When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
				750	#
				751	# When the protocol is UDP, this field is not used.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	752	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	753	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	754	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				755	"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.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	756	}
				757
				758
				759	Returns:
				760	An object of the form:
				761
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	762	{ # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	763	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				764	"clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	765	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	766	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				767	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				768	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				769	"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	770	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	771	"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.
				772	"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.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	773	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	774	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				775	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	776	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	777	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	778	"message": "A String", # [Output Only] A human-readable description of the warning code.
				779	"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.
				780	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				781	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	782	{
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	783	"value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	784	"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).
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	785	},
				786	],
				787	},
				788	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	789	"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	790	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				791	"kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	792	"name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	793	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	794	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	795	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	796	{
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	797	"message": "A String", # [Output Only] An optional, human-readable error message.
				798	"code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	799	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	800	},
				801	],
				802	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	803	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	804	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Sai Cheemalapati	ea3a5e1	2016-10-12 14:05:53 -0700	[diff] [blame^]	805	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	806	}</pre>
				807	</div>
				808
				809	</body></html>