Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c30d2b5d4478b230246dcaaa9f1c533ca3304387 / . / docs / dyn / compute_alpha.urlMaps.html
blob: 6e8748cdca11ca4aec3759a823434987bddf4df8 [file] [log] [blame]
Sai Cheemalapatidf613972016-10-21 13:59:49 -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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.urlMaps.html">urlMaps</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]78 <code><a href="#delete">delete(project, urlMap, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]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. Get a list of available URL maps by making a list() request.</p>
83<p class="toc_element">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]84 <code><a href="#insert">insert(project, body, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]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">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]87 <code><a href="#invalidateCache">invalidateCache(project, urlMap, body, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]88<p class="firstline">Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap.</p>
89<p class="toc_element">
90 <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
91<p class="firstline">Retrieves the list of UrlMap 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">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]96 <code><a href="#patch">patch(project, urlMap, body, requestId=None)</a></code></p>
97<p class="firstline">Patches the specified UrlMap resource with the data included in the request. This method supports patch semantics.</p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]98<p class="toc_element">
99 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p>
100<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
101<p class="toc_element">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]102 <code><a href="#update">update(project, urlMap, body, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]103<p class="firstline">Updates the specified UrlMap resource with the data included in the request.</p>
104<p class="toc_element">
105 <code><a href="#validate">validate(project, urlMap, body)</a></code></p>
106<p class="firstline">Runs 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>
107<h3>Method Details</h3>
108<div class="method">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]109 <code class="details" id="delete">delete(project, urlMap, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]110 <pre>Deletes the specified UrlMap resource.
111
112Args:
113 project: string, Project ID for this request. (required)
114 urlMap: string, Name of the UrlMap resource to delete. (required)
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]115 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]116
117Returns:
118 An object of the form:
119
120 { # An Operation resource, used to manage asynchronous API requests.
121 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
122 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]123 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]124 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
125 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
126 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
127 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
128 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
129 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
130 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
131 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
132 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
133 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
134 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
135 {
136 "message": "A String", # [Output Only] A human-readable description of the warning code.
137 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
138 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
139 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
140 {
141 "value": "A String", # [Output Only] A warning data value corresponding to the key.
142 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
143 },
144 ],
145 },
146 ],
147 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
148 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
149 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
150 "name": "A String", # [Output Only] Name of the resource.
151 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
152 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
153 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
154 {
155 "message": "A String", # [Output Only] An optional, human-readable error message.
156 "code": "A String", # [Output Only] The error type identifier for this error.
157 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
158 },
159 ],
160 },
161 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
162 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]163 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]164 }</pre>
165</div>
166
167<div class="method">
168 <code class="details" id="get">get(project, urlMap)</code>
169 <pre>Returns the specified UrlMap resource. Get a list of available URL maps by making a list() request.
170
171Args:
172 project: string, Project ID for this request. (required)
173 urlMap: string, Name of the UrlMap resource to return. (required)
174
175Returns:
176 An object of the form:
177
178 { # 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.
179 "kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.
180 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
181 "defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
182 "tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only if all of the test cases pass.
183 { # Message for the expected URL mappings.
184 "path": "A String", # Path portion of the URL.
185 "host": "A String", # Host portion of the URL.
186 "description": "A String", # Description of this test case.
187 "service": "A String", # Expected BackendService resource the given URL should be mapped to.
188 },
189 ],
190 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
191 "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.
192 "pathMatchers": [ # The list of named PathMatchers to use against the URL.
193 { # 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.
194 "defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL's path portion. For example, the following are all valid URLs to a BackendService resource:
195 # - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService
196 # - compute/v1/projects/project/global/backendServices/backendService
197 # - global/backendServices/backendService
198 "pathRules": [ # The list of path rules.
199 { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.
200 "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.
201 "A String",
202 ],
203 "service": "A String", # The URL of the BackendService resource if this rule is matched.
204 },
205 ],
206 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
207 "name": "A String", # The name to which this PathMatcher is referred by the HostRule.
208 },
209 ],
210 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
211 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
212 "hostRules": [ # The list of HostRules to use against the URL.
213 { # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
214 "hosts": [ # The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..
215 "A String",
216 ],
217 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
218 "pathMatcher": "A String", # The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.
219 },
220 ],
221 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
222 }</pre>
223</div>
224
225<div class="method">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]226 <code class="details" id="insert">insert(project, body, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]227 <pre>Creates a UrlMap resource in the specified project using the data included in the request.
228
229Args:
230 project: string, Project ID for this request. (required)
231 body: object, The request body. (required)
232 The object takes the form of:
233
234{ # 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.
235 "kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.
236 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
237 "defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
238 "tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only if all of the test cases pass.
239 { # Message for the expected URL mappings.
240 "path": "A String", # Path portion of the URL.
241 "host": "A String", # Host portion of the URL.
242 "description": "A String", # Description of this test case.
243 "service": "A String", # Expected BackendService resource the given URL should be mapped to.
244 },
245 ],
246 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
247 "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.
248 "pathMatchers": [ # The list of named PathMatchers to use against the URL.
249 { # 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.
250 "defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL's path portion. For example, the following are all valid URLs to a BackendService resource:
251 # - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService
252 # - compute/v1/projects/project/global/backendServices/backendService
253 # - global/backendServices/backendService
254 "pathRules": [ # The list of path rules.
255 { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.
256 "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.
257 "A String",
258 ],
259 "service": "A String", # The URL of the BackendService resource if this rule is matched.
260 },
261 ],
262 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
263 "name": "A String", # The name to which this PathMatcher is referred by the HostRule.
264 },
265 ],
266 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
267 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
268 "hostRules": [ # The list of HostRules to use against the URL.
269 { # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
270 "hosts": [ # The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..
271 "A String",
272 ],
273 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
274 "pathMatcher": "A String", # The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.
275 },
276 ],
277 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
278 }
279
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]280 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]281
282Returns:
283 An object of the form:
284
285 { # An Operation resource, used to manage asynchronous API requests.
286 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
287 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]288 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]289 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
290 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
291 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
292 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
293 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
294 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
295 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
296 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
297 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
298 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
299 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
300 {
301 "message": "A String", # [Output Only] A human-readable description of the warning code.
302 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
303 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
304 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
305 {
306 "value": "A String", # [Output Only] A warning data value corresponding to the key.
307 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
308 },
309 ],
310 },
311 ],
312 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
313 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
314 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
315 "name": "A String", # [Output Only] Name of the resource.
316 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
317 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
318 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
319 {
320 "message": "A String", # [Output Only] An optional, human-readable error message.
321 "code": "A String", # [Output Only] The error type identifier for this error.
322 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
323 },
324 ],
325 },
326 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
327 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]328 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]329 }</pre>
330</div>
331
332<div class="method">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]333 <code class="details" id="invalidateCache">invalidateCache(project, urlMap, body, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]334 <pre>Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap.
335
336Args:
337 project: string, Project ID for this request. (required)
338 urlMap: string, Name of the UrlMap scoping this request. (required)
339 body: object, The request body. (required)
340 The object takes the form of:
341
342{
343 "path": "A String",
344 "host": "A String", # If set, this invalidation rule will only apply to requests with a Host header matching host.
345 }
346
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]347 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]348
349Returns:
350 An object of the form:
351
352 { # An Operation resource, used to manage asynchronous API requests.
353 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
354 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]355 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]356 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
357 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
358 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
359 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
360 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
361 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
362 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
363 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
364 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
365 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
366 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
367 {
368 "message": "A String", # [Output Only] A human-readable description of the warning code.
369 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
370 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
371 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
372 {
373 "value": "A String", # [Output Only] A warning data value corresponding to the key.
374 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
375 },
376 ],
377 },
378 ],
379 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
380 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
381 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
382 "name": "A String", # [Output Only] Name of the resource.
383 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
384 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
385 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
386 {
387 "message": "A String", # [Output Only] An optional, human-readable error message.
388 "code": "A String", # [Output Only] The error type identifier for this error.
389 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
390 },
391 ],
392 },
393 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
394 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]395 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]396 }</pre>
397</div>
398
399<div class="method">
400 <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
401 <pre>Retrieves the list of UrlMap resources available to the specified project.
402
403Args:
404 project: string, Project ID for this request. (required)
405 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
406
407You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
408
409Currently, only sorting by name or creationTimestamp desc is supported.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]410 maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]411 pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
412 filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
413
414The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
415
416For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
417
418You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
419
420To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
421
422Returns:
423 An object of the form:
424
425 { # Contains a list of UrlMap resources.
426 "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
427 "items": [ # A list of UrlMap resources.
428 { # 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.
429 "kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.
430 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
431 "defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
432 "tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only if all of the test cases pass.
433 { # Message for the expected URL mappings.
434 "path": "A String", # Path portion of the URL.
435 "host": "A String", # Host portion of the URL.
436 "description": "A String", # Description of this test case.
437 "service": "A String", # Expected BackendService resource the given URL should be mapped to.
438 },
439 ],
440 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
441 "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.
442 "pathMatchers": [ # The list of named PathMatchers to use against the URL.
443 { # 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.
444 "defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL's path portion. For example, the following are all valid URLs to a BackendService resource:
445 # - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService
446 # - compute/v1/projects/project/global/backendServices/backendService
447 # - global/backendServices/backendService
448 "pathRules": [ # The list of path rules.
449 { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.
450 "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.
451 "A String",
452 ],
453 "service": "A String", # The URL of the BackendService resource if this rule is matched.
454 },
455 ],
456 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
457 "name": "A String", # The name to which this PathMatcher is referred by the HostRule.
458 },
459 ],
460 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
461 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
462 "hostRules": [ # The list of HostRules to use against the URL.
463 { # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
464 "hosts": [ # The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..
465 "A String",
466 ],
467 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
468 "pathMatcher": "A String", # The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.
469 },
470 ],
471 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
472 },
473 ],
474 "kind": "compute#urlMapList", # Type of resource.
475 "id": "A String", # [Output Only] Unique identifier for the resource. Set by the server.
476 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
477 }</pre>
478</div>
479
480<div class="method">
481 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
482 <pre>Retrieves the next page of results.
483
484Args:
485 previous_request: The request for the previous page. (required)
486 previous_response: The response from the request for the previous page. (required)
487
488Returns:
489 A request object that you can call 'execute()' on to request the next
490 page. Returns None if there are no more items in the collection.
491 </pre>
492</div>
493
494<div class="method">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]495 <code class="details" id="patch">patch(project, urlMap, body, requestId=None)</code>
496 <pre>Patches the specified UrlMap resource with the data included in the request. This method supports patch semantics.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]497
498Args:
499 project: string, Project ID for this request. (required)
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]500 urlMap: string, Name of the UrlMap resource to patch. (required)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]501 body: object, The request body. (required)
502 The object takes the form of:
503
504{ # 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.
505 "kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.
506 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
507 "defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
508 "tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only if all of the test cases pass.
509 { # Message for the expected URL mappings.
510 "path": "A String", # Path portion of the URL.
511 "host": "A String", # Host portion of the URL.
512 "description": "A String", # Description of this test case.
513 "service": "A String", # Expected BackendService resource the given URL should be mapped to.
514 },
515 ],
516 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
517 "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.
518 "pathMatchers": [ # The list of named PathMatchers to use against the URL.
519 { # 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.
520 "defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL's path portion. For example, the following are all valid URLs to a BackendService resource:
521 # - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService
522 # - compute/v1/projects/project/global/backendServices/backendService
523 # - global/backendServices/backendService
524 "pathRules": [ # The list of path rules.
525 { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.
526 "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.
527 "A String",
528 ],
529 "service": "A String", # The URL of the BackendService resource if this rule is matched.
530 },
531 ],
532 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
533 "name": "A String", # The name to which this PathMatcher is referred by the HostRule.
534 },
535 ],
536 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
537 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
538 "hostRules": [ # The list of HostRules to use against the URL.
539 { # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
540 "hosts": [ # The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..
541 "A String",
542 ],
543 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
544 "pathMatcher": "A String", # The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.
545 },
546 ],
547 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
548 }
549
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]550 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]551
552Returns:
553 An object of the form:
554
555 { # An Operation resource, used to manage asynchronous API requests.
556 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
557 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]558 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]559 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
560 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
561 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
562 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
563 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
564 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
565 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
566 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
567 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
568 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
569 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
570 {
571 "message": "A String", # [Output Only] A human-readable description of the warning code.
572 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
573 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
574 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
575 {
576 "value": "A String", # [Output Only] A warning data value corresponding to the key.
577 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
578 },
579 ],
580 },
581 ],
582 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
583 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
584 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
585 "name": "A String", # [Output Only] Name of the resource.
586 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
587 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
588 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
589 {
590 "message": "A String", # [Output Only] An optional, human-readable error message.
591 "code": "A String", # [Output Only] The error type identifier for this error.
592 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
593 },
594 ],
595 },
596 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
597 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]598 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]599 }</pre>
600</div>
601
602<div class="method">
603 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code>
604 <pre>Returns permissions that a caller has on the specified resource.
605
606Args:
607 project: string, Project ID for this request. (required)
608 resource: string, Name of the resource for this request. (required)
609 body: object, The request body. (required)
610 The object takes the form of:
611
612{
613 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
614 "A String",
615 ],
616 }
617
618
619Returns:
620 An object of the form:
621
622 {
623 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
624 "A String",
625 ],
626 }</pre>
627</div>
628
629<div class="method">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]630 <code class="details" id="update">update(project, urlMap, body, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]631 <pre>Updates the specified UrlMap resource with the data included in the request.
632
633Args:
634 project: string, Project ID for this request. (required)
635 urlMap: string, Name of the UrlMap resource to update. (required)
636 body: object, The request body. (required)
637 The object takes the form of:
638
639{ # 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.
640 "kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.
641 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
642 "defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
643 "tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only if all of the test cases pass.
644 { # Message for the expected URL mappings.
645 "path": "A String", # Path portion of the URL.
646 "host": "A String", # Host portion of the URL.
647 "description": "A String", # Description of this test case.
648 "service": "A String", # Expected BackendService resource the given URL should be mapped to.
649 },
650 ],
651 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
652 "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.
653 "pathMatchers": [ # The list of named PathMatchers to use against the URL.
654 { # 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.
655 "defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL's path portion. For example, the following are all valid URLs to a BackendService resource:
656 # - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService
657 # - compute/v1/projects/project/global/backendServices/backendService
658 # - global/backendServices/backendService
659 "pathRules": [ # The list of path rules.
660 { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.
661 "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.
662 "A String",
663 ],
664 "service": "A String", # The URL of the BackendService resource if this rule is matched.
665 },
666 ],
667 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
668 "name": "A String", # The name to which this PathMatcher is referred by the HostRule.
669 },
670 ],
671 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
672 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
673 "hostRules": [ # The list of HostRules to use against the URL.
674 { # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
675 "hosts": [ # The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..
676 "A String",
677 ],
678 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
679 "pathMatcher": "A String", # The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.
680 },
681 ],
682 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
683 }
684
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]685 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]686
687Returns:
688 An object of the form:
689
690 { # An Operation resource, used to manage asynchronous API requests.
691 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
692 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]693 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]694 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
695 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
696 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
697 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
698 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
699 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
700 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
701 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
702 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
703 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
704 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
705 {
706 "message": "A String", # [Output Only] A human-readable description of the warning code.
707 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
708 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
709 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
710 {
711 "value": "A String", # [Output Only] A warning data value corresponding to the key.
712 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
713 },
714 ],
715 },
716 ],
717 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
718 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
719 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
720 "name": "A String", # [Output Only] Name of the resource.
721 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
722 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
723 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
724 {
725 "message": "A String", # [Output Only] An optional, human-readable error message.
726 "code": "A String", # [Output Only] The error type identifier for this error.
727 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
728 },
729 ],
730 },
731 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
732 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]733 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]734 }</pre>
735</div>
736
737<div class="method">
738 <code class="details" id="validate">validate(project, urlMap, body)</code>
739 <pre>Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.
740
741Args:
742 project: string, Project ID for this request. (required)
743 urlMap: string, Name of the UrlMap resource to be validated as. (required)
744 body: object, The request body. (required)
745 The object takes the form of:
746
747{
748 "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.
749 "kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.
750 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
751 "defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
752 "tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only if all of the test cases pass.
753 { # Message for the expected URL mappings.
754 "path": "A String", # Path portion of the URL.
755 "host": "A String", # Host portion of the URL.
756 "description": "A String", # Description of this test case.
757 "service": "A String", # Expected BackendService resource the given URL should be mapped to.
758 },
759 ],
760 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
761 "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.
762 "pathMatchers": [ # The list of named PathMatchers to use against the URL.
763 { # 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.
764 "defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL's path portion. For example, the following are all valid URLs to a BackendService resource:
765 # - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService
766 # - compute/v1/projects/project/global/backendServices/backendService
767 # - global/backendServices/backendService
768 "pathRules": [ # The list of path rules.
769 { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.
770 "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.
771 "A String",
772 ],
773 "service": "A String", # The URL of the BackendService resource if this rule is matched.
774 },
775 ],
776 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
777 "name": "A String", # The name to which this PathMatcher is referred by the HostRule.
778 },
779 ],
780 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
781 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
782 "hostRules": [ # The list of HostRules to use against the URL.
783 { # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
784 "hosts": [ # The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..
785 "A String",
786 ],
787 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
788 "pathMatcher": "A String", # The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.
789 },
790 ],
791 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
792 },
793 }
794
795
796Returns:
797 An object of the form:
798
799 {
800 "result": { # Message representing the validation result for a UrlMap.
801 "testFailures": [
802 {
803 "path": "A String",
804 "actualService": "A String",
805 "host": "A String",
806 "expectedService": "A String",
807 },
808 ],
809 "loadErrors": [
810 "A String",
811 ],
812 "testPassed": True or False, # If successfully loaded, this field indicates whether the test passed. If false, 'testFailures's indicate the reason of failure.
813 "loadSucceeded": True or False, # Whether the given UrlMap can be successfully loaded. If false, 'loadErrors' indicates the reasons.
814 },
815 }</pre>
816</div>
817
818</body></html>