Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 0669410c6b2c48884ae31671b9d710a9ff6346c6 / . / docs / dyn / compute_v1.backendServices.html
blob: adc21bee02259856a2bb263e7b7da23018f73f10 [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>
82<p class="firstline">Returns the specified BackendService resource.</p>
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>
88<p class="firstline">Creates a BackendService resource in the specified project using the data included in the request.</p>
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>
97<p class="firstline">Update the entire content of the BackendService resource. This method supports patch semantics.</p>
98<p class="toc_element">
99 <code><a href="#update">update(project, backendService, body)</a></code></p>
100<p class="firstline">Update the entire content of the BackendService resource.</p>
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:
107 project: string, Name of the project scoping this request. (required)
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.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]114 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]115 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]116 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]117 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]118 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
119 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
120 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]121 "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 at when the operation will be complete. This number should monotonically increase as the operation progresses.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]122 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]123 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]124 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
125 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
126 "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]127 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]128 "message": "A String", # [Output Only] Optional human-readable details for this warning.
129 "code": "A String", # [Output Only] The warning type identifier for this warning.
130 "data": [ # [Output Only] Metadata for this warning in key: value format.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]131 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]132 "value": "A String", # [Output Only] A warning data value corresponding to the key.
133 "key": "A String", # [Output Only] A key for the warning data.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]134 },
135 ],
136 },
137 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]138 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
139 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
140 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
141 "name": "A String", # [Output Only] Name of the resource.
142 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
143 "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]144 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]145 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]146 "message": "A String", # [Output Only] An optional, human-readable error message.
147 "code": "A String", # [Output Only] The error type identifier for this error.
148 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]149 },
150 ],
151 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]152 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]153 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]154 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]155 }</pre>
156</div>
157
158<div class="method">
159 <code class="details" id="get">get(project, backendService)</code>
160 <pre>Returns the specified BackendService resource.
161
162Args:
163 project: string, Name of the project scoping this request. (required)
164 backendService: string, Name of the BackendService resource to return. (required)
165
166Returns:
167 An object of the form:
168
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]169 { # A BackendService resource. This resource defines a group of backend virtual machines together with their serving capacity.
170 "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]171 "protocol": "A String",
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]172 "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]173 "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]174 "port": 42, # Deprecated in favor of port name. The TCP port to connect on the backend. The default value is 80.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]175 "backends": [ # The list of backends that serve this BackendService.
176 { # Message containing information of one individual backend.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]177 "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.
178 #
179 # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
180 "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
181 "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].
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]182 "maxRatePerInstance": 3.14, # The max RPS that a single backed 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^]183 "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].
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]184 "maxRate": 42, # The max RPS of the group. Can be used with either balancing mode, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]185 "balancingMode": "A String", # Specifies the balancing mode for this backend. The default is UTILIZATION but available values are UTILIZATION and RATE.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]186 },
187 ],
188 "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.
189 "portName": "A String", # Name of backend port. The same name should appear in the resource views referenced by this service. Required.
190 "healthChecks": [ # The list of URLs to the HttpHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
191 "A String",
192 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]193 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
194 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
195 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
196 "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]197 }</pre>
198</div>
199
200<div class="method">
201 <code class="details" id="getHealth">getHealth(project, backendService, body)</code>
202 <pre>Gets the most recent health check results for this BackendService.
203
204Args:
205 project: string, A parameter (required)
206 backendService: string, Name of the BackendService resource to which the queried instance belongs. (required)
207 body: object, The request body. (required)
208 The object takes the form of:
209
210{
211 "group": "A String", # A URI referencing one of the resource views listed in the backend service.
212 }
213
214
215Returns:
216 An object of the form:
217
218 {
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]219 "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]220 "healthStatus": [
221 {
222 "instance": "A String", # URL of the instance resource.
223 "healthState": "A String", # Health state of the instance.
224 "ipAddress": "A String", # The IP address represented by this resource.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]225 "port": 42, # The port on the instance.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]226 },
227 ],
228 }</pre>
229</div>
230
231<div class="method">
232 <code class="details" id="insert">insert(project, body)</code>
233 <pre>Creates a BackendService resource in the specified project using the data included in the request.
234
235Args:
236 project: string, Name of the project scoping this request. (required)
237 body: object, The request body. (required)
238 The object takes the form of:
239
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]240{ # A BackendService resource. This resource defines a group of backend virtual machines together with their serving capacity.
241 "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]242 "protocol": "A String",
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]243 "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]244 "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]245 "port": 42, # Deprecated in favor of port name. The TCP port to connect on the backend. The default value is 80.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]246 "backends": [ # The list of backends that serve this BackendService.
247 { # Message containing information of one individual backend.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]248 "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.
249 #
250 # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
251 "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
252 "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].
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]253 "maxRatePerInstance": 3.14, # The max RPS that a single backed 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^]254 "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].
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]255 "maxRate": 42, # The max RPS of the group. Can be used with either balancing mode, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]256 "balancingMode": "A String", # Specifies the balancing mode for this backend. The default is UTILIZATION but available values are UTILIZATION and RATE.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]257 },
258 ],
259 "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.
260 "portName": "A String", # Name of backend port. The same name should appear in the resource views referenced by this service. Required.
261 "healthChecks": [ # The list of URLs to the HttpHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
262 "A String",
263 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]264 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
265 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
266 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
267 "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]268 }
269
270
271Returns:
272 An object of the form:
273
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]274 { # An Operation resource, used to manage asynchronous API requests.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]275 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]276 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]277 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]278 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]279 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
280 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
281 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]282 "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 at when the operation will be complete. This number should monotonically increase as the operation progresses.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]283 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]284 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]285 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
286 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
287 "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]288 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]289 "message": "A String", # [Output Only] Optional human-readable details for this warning.
290 "code": "A String", # [Output Only] The warning type identifier for this warning.
291 "data": [ # [Output Only] Metadata for this warning in key: value format.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]292 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]293 "value": "A String", # [Output Only] A warning data value corresponding to the key.
294 "key": "A String", # [Output Only] A key for the warning data.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]295 },
296 ],
297 },
298 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]299 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
300 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
301 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
302 "name": "A String", # [Output Only] Name of the resource.
303 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
304 "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]305 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]306 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]307 "message": "A String", # [Output Only] An optional, human-readable error message.
308 "code": "A String", # [Output Only] The error type identifier for this error.
309 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]310 },
311 ],
312 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]313 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]314 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]315 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]316 }</pre>
317</div>
318
319<div class="method">
320 <code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
321 <pre>Retrieves the list of BackendService resources available to the specified project.
322
323Args:
324 project: string, Name of the project scoping this request. (required)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]325 maxResults: integer, Maximum count of results to be returned.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]326 pageToken: string, Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.
327 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.
328
329The 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 (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.
330
331For example, filter=name ne example-instance.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]332
333Returns:
334 An object of the form:
335
336 { # Contains a list of BackendService resources.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]337 "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]338 "items": [ # A list of BackendService resources.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]339 { # A BackendService resource. This resource defines a group of backend virtual machines together with their serving capacity.
340 "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]341 "protocol": "A String",
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]342 "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]343 "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]344 "port": 42, # Deprecated in favor of port name. The TCP port to connect on the backend. The default value is 80.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]345 "backends": [ # The list of backends that serve this BackendService.
346 { # Message containing information of one individual backend.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]347 "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.
348 #
349 # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
350 "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
351 "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].
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]352 "maxRatePerInstance": 3.14, # The max RPS that a single backed 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^]353 "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].
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]354 "maxRate": 42, # The max RPS of the group. Can be used with either balancing mode, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]355 "balancingMode": "A String", # Specifies the balancing mode for this backend. The default is UTILIZATION but available values are UTILIZATION and RATE.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]356 },
357 ],
358 "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.
359 "portName": "A String", # Name of backend port. The same name should appear in the resource views referenced by this service. Required.
360 "healthChecks": [ # The list of URLs to the HttpHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
361 "A String",
362 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]363 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
364 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
365 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
366 "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]367 },
368 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]369 "kind": "compute#backendServiceList", # [Output Only] Type of resource. Always compute#backendServiceList for lists of backend services.
370 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
371 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]372 }</pre>
373</div>
374
375<div class="method">
376 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
377 <pre>Retrieves the next page of results.
378
379Args:
380 previous_request: The request for the previous page. (required)
381 previous_response: The response from the request for the previous page. (required)
382
383Returns:
384 A request object that you can call 'execute()' on to request the next
385 page. Returns None if there are no more items in the collection.
386 </pre>
387</div>
388
389<div class="method">
390 <code class="details" id="patch">patch(project, backendService, body)</code>
391 <pre>Update the entire content of the BackendService resource. This method supports patch semantics.
392
393Args:
394 project: string, Name of the project scoping this request. (required)
395 backendService: string, Name of the BackendService resource to update. (required)
396 body: object, The request body. (required)
397 The object takes the form of:
398
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]399{ # A BackendService resource. This resource defines a group of backend virtual machines together with their serving capacity.
400 "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]401 "protocol": "A String",
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]402 "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]403 "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]404 "port": 42, # Deprecated in favor of port name. The TCP port to connect on the backend. The default value is 80.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]405 "backends": [ # The list of backends that serve this BackendService.
406 { # Message containing information of one individual backend.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]407 "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.
408 #
409 # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
410 "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
411 "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].
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]412 "maxRatePerInstance": 3.14, # The max RPS that a single backed 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^]413 "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].
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]414 "maxRate": 42, # The max RPS of the group. Can be used with either balancing mode, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]415 "balancingMode": "A String", # Specifies the balancing mode for this backend. The default is UTILIZATION but available values are UTILIZATION and RATE.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]416 },
417 ],
418 "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.
419 "portName": "A String", # Name of backend port. The same name should appear in the resource views referenced by this service. Required.
420 "healthChecks": [ # The list of URLs to the HttpHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
421 "A String",
422 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]423 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
424 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
425 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
426 "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]427 }
428
429
430Returns:
431 An object of the form:
432
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]433 { # An Operation resource, used to manage asynchronous API requests.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]434 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]435 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]436 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]437 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]438 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
439 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
440 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]441 "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 at when the operation will be complete. This number should monotonically increase as the operation progresses.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]442 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]443 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]444 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
445 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
446 "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]447 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]448 "message": "A String", # [Output Only] Optional human-readable details for this warning.
449 "code": "A String", # [Output Only] The warning type identifier for this warning.
450 "data": [ # [Output Only] Metadata for this warning in key: value format.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]451 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]452 "value": "A String", # [Output Only] A warning data value corresponding to the key.
453 "key": "A String", # [Output Only] A key for the warning data.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]454 },
455 ],
456 },
457 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]458 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
459 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
460 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
461 "name": "A String", # [Output Only] Name of the resource.
462 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
463 "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]464 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]465 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]466 "message": "A String", # [Output Only] An optional, human-readable error message.
467 "code": "A String", # [Output Only] The error type identifier for this error.
468 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]469 },
470 ],
471 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]472 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]473 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]474 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]475 }</pre>
476</div>
477
478<div class="method">
479 <code class="details" id="update">update(project, backendService, body)</code>
480 <pre>Update the entire content of the BackendService resource.
481
482Args:
483 project: string, Name of the project scoping this request. (required)
484 backendService: string, Name of the BackendService resource to update. (required)
485 body: object, The request body. (required)
486 The object takes the form of:
487
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]488{ # A BackendService resource. This resource defines a group of backend virtual machines together with their serving capacity.
489 "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]490 "protocol": "A String",
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]491 "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]492 "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]493 "port": 42, # Deprecated in favor of port name. The TCP port to connect on the backend. The default value is 80.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]494 "backends": [ # The list of backends that serve this BackendService.
495 { # Message containing information of one individual backend.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]496 "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.
497 #
498 # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
499 "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
500 "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].
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]501 "maxRatePerInstance": 3.14, # The max RPS that a single backed 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^]502 "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].
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]503 "maxRate": 42, # The max RPS of the group. Can be used with either balancing mode, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]504 "balancingMode": "A String", # Specifies the balancing mode for this backend. The default is UTILIZATION but available values are UTILIZATION and RATE.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]505 },
506 ],
507 "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.
508 "portName": "A String", # Name of backend port. The same name should appear in the resource views referenced by this service. Required.
509 "healthChecks": [ # The list of URLs to the HttpHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
510 "A String",
511 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]512 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
513 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
514 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
515 "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]516 }
517
518
519Returns:
520 An object of the form:
521
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]522 { # An Operation resource, used to manage asynchronous API requests.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]523 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]524 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]525 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]526 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]527 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
528 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
529 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]530 "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 at when the operation will be complete. This number should monotonically increase as the operation progresses.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]531 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]532 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]533 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
534 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
535 "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]536 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]537 "message": "A String", # [Output Only] Optional human-readable details for this warning.
538 "code": "A String", # [Output Only] The warning type identifier for this warning.
539 "data": [ # [Output Only] Metadata for this warning in key: value format.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]540 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]541 "value": "A String", # [Output Only] A warning data value corresponding to the key.
542 "key": "A String", # [Output Only] A key for the warning data.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]543 },
544 ],
545 },
546 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]547 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
548 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
549 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
550 "name": "A String", # [Output Only] Name of the resource.
551 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
552 "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]553 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]554 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]555 "message": "A String", # [Output Only] An optional, human-readable error message.
556 "code": "A String", # [Output Only] The error type identifier for this error.
557 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]558 },
559 ],
560 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]561 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]562 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]563 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]564 }</pre>
565</div>
566
567</body></html>