Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 5cbe5baf3fad3d67e05b9387e8d81de7ce99aeb9 / . / docs / dyn / compute_v1.urlMaps.html
blob: 0b63d44e6fbb7b08eec9e5fada46ee7d3dba52c7 [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.urlMaps.html">urlMaps</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(project, urlMap)</a></code></p>
79<p class="firstline">Deletes the specified UrlMap resource.</p>
80<p class="toc_element">
81 <code><a href="#get">get(project, urlMap)</a></code></p>
82<p class="firstline">Returns the specified UrlMap resource.</p>
83<p class="toc_element">
84 <code><a href="#insert">insert(project, body)</a></code></p>
85<p class="firstline">Creates a UrlMap resource in the specified project using the data included in the request.</p>
86<p class="toc_element">
87 <code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
88<p class="firstline">Retrieves the list of UrlMap resources available to the specified project.</p>
89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
93 <code><a href="#patch">patch(project, urlMap, body)</a></code></p>
94<p class="firstline">Update the entire content of the UrlMap resource. This method supports patch semantics.</p>
95<p class="toc_element">
96 <code><a href="#update">update(project, urlMap, body)</a></code></p>
97<p class="firstline">Update the entire content of the UrlMap resource.</p>
98<p class="toc_element">
99 <code><a href="#validate">validate(project, urlMap, body)</a></code></p>
100<p class="firstline">Run static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.</p>
101<h3>Method Details</h3>
102<div class="method">
103 <code class="details" id="delete">delete(project, urlMap)</code>
104 <pre>Deletes the specified UrlMap resource.
105
106Args:
107 project: string, Name of the project scoping this request. (required)
108 urlMap: string, Name of the UrlMap 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.
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
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.
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 be monotonically increasing as the operation progresses.
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, urlMap)</code>
160 <pre>Returns the specified UrlMap resource.
161
162Args:
163 project: string, Name of the project scoping this request. (required)
164 urlMap: string, Name of the UrlMap resource to return. (required)
165
166Returns:
167 An object of the form:
168
169 { # A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path.
170 "kind": "compute#urlMap", # Type of the resource.
171 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
172 "defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
173 "tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only all of the test cases pass.
174 { # Message for the expected URL mappings.
175 "path": "A String", # Path portion of the URL.
176 "host": "A String", # Host portion of the URL.
177 "description": "A String", # Description of this test case.
178 "service": "A String", # Expected BackendService resource the given URL should be mapped to.
179 },
180 ],
181 "selfLink": "A String", # Server defined URL for the resource (output only).
182 "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 UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap.
183 "pathMatchers": [ # The list of named PathMatchers to use against the URL.
184 { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default_service will be used.
185 "defaultService": "A String", # The URL to the BackendService resource. This will be used if none of the 'pathRules' defined by this PathMatcher is met by the URL's path portion.
186 "pathRules": [ # The list of path rules.
187 { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.
188 "paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.
189 "A String",
190 ],
191 "service": "A String", # The URL of the BackendService resource if this rule is matched.
192 },
193 ],
194 "description": "A String",
195 "name": "A String", # The name to which this PathMatcher is referred by the HostRule.
196 },
197 ],
198 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
199 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
200 "hostRules": [ # The list of HostRules to use against the URL.
201 { # A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
202 "hosts": [ # The list of host patterns to match. They must be valid hostnames except that they may start with *. or *-. The * acts like a glob and will match any string of atoms (separated by .s and -s) to the left.
203 "A String",
204 ],
205 "description": "A String",
206 "pathMatcher": "A String", # The name of the PathMatcher to match the path portion of the URL, if the this HostRule matches the URL's host portion.
207 },
208 ],
209 "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.
210 }</pre>
211</div>
212
213<div class="method">
214 <code class="details" id="insert">insert(project, body)</code>
215 <pre>Creates a UrlMap resource in the specified project using the data included in the request.
216
217Args:
218 project: string, Name of the project scoping this request. (required)
219 body: object, The request body. (required)
220 The object takes the form of:
221
222{ # A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path.
223 "kind": "compute#urlMap", # Type of the resource.
224 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
225 "defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
226 "tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only all of the test cases pass.
227 { # Message for the expected URL mappings.
228 "path": "A String", # Path portion of the URL.
229 "host": "A String", # Host portion of the URL.
230 "description": "A String", # Description of this test case.
231 "service": "A String", # Expected BackendService resource the given URL should be mapped to.
232 },
233 ],
234 "selfLink": "A String", # Server defined URL for the resource (output only).
235 "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 UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap.
236 "pathMatchers": [ # The list of named PathMatchers to use against the URL.
237 { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default_service will be used.
238 "defaultService": "A String", # The URL to the BackendService resource. This will be used if none of the 'pathRules' defined by this PathMatcher is met by the URL's path portion.
239 "pathRules": [ # The list of path rules.
240 { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.
241 "paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.
242 "A String",
243 ],
244 "service": "A String", # The URL of the BackendService resource if this rule is matched.
245 },
246 ],
247 "description": "A String",
248 "name": "A String", # The name to which this PathMatcher is referred by the HostRule.
249 },
250 ],
251 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
252 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
253 "hostRules": [ # The list of HostRules to use against the URL.
254 { # A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
255 "hosts": [ # The list of host patterns to match. They must be valid hostnames except that they may start with *. or *-. The * acts like a glob and will match any string of atoms (separated by .s and -s) to the left.
256 "A String",
257 ],
258 "description": "A String",
259 "pathMatcher": "A String", # The name of the PathMatcher to match the path portion of the URL, if the this HostRule matches the URL's host portion.
260 },
261 ],
262 "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.
263 }
264
265
266Returns:
267 An object of the form:
268
269 { # An operation resource, used to manage asynchronous API requests.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]270 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
271 "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
272 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]273 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]274 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
275 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
276 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
277 "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 be monotonically increasing as the operation progresses.
278 "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]279 "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^]280 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
281 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
282 "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]283 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]284 "message": "A String", # [Output Only] Optional human-readable details for this warning.
285 "code": "A String", # [Output Only] The warning type identifier for this warning.
286 "data": [ # [Output Only] Metadata for this warning in key: value format.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]287 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]288 "value": "A String", # [Output Only] A warning data value corresponding to the key.
289 "key": "A String", # [Output Only] A key for the warning data.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]290 },
291 ],
292 },
293 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]294 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
295 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
296 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
297 "name": "A String", # [Output Only] Name of the resource.
298 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
299 "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]300 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]301 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]302 "message": "A String", # [Output Only] An optional, human-readable error message.
303 "code": "A String", # [Output Only] The error type identifier for this error.
304 "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]305 },
306 ],
307 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]308 "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]309 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]310 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]311 }</pre>
312</div>
313
314<div class="method">
315 <code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
316 <pre>Retrieves the list of UrlMap resources available to the specified project.
317
318Args:
319 project: string, Name of the project scoping this request. (required)
320 maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
321 pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
322 filter: string, Optional. Filter expression for filtering listed resources.
323
324Returns:
325 An object of the form:
326
327 { # Contains a list of UrlMap resources.
328 "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]329 "items": [ # A list of UrlMap resources.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]330 { # A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path.
331 "kind": "compute#urlMap", # Type of the resource.
332 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
333 "defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
334 "tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only all of the test cases pass.
335 { # Message for the expected URL mappings.
336 "path": "A String", # Path portion of the URL.
337 "host": "A String", # Host portion of the URL.
338 "description": "A String", # Description of this test case.
339 "service": "A String", # Expected BackendService resource the given URL should be mapped to.
340 },
341 ],
342 "selfLink": "A String", # Server defined URL for the resource (output only).
343 "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 UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap.
344 "pathMatchers": [ # The list of named PathMatchers to use against the URL.
345 { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default_service will be used.
346 "defaultService": "A String", # The URL to the BackendService resource. This will be used if none of the 'pathRules' defined by this PathMatcher is met by the URL's path portion.
347 "pathRules": [ # The list of path rules.
348 { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.
349 "paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.
350 "A String",
351 ],
352 "service": "A String", # The URL of the BackendService resource if this rule is matched.
353 },
354 ],
355 "description": "A String",
356 "name": "A String", # The name to which this PathMatcher is referred by the HostRule.
357 },
358 ],
359 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
360 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
361 "hostRules": [ # The list of HostRules to use against the URL.
362 { # A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
363 "hosts": [ # The list of host patterns to match. They must be valid hostnames except that they may start with *. or *-. The * acts like a glob and will match any string of atoms (separated by .s and -s) to the left.
364 "A String",
365 ],
366 "description": "A String",
367 "pathMatcher": "A String", # The name of the PathMatcher to match the path portion of the URL, if the this HostRule matches the URL's host portion.
368 },
369 ],
370 "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.
371 },
372 ],
373 "kind": "compute#urlMapList", # Type of resource.
374 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
375 "selfLink": "A String", # Server defined URL for this resource (output only).
376 }</pre>
377</div>
378
379<div class="method">
380 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
381 <pre>Retrieves the next page of results.
382
383Args:
384 previous_request: The request for the previous page. (required)
385 previous_response: The response from the request for the previous page. (required)
386
387Returns:
388 A request object that you can call 'execute()' on to request the next
389 page. Returns None if there are no more items in the collection.
390 </pre>
391</div>
392
393<div class="method">
394 <code class="details" id="patch">patch(project, urlMap, body)</code>
395 <pre>Update the entire content of the UrlMap resource. This method supports patch semantics.
396
397Args:
398 project: string, Name of the project scoping this request. (required)
399 urlMap: string, Name of the UrlMap resource to update. (required)
400 body: object, The request body. (required)
401 The object takes the form of:
402
403{ # A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path.
404 "kind": "compute#urlMap", # Type of the resource.
405 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
406 "defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
407 "tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only all of the test cases pass.
408 { # Message for the expected URL mappings.
409 "path": "A String", # Path portion of the URL.
410 "host": "A String", # Host portion of the URL.
411 "description": "A String", # Description of this test case.
412 "service": "A String", # Expected BackendService resource the given URL should be mapped to.
413 },
414 ],
415 "selfLink": "A String", # Server defined URL for the resource (output only).
416 "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 UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap.
417 "pathMatchers": [ # The list of named PathMatchers to use against the URL.
418 { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default_service will be used.
419 "defaultService": "A String", # The URL to the BackendService resource. This will be used if none of the 'pathRules' defined by this PathMatcher is met by the URL's path portion.
420 "pathRules": [ # The list of path rules.
421 { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.
422 "paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.
423 "A String",
424 ],
425 "service": "A String", # The URL of the BackendService resource if this rule is matched.
426 },
427 ],
428 "description": "A String",
429 "name": "A String", # The name to which this PathMatcher is referred by the HostRule.
430 },
431 ],
432 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
433 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
434 "hostRules": [ # The list of HostRules to use against the URL.
435 { # A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
436 "hosts": [ # The list of host patterns to match. They must be valid hostnames except that they may start with *. or *-. The * acts like a glob and will match any string of atoms (separated by .s and -s) to the left.
437 "A String",
438 ],
439 "description": "A String",
440 "pathMatcher": "A String", # The name of the PathMatcher to match the path portion of the URL, if the this HostRule matches the URL's host portion.
441 },
442 ],
443 "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.
444 }
445
446
447Returns:
448 An object of the form:
449
450 { # An operation resource, used to manage asynchronous API requests.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]451 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
452 "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
453 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]454 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]455 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
456 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
457 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
458 "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 be monotonically increasing as the operation progresses.
459 "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]460 "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^]461 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
462 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
463 "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]464 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]465 "message": "A String", # [Output Only] Optional human-readable details for this warning.
466 "code": "A String", # [Output Only] The warning type identifier for this warning.
467 "data": [ # [Output Only] Metadata for this warning in key: value format.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]468 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]469 "value": "A String", # [Output Only] A warning data value corresponding to the key.
470 "key": "A String", # [Output Only] A key for the warning data.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]471 },
472 ],
473 },
474 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]475 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
476 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
477 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
478 "name": "A String", # [Output Only] Name of the resource.
479 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
480 "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]481 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]482 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]483 "message": "A String", # [Output Only] An optional, human-readable error message.
484 "code": "A String", # [Output Only] The error type identifier for this error.
485 "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]486 },
487 ],
488 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]489 "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]490 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]491 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]492 }</pre>
493</div>
494
495<div class="method">
496 <code class="details" id="update">update(project, urlMap, body)</code>
497 <pre>Update the entire content of the UrlMap resource.
498
499Args:
500 project: string, Name of the project scoping this request. (required)
501 urlMap: string, Name of the UrlMap resource to update. (required)
502 body: object, The request body. (required)
503 The object takes the form of:
504
505{ # A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path.
506 "kind": "compute#urlMap", # Type of the resource.
507 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
508 "defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
509 "tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only all of the test cases pass.
510 { # Message for the expected URL mappings.
511 "path": "A String", # Path portion of the URL.
512 "host": "A String", # Host portion of the URL.
513 "description": "A String", # Description of this test case.
514 "service": "A String", # Expected BackendService resource the given URL should be mapped to.
515 },
516 ],
517 "selfLink": "A String", # Server defined URL for the resource (output only).
518 "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 UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap.
519 "pathMatchers": [ # The list of named PathMatchers to use against the URL.
520 { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default_service will be used.
521 "defaultService": "A String", # The URL to the BackendService resource. This will be used if none of the 'pathRules' defined by this PathMatcher is met by the URL's path portion.
522 "pathRules": [ # The list of path rules.
523 { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.
524 "paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.
525 "A String",
526 ],
527 "service": "A String", # The URL of the BackendService resource if this rule is matched.
528 },
529 ],
530 "description": "A String",
531 "name": "A String", # The name to which this PathMatcher is referred by the HostRule.
532 },
533 ],
534 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
535 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
536 "hostRules": [ # The list of HostRules to use against the URL.
537 { # A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
538 "hosts": [ # The list of host patterns to match. They must be valid hostnames except that they may start with *. or *-. The * acts like a glob and will match any string of atoms (separated by .s and -s) to the left.
539 "A String",
540 ],
541 "description": "A String",
542 "pathMatcher": "A String", # The name of the PathMatcher to match the path portion of the URL, if the this HostRule matches the URL's host portion.
543 },
544 ],
545 "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.
546 }
547
548
549Returns:
550 An object of the form:
551
552 { # An operation resource, used to manage asynchronous API requests.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]553 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
554 "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
555 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]556 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]557 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
558 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
559 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
560 "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 be monotonically increasing as the operation progresses.
561 "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]562 "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^]563 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
564 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
565 "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]566 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]567 "message": "A String", # [Output Only] Optional human-readable details for this warning.
568 "code": "A String", # [Output Only] The warning type identifier for this warning.
569 "data": [ # [Output Only] Metadata for this warning in key: value format.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]570 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]571 "value": "A String", # [Output Only] A warning data value corresponding to the key.
572 "key": "A String", # [Output Only] A key for the warning data.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]573 },
574 ],
575 },
576 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]577 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
578 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
579 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
580 "name": "A String", # [Output Only] Name of the resource.
581 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
582 "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]583 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]584 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]585 "message": "A String", # [Output Only] An optional, human-readable error message.
586 "code": "A String", # [Output Only] The error type identifier for this error.
587 "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]588 },
589 ],
590 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]591 "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]592 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame^]593 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]594 }</pre>
595</div>
596
597<div class="method">
598 <code class="details" id="validate">validate(project, urlMap, body)</code>
599 <pre>Run static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.
600
601Args:
602 project: string, Name of the project scoping this request. (required)
603 urlMap: string, Name of the UrlMap resource to be validated as. (required)
604 body: object, The request body. (required)
605 The object takes the form of:
606
607{
608 "resource": { # A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path. # Content of the UrlMap to be validated.
609 "kind": "compute#urlMap", # Type of the resource.
610 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
611 "defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
612 "tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only all of the test cases pass.
613 { # Message for the expected URL mappings.
614 "path": "A String", # Path portion of the URL.
615 "host": "A String", # Host portion of the URL.
616 "description": "A String", # Description of this test case.
617 "service": "A String", # Expected BackendService resource the given URL should be mapped to.
618 },
619 ],
620 "selfLink": "A String", # Server defined URL for the resource (output only).
621 "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 UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap.
622 "pathMatchers": [ # The list of named PathMatchers to use against the URL.
623 { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default_service will be used.
624 "defaultService": "A String", # The URL to the BackendService resource. This will be used if none of the 'pathRules' defined by this PathMatcher is met by the URL's path portion.
625 "pathRules": [ # The list of path rules.
626 { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.
627 "paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.
628 "A String",
629 ],
630 "service": "A String", # The URL of the BackendService resource if this rule is matched.
631 },
632 ],
633 "description": "A String",
634 "name": "A String", # The name to which this PathMatcher is referred by the HostRule.
635 },
636 ],
637 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
638 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
639 "hostRules": [ # The list of HostRules to use against the URL.
640 { # A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
641 "hosts": [ # The list of host patterns to match. They must be valid hostnames except that they may start with *. or *-. The * acts like a glob and will match any string of atoms (separated by .s and -s) to the left.
642 "A String",
643 ],
644 "description": "A String",
645 "pathMatcher": "A String", # The name of the PathMatcher to match the path portion of the URL, if the this HostRule matches the URL's host portion.
646 },
647 ],
648 "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.
649 },
650 }
651
652
653Returns:
654 An object of the form:
655
656 {
657 "result": { # Message representing the validation result for a UrlMap.
658 "testFailures": [
659 {
660 "path": "A String",
661 "actualService": "A String",
662 "host": "A String",
663 "expectedService": "A String",
664 },
665 ],
666 "loadErrors": [
667 "A String",
668 ],
669 "testPassed": True or False, # If successfully loaded, this field indicates whether the test passed. If false, 'testFailures's indicate the reason of failure.
670 "loadSucceeded": True or False, # Whether the given UrlMap can be successfully loaded. If false, 'loadErrors' indicates the reasons.
671 },
672 }</pre>
673</div>
674
675</body></html>