Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c1f8beda2812f174908cf495687a15638482e309 / . / docs / dyn / compute_v1.backendServices.html
blob: 0e83754d2356e8fbfefc131517141c4a0782d4fa [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
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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[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.
Craig Citroe633be12015-03-02 13:40:36 -0800[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
169 { # A BackendService resource. This resource defines a group of backend VMs together with their serving capacity.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]170 #
171 # If you add field foo, you probably need to also add: com.google.cloud.cluster.manager.api.BackendServiceResource: foo com.google.cloud.cluster.manager.networking.entities: BackendService, BackendServiceEntity: getFoo, setFoo:
172 #
173 # Converters/mappers will need to be updated: com.google.cloud.cluster.manager.networking.services.backendservice.BackendServiceResourceConverter: toResource, updateEntity: copy foo com.google.cloud.cluster.mixer.protomappers.BackendServiceMappers.ResourceMapper: ResourceMapper: add a new map call
174 #
175 # Tests to update: com.google.cloud.cluster.manager.networking.services.backendservice.BackendServiceResourceConverterTest com.google.cloud.cluster.mixer.protomappers.BackendServiceMappersTest.testResourceMapping
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]176 "kind": "compute#backendService", # Type of the resource.
177 "protocol": "A String",
178 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
179 "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]180 "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]181 "backends": [ # The list of backends that serve this BackendService.
182 { # Message containing information of one individual backend.
183 "group": "A String", # URL of a zonal Cloud Resource View resource. This resource view defines the list of instances that serve traffic. Member virtual machine instances from each resource view must live in the same zone as the resource view itself. No two backends in a backend service are allowed to use same Resource View resource.
184 "description": "A String", # An optional textual description of the resource, which is provided by the client when the resource is created.
185 "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, 1].
186 "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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]187 "capacityScaler": 3.14, # The multiplier (a value between 0.0 and 1.0) of the max capacity (CPU or RPS, depending on 'balancingMode') the group should serve up to. 0 means the group is totally drained. Default value is 1. Valid range is [0.0, 1.0].
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]188 "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.
189 "balancingMode": "A String", # The balancing mode of this backend, default is UTILIZATION.
190 },
191 ],
192 "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.
193 "portName": "A String", # Name of backend port. The same name should appear in the resource views referenced by this service. Required.
194 "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.
195 "A String",
196 ],
197 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
198 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
199 "selfLink": "A String", # Server defined URL for the resource (output only).
200 "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.
201 }</pre>
202</div>
203
204<div class="method">
205 <code class="details" id="getHealth">getHealth(project, backendService, body)</code>
206 <pre>Gets the most recent health check results for this BackendService.
207
208Args:
209 project: string, A parameter (required)
210 backendService: string, Name of the BackendService resource to which the queried instance belongs. (required)
211 body: object, The request body. (required)
212 The object takes the form of:
213
214{
215 "group": "A String", # A URI referencing one of the resource views listed in the backend service.
216 }
217
218
219Returns:
220 An object of the form:
221
222 {
223 "kind": "compute#backendServiceGroupHealth", # Type of resource.
224 "healthStatus": [
225 {
226 "instance": "A String", # URL of the instance resource.
227 "healthState": "A String", # Health state of the instance.
228 "ipAddress": "A String", # The IP address represented by this resource.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]229 "port": 42, # The port on the instance.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]230 },
231 ],
232 }</pre>
233</div>
234
235<div class="method">
236 <code class="details" id="insert">insert(project, body)</code>
237 <pre>Creates a BackendService resource in the specified project using the data included in the request.
238
239Args:
240 project: string, Name of the project scoping this request. (required)
241 body: object, The request body. (required)
242 The object takes the form of:
243
244{ # A BackendService resource. This resource defines a group of backend VMs together with their serving capacity.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]245 #
246 # If you add field foo, you probably need to also add: com.google.cloud.cluster.manager.api.BackendServiceResource: foo com.google.cloud.cluster.manager.networking.entities: BackendService, BackendServiceEntity: getFoo, setFoo:
247 #
248 # Converters/mappers will need to be updated: com.google.cloud.cluster.manager.networking.services.backendservice.BackendServiceResourceConverter: toResource, updateEntity: copy foo com.google.cloud.cluster.mixer.protomappers.BackendServiceMappers.ResourceMapper: ResourceMapper: add a new map call
249 #
250 # Tests to update: com.google.cloud.cluster.manager.networking.services.backendservice.BackendServiceResourceConverterTest com.google.cloud.cluster.mixer.protomappers.BackendServiceMappersTest.testResourceMapping
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]251 "kind": "compute#backendService", # Type of the resource.
252 "protocol": "A String",
253 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
254 "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]255 "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]256 "backends": [ # The list of backends that serve this BackendService.
257 { # Message containing information of one individual backend.
258 "group": "A String", # URL of a zonal Cloud Resource View resource. This resource view defines the list of instances that serve traffic. Member virtual machine instances from each resource view must live in the same zone as the resource view itself. No two backends in a backend service are allowed to use same Resource View resource.
259 "description": "A String", # An optional textual description of the resource, which is provided by the client when the resource is created.
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, 1].
261 "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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]262 "capacityScaler": 3.14, # The multiplier (a value between 0.0 and 1.0) of the max capacity (CPU or RPS, depending on 'balancingMode') the group should serve up to. 0 means the group is totally drained. Default value is 1. Valid range is [0.0, 1.0].
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]263 "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.
264 "balancingMode": "A String", # The balancing mode of this backend, default is UTILIZATION.
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.
268 "portName": "A String", # Name of backend port. The same name should appear in the resource views referenced by this service. Required.
269 "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.
270 "A String",
271 ],
272 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
273 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
274 "selfLink": "A String", # Server defined URL for the resource (output only).
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.
276 }
277
278
279Returns:
280 An object of the form:
281
282 { # An operation resource, used to manage asynchronous API requests.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]283 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]284 "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]285 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]286 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]287 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
288 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
289 "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]290 "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]291 "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]292 "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]293 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
294 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
295 "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]296 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]297 "message": "A String", # [Output Only] Optional human-readable details for this warning.
298 "code": "A String", # [Output Only] The warning type identifier for this warning.
299 "data": [ # [Output Only] Metadata for this warning in key: value format.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]300 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]301 "value": "A String", # [Output Only] A warning data value corresponding to the key.
302 "key": "A String", # [Output Only] A key for the warning data.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]303 },
304 ],
305 },
306 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]307 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
308 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
309 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
310 "name": "A String", # [Output Only] Name of the resource.
311 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
312 "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]313 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]314 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]315 "message": "A String", # [Output Only] An optional, human-readable error message.
316 "code": "A String", # [Output Only] The error type identifier for this error.
317 "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]318 },
319 ],
320 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]321 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]322 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]323 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]324 }</pre>
325</div>
326
327<div class="method">
328 <code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
329 <pre>Retrieves the list of BackendService resources available to the specified project.
330
331Args:
332 project: string, Name of the project scoping this request. (required)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]333 maxResults: integer, Maximum count of results to be returned.
334 pageToken: string, Tag returned by a previous list request when that list was truncated to maxResults. Used to continue a previous list request.
335 filter: string, Filter expression for filtering listed resources.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]336
337Returns:
338 An object of the form:
339
340 { # Contains a list of BackendService resources.
341 "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]342 "items": [ # A list of BackendService resources.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]343 { # A BackendService resource. This resource defines a group of backend VMs together with their serving capacity.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]344 #
345 # If you add field foo, you probably need to also add: com.google.cloud.cluster.manager.api.BackendServiceResource: foo com.google.cloud.cluster.manager.networking.entities: BackendService, BackendServiceEntity: getFoo, setFoo:
346 #
347 # Converters/mappers will need to be updated: com.google.cloud.cluster.manager.networking.services.backendservice.BackendServiceResourceConverter: toResource, updateEntity: copy foo com.google.cloud.cluster.mixer.protomappers.BackendServiceMappers.ResourceMapper: ResourceMapper: add a new map call
348 #
349 # Tests to update: com.google.cloud.cluster.manager.networking.services.backendservice.BackendServiceResourceConverterTest com.google.cloud.cluster.mixer.protomappers.BackendServiceMappersTest.testResourceMapping
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]350 "kind": "compute#backendService", # Type of the resource.
351 "protocol": "A String",
352 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
353 "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]354 "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]355 "backends": [ # The list of backends that serve this BackendService.
356 { # Message containing information of one individual backend.
357 "group": "A String", # URL of a zonal Cloud Resource View resource. This resource view defines the list of instances that serve traffic. Member virtual machine instances from each resource view must live in the same zone as the resource view itself. No two backends in a backend service are allowed to use same Resource View resource.
358 "description": "A String", # An optional textual description of the resource, which is provided by the client when the resource is created.
359 "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, 1].
360 "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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]361 "capacityScaler": 3.14, # The multiplier (a value between 0.0 and 1.0) of the max capacity (CPU or RPS, depending on 'balancingMode') the group should serve up to. 0 means the group is totally drained. Default value is 1. Valid range is [0.0, 1.0].
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]362 "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.
363 "balancingMode": "A String", # The balancing mode of this backend, default is UTILIZATION.
364 },
365 ],
366 "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.
367 "portName": "A String", # Name of backend port. The same name should appear in the resource views referenced by this service. Required.
368 "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.
369 "A String",
370 ],
371 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
372 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
373 "selfLink": "A String", # Server defined URL for the resource (output only).
374 "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.
375 },
376 ],
377 "kind": "compute#backendServiceList", # Type of resource.
378 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
379 "selfLink": "A String", # Server defined URL for this resource (output only).
380 }</pre>
381</div>
382
383<div class="method">
384 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
385 <pre>Retrieves the next page of results.
386
387Args:
388 previous_request: The request for the previous page. (required)
389 previous_response: The response from the request for the previous page. (required)
390
391Returns:
392 A request object that you can call 'execute()' on to request the next
393 page. Returns None if there are no more items in the collection.
394 </pre>
395</div>
396
397<div class="method">
398 <code class="details" id="patch">patch(project, backendService, body)</code>
399 <pre>Update the entire content of the BackendService resource. This method supports patch semantics.
400
401Args:
402 project: string, Name of the project scoping this request. (required)
403 backendService: string, Name of the BackendService resource to update. (required)
404 body: object, The request body. (required)
405 The object takes the form of:
406
407{ # A BackendService resource. This resource defines a group of backend VMs together with their serving capacity.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]408 #
409 # If you add field foo, you probably need to also add: com.google.cloud.cluster.manager.api.BackendServiceResource: foo com.google.cloud.cluster.manager.networking.entities: BackendService, BackendServiceEntity: getFoo, setFoo:
410 #
411 # Converters/mappers will need to be updated: com.google.cloud.cluster.manager.networking.services.backendservice.BackendServiceResourceConverter: toResource, updateEntity: copy foo com.google.cloud.cluster.mixer.protomappers.BackendServiceMappers.ResourceMapper: ResourceMapper: add a new map call
412 #
413 # Tests to update: com.google.cloud.cluster.manager.networking.services.backendservice.BackendServiceResourceConverterTest com.google.cloud.cluster.mixer.protomappers.BackendServiceMappersTest.testResourceMapping
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]414 "kind": "compute#backendService", # Type of the resource.
415 "protocol": "A String",
416 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
417 "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]418 "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]419 "backends": [ # The list of backends that serve this BackendService.
420 { # Message containing information of one individual backend.
421 "group": "A String", # URL of a zonal Cloud Resource View resource. This resource view defines the list of instances that serve traffic. Member virtual machine instances from each resource view must live in the same zone as the resource view itself. No two backends in a backend service are allowed to use same Resource View resource.
422 "description": "A String", # An optional textual description of the resource, which is provided by the client when the resource is created.
423 "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, 1].
424 "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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]425 "capacityScaler": 3.14, # The multiplier (a value between 0.0 and 1.0) of the max capacity (CPU or RPS, depending on 'balancingMode') the group should serve up to. 0 means the group is totally drained. Default value is 1. Valid range is [0.0, 1.0].
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]426 "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.
427 "balancingMode": "A String", # The balancing mode of this backend, default is UTILIZATION.
428 },
429 ],
430 "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.
431 "portName": "A String", # Name of backend port. The same name should appear in the resource views referenced by this service. Required.
432 "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.
433 "A String",
434 ],
435 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
436 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
437 "selfLink": "A String", # Server defined URL for the resource (output only).
438 "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.
439 }
440
441
442Returns:
443 An object of the form:
444
445 { # An operation resource, used to manage asynchronous API requests.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]446 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]447 "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]448 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]449 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]450 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
451 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
452 "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]453 "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]454 "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]455 "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]456 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
457 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
458 "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]459 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]460 "message": "A String", # [Output Only] Optional human-readable details for this warning.
461 "code": "A String", # [Output Only] The warning type identifier for this warning.
462 "data": [ # [Output Only] Metadata for this warning in key: value format.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]463 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]464 "value": "A String", # [Output Only] A warning data value corresponding to the key.
465 "key": "A String", # [Output Only] A key for the warning data.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]466 },
467 ],
468 },
469 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]470 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
471 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
472 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
473 "name": "A String", # [Output Only] Name of the resource.
474 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
475 "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]476 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]477 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]478 "message": "A String", # [Output Only] An optional, human-readable error message.
479 "code": "A String", # [Output Only] The error type identifier for this error.
480 "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]481 },
482 ],
483 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]484 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]485 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]486 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]487 }</pre>
488</div>
489
490<div class="method">
491 <code class="details" id="update">update(project, backendService, body)</code>
492 <pre>Update the entire content of the BackendService resource.
493
494Args:
495 project: string, Name of the project scoping this request. (required)
496 backendService: string, Name of the BackendService resource to update. (required)
497 body: object, The request body. (required)
498 The object takes the form of:
499
500{ # A BackendService resource. This resource defines a group of backend VMs together with their serving capacity.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]501 #
502 # If you add field foo, you probably need to also add: com.google.cloud.cluster.manager.api.BackendServiceResource: foo com.google.cloud.cluster.manager.networking.entities: BackendService, BackendServiceEntity: getFoo, setFoo:
503 #
504 # Converters/mappers will need to be updated: com.google.cloud.cluster.manager.networking.services.backendservice.BackendServiceResourceConverter: toResource, updateEntity: copy foo com.google.cloud.cluster.mixer.protomappers.BackendServiceMappers.ResourceMapper: ResourceMapper: add a new map call
505 #
506 # Tests to update: com.google.cloud.cluster.manager.networking.services.backendservice.BackendServiceResourceConverterTest com.google.cloud.cluster.mixer.protomappers.BackendServiceMappersTest.testResourceMapping
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]507 "kind": "compute#backendService", # Type of the resource.
508 "protocol": "A String",
509 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
510 "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]511 "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]512 "backends": [ # The list of backends that serve this BackendService.
513 { # Message containing information of one individual backend.
514 "group": "A String", # URL of a zonal Cloud Resource View resource. This resource view defines the list of instances that serve traffic. Member virtual machine instances from each resource view must live in the same zone as the resource view itself. No two backends in a backend service are allowed to use same Resource View resource.
515 "description": "A String", # An optional textual description of the resource, which is provided by the client when the resource is created.
516 "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, 1].
517 "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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]518 "capacityScaler": 3.14, # The multiplier (a value between 0.0 and 1.0) of the max capacity (CPU or RPS, depending on 'balancingMode') the group should serve up to. 0 means the group is totally drained. Default value is 1. Valid range is [0.0, 1.0].
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]519 "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.
520 "balancingMode": "A String", # The balancing mode of this backend, default is UTILIZATION.
521 },
522 ],
523 "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.
524 "portName": "A String", # Name of backend port. The same name should appear in the resource views referenced by this service. Required.
525 "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.
526 "A String",
527 ],
528 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
529 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
530 "selfLink": "A String", # Server defined URL for the resource (output only).
531 "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.
532 }
533
534
535Returns:
536 An object of the form:
537
538 { # An operation resource, used to manage asynchronous API requests.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]539 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]540 "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]541 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]542 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]543 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
544 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
545 "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]546 "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]547 "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]548 "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]549 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
550 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
551 "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]552 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]553 "message": "A String", # [Output Only] Optional human-readable details for this warning.
554 "code": "A String", # [Output Only] The warning type identifier for this warning.
555 "data": [ # [Output Only] Metadata for this warning in key: value format.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]556 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]557 "value": "A String", # [Output Only] A warning data value corresponding to the key.
558 "key": "A String", # [Output Only] A key for the warning data.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]559 },
560 ],
561 },
562 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]563 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
564 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
565 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
566 "name": "A String", # [Output Only] Name of the resource.
567 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
568 "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]569 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]570 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]571 "message": "A String", # [Output Only] An optional, human-readable error message.
572 "code": "A String", # [Output Only] The error type identifier for this error.
573 "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]574 },
575 ],
576 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]577 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]578 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]579 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]580 }</pre>
581</div>
582
583</body></html>