Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 0a471d3d1d3c16eeda1d1a1288f99be9f8027475 / . / docs / dyn / compute_v1.backendServices.html
blob: 12a57dd65e05a331d1ffc2760874a03d5bcf9b54 [file] [log] [blame]
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]1<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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 Parrott0a471d32016-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 Citro065b5302014-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 Parrott36e41bc2016-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 Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]89<p class="toc_element">
90 <code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
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>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]97<p class="firstline">Updates the entire content of the BackendService resource. 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 Citro065b5302014-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>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]100<p class="firstline">Updates the entire content of the BackendService resource. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information.</p>
Craig Citro065b5302014-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
106Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]107 project: string, Project ID for this request. (required)
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]108 backendService: string, Name of the BackendService resource to delete. (required)
109
110Returns:
111 An object of the form:
112
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]113 { # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott36e41bc2016-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 Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]116 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-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 Manista5cbe5ba2015-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 Parrott36e41bc2016-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 Citroe633be12015-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 Parrott36e41bc2016-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 Manista5cbe5ba2015-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 Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]128 {
Jon Wayne Parrott36e41bc2016-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 Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]133 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]134 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-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 Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]136 },
137 ],
138 },
139 ],
Nathaniel Manista5cbe5ba2015-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 Parrott36e41bc2016-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 Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]143 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-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 Manista5cbe5ba2015-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 Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]146 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]147 {
Craig Citroe633be12015-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 Parrott0a471d32016-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 Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]151 },
152 ],
153 },
Jon Wayne Parrott36e41bc2016-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 Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]155 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]156 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
Craig Citro065b5302014-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 Parrott0a471d32016-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 Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]163
164Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]165 project: string, Project ID for this request. (required)
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]166 backendService: string, Name of the BackendService resource to return. (required)
167
168Returns:
169 An object of the form:
170
Jon Wayne Parrott36e41bc2016-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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]172 "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]173 "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
174 #
175 # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL.
176 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]177 "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]178 "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 Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]179 "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]180 "backends": [ # The list of backends that serve this BackendService.
181 { # Message containing information of one individual backend.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]182 "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.
183 #
184 # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]185 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]186 "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 Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]187 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]188 "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (either UTILIZATION or RATE). Default value is 1, which means the group will serve up to 100% of its configured CPU or RPS (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available CPU or RPS. Valid range is [0.0,1.0].
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]189 "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.
190 "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) load balancing, the default is UTILIZATION. Valid values are UTILIZATION and RATE.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]191 },
192 ],
193 "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 Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]194 "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required.
195 "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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]196 "A String",
197 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]198 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]199 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]200 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
201 "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 Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]202 }</pre>
203</div>
204
205<div class="method">
206 <code class="details" id="getHealth">getHealth(project, backendService, body)</code>
207 <pre>Gets the most recent health check results for this BackendService.
208
209Args:
210 project: string, A parameter (required)
211 backendService: string, Name of the BackendService resource to which the queried instance belongs. (required)
212 body: object, The request body. (required)
213 The object takes the form of:
214
215{
216 "group": "A String", # A URI referencing one of the resource views listed in the backend service.
217 }
218
219
220Returns:
221 An object of the form:
222
223 {
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]224 "kind": "compute#backendServiceGroupHealth", # [Output Only] Type of resource. Always compute#backendServiceGroupHealth for the health of backend services.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]225 "healthStatus": [
226 {
227 "instance": "A String", # URL of the instance resource.
228 "healthState": "A String", # Health state of the instance.
229 "ipAddress": "A String", # The IP address represented by this resource.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]230 "port": 42, # The port on the instance.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]231 },
232 ],
233 }</pre>
234</div>
235
236<div class="method">
237 <code class="details" id="insert">insert(project, body)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]238 <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 Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]239
240Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]241 project: string, Project ID for this request. (required)
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]242 body: object, The request body. (required)
243 The object takes the form of:
244
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]245{ # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]246 "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]247 "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
248 #
249 # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL.
250 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]251 "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]252 "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 Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]253 "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]254 "backends": [ # The list of backends that serve this BackendService.
255 { # Message containing information of one individual backend.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]256 "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.
257 #
258 # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]259 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]260 "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 Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]261 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]262 "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (either UTILIZATION or RATE). Default value is 1, which means the group will serve up to 100% of its configured CPU or RPS (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available CPU or RPS. Valid range is [0.0,1.0].
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]263 "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.
264 "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) load balancing, the default is UTILIZATION. Valid values are UTILIZATION and RATE.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]265 },
266 ],
267 "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 Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]268 "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required.
269 "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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]270 "A String",
271 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]272 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]273 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]274 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
275 "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 Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]276 }
277
278
279Returns:
280 An object of the form:
281
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]282 { # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]283 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
284 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]285 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]286 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
287 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
288 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
289 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]290 "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 Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]291 "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.
292 "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 Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]293 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]294 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
295 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]296 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]297 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]298 "message": "A String", # [Output Only] A human-readable description of the warning code.
299 "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.
300 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
301 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]302 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]303 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]304 "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 Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]305 },
306 ],
307 },
308 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]309 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]310 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
311 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]312 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]313 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]314 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]315 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]316 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]317 "message": "A String", # [Output Only] An optional, human-readable error message.
318 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]319 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]320 },
321 ],
322 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]323 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]324 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]325 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]326 }</pre>
327</div>
328
329<div class="method">
330 <code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
331 <pre>Retrieves the list of BackendService resources available to the specified project.
332
333Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]334 project: string, Project ID for this request. (required)
335 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.
336 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.
337 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 Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]338
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]339The 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 Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]340
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]341For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]342
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]343Compute Engine Beta API Only: When filtering in the Beta API, you can also 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 Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]344
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]345The Beta API also supports filtering on multiple expressions by providing 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 Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]346
347Returns:
348 An object of the form:
349
350 { # Contains a list of BackendService resources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]351 "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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]352 "items": [ # A list of BackendService resources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]353 { # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]354 "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]355 "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
356 #
357 # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL.
358 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]359 "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]360 "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 Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]361 "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]362 "backends": [ # The list of backends that serve this BackendService.
363 { # Message containing information of one individual backend.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]364 "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.
365 #
366 # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]367 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]368 "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 Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]369 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]370 "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (either UTILIZATION or RATE). Default value is 1, which means the group will serve up to 100% of its configured CPU or RPS (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available CPU or RPS. Valid range is [0.0,1.0].
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]371 "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.
372 "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) load balancing, the default is UTILIZATION. Valid values are UTILIZATION and RATE.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]373 },
374 ],
375 "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 Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]376 "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required.
377 "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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]378 "A String",
379 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]380 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]381 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]382 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
383 "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 Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]384 },
385 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]386 "kind": "compute#backendServiceList", # [Output Only] Type of resource. Always compute#backendServiceList for lists of backend services.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]387 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]388 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]389 }</pre>
390</div>
391
392<div class="method">
393 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
394 <pre>Retrieves the next page of results.
395
396Args:
397 previous_request: The request for the previous page. (required)
398 previous_response: The response from the request for the previous page. (required)
399
400Returns:
401 A request object that you can call 'execute()' on to request the next
402 page. Returns None if there are no more items in the collection.
403 </pre>
404</div>
405
406<div class="method">
407 <code class="details" id="patch">patch(project, backendService, body)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]408 <pre>Updates the entire content of the BackendService resource. 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 Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]409
410Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]411 project: string, Project ID for this request. (required)
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]412 backendService: string, Name of the BackendService resource to update. (required)
413 body: object, The request body. (required)
414 The object takes the form of:
415
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]416{ # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]417 "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]418 "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
419 #
420 # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL.
421 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]422 "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]423 "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 Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]424 "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]425 "backends": [ # The list of backends that serve this BackendService.
426 { # Message containing information of one individual backend.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]427 "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.
428 #
429 # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]430 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]431 "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 Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]432 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]433 "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (either UTILIZATION or RATE). Default value is 1, which means the group will serve up to 100% of its configured CPU or RPS (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available CPU or RPS. Valid range is [0.0,1.0].
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]434 "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.
435 "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) load balancing, the default is UTILIZATION. Valid values are UTILIZATION and RATE.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]436 },
437 ],
438 "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 Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]439 "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required.
440 "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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]441 "A String",
442 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]443 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]444 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]445 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
446 "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 Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]447 }
448
449
450Returns:
451 An object of the form:
452
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]453 { # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]454 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
455 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]456 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]457 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
458 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
459 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
460 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]461 "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 Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]462 "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.
463 "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 Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]464 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]465 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
466 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]467 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]468 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]469 "message": "A String", # [Output Only] A human-readable description of the warning code.
470 "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.
471 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
472 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]473 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]474 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]475 "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 Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]476 },
477 ],
478 },
479 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]480 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]481 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
482 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]483 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]484 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]485 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]486 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]487 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]488 "message": "A String", # [Output Only] An optional, human-readable error message.
489 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]490 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]491 },
492 ],
493 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]494 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]495 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]496 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]497 }</pre>
498</div>
499
500<div class="method">
501 <code class="details" id="update">update(project, backendService, body)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]502 <pre>Updates the entire content of the BackendService resource. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]503
504Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]505 project: string, Project ID for this request. (required)
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]506 backendService: string, Name of the BackendService resource to update. (required)
507 body: object, The request body. (required)
508 The object takes the form of:
509
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]510{ # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]511 "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]512 "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
513 #
514 # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL.
515 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]516 "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]517 "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 Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]518 "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]519 "backends": [ # The list of backends that serve this BackendService.
520 { # Message containing information of one individual backend.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]521 "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.
522 #
523 # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]524 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]525 "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 Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]526 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]527 "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (either UTILIZATION or RATE). Default value is 1, which means the group will serve up to 100% of its configured CPU or RPS (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available CPU or RPS. Valid range is [0.0,1.0].
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]528 "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.
529 "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) load balancing, the default is UTILIZATION. Valid values are UTILIZATION and RATE.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]530 },
531 ],
532 "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 Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]533 "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required.
534 "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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]535 "A String",
536 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]537 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]538 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]539 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
540 "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 Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]541 }
542
543
544Returns:
545 An object of the form:
546
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]547 { # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]548 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
549 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]550 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]551 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
552 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
553 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
554 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]555 "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 Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]556 "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.
557 "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 Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]558 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]559 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
560 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]561 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]562 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]563 "message": "A String", # [Output Only] A human-readable description of the warning code.
564 "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.
565 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
566 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]567 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]568 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]569 "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 Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]570 },
571 ],
572 },
573 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]574 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]575 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
576 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]577 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]578 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]579 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]580 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]581 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]582 "message": "A String", # [Output Only] An optional, human-readable error message.
583 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]584 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]585 },
586 ],
587 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]588 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]589 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]590 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]591 }</pre>
592</div>
593
594</body></html>