Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 0669410c6b2c48884ae31671b9d710a9ff6346c6 / . / docs / dyn / compute_v1.urlMaps.html
blob: 3250a44d54234934aac903305203e5f2e6ed74d2 [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
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]113 { # An Operation resource, used to manage asynchronous API requests.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]114 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]115 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]116 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]117 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]118 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
119 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
120 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]121 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should monotonically increase as the operation progresses.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]122 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]123 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]124 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
125 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
126 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]127 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]128 "message": "A String", # [Output Only] Optional human-readable details for this warning.
129 "code": "A String", # [Output Only] The warning type identifier for this warning.
130 "data": [ # [Output Only] Metadata for this warning in key: value format.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]131 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]132 "value": "A String", # [Output Only] A warning data value corresponding to the key.
133 "key": "A String", # [Output Only] A key for the warning data.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]134 },
135 ],
136 },
137 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]138 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
139 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
140 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
141 "name": "A String", # [Output Only] Name of the resource.
142 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
143 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]144 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]145 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]146 "message": "A String", # [Output Only] An optional, human-readable error message.
147 "code": "A String", # [Output Only] The error type identifier for this error.
148 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]149 },
150 ],
151 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]152 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]153 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]154 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]155 }</pre>
156</div>
157
158<div class="method">
159 <code class="details" id="get">get(project, 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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]171 "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]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 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]181 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]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 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]194 "description": "A String", # An optional textual description of the resource.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]195 "name": "A String", # The name to which this PathMatcher is referred by the HostRule.
196 },
197 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]198 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
199 "id": "A String", # [Output Only] Unique identifier for the resource. Set by the server.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]200 "hostRules": [ # The list of HostRules to use against the URL.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]201 { # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]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 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]205 "description": "A String", # An optional textual description.
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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]207 },
208 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]224 "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]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 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]234 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]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 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]247 "description": "A String", # An optional textual description of the resource.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]248 "name": "A String", # The name to which this PathMatcher is referred by the HostRule.
249 },
250 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]251 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
252 "id": "A String", # [Output Only] Unique identifier for the resource. Set by the server.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]253 "hostRules": [ # The list of HostRules to use against the URL.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]254 { # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]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 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]258 "description": "A String", # An optional textual description.
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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]260 },
261 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]263 }
264
265
266Returns:
267 An object of the form:
268
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]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.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]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 monotonically increase as the operation progresses.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[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)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]320 maxResults: integer, Maximum count of results to be returned.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]321 pageToken: string, Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.
322 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.
323
324The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
325
326For example, filter=name ne example-instance.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]327
328Returns:
329 An object of the form:
330
331 { # Contains a list of UrlMap resources.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]332 "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]333 "items": [ # A list of UrlMap resources.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]334 { # 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.
335 "kind": "compute#urlMap", # Type of the resource.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]336 "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]337 "defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
338 "tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only all of the test cases pass.
339 { # Message for the expected URL mappings.
340 "path": "A String", # Path portion of the URL.
341 "host": "A String", # Host portion of the URL.
342 "description": "A String", # Description of this test case.
343 "service": "A String", # Expected BackendService resource the given URL should be mapped to.
344 },
345 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]346 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]347 "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.
348 "pathMatchers": [ # The list of named PathMatchers to use against the URL.
349 { # 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.
350 "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.
351 "pathRules": [ # The list of path rules.
352 { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.
353 "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.
354 "A String",
355 ],
356 "service": "A String", # The URL of the BackendService resource if this rule is matched.
357 },
358 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]359 "description": "A String", # An optional textual description of the resource.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]360 "name": "A String", # The name to which this PathMatcher is referred by the HostRule.
361 },
362 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]363 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
364 "id": "A String", # [Output Only] Unique identifier for the resource. Set by the server.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]365 "hostRules": [ # The list of HostRules to use against the URL.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]366 { # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]367 "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.
368 "A String",
369 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]370 "description": "A String", # An optional textual description.
371 "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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]372 },
373 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]374 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]375 },
376 ],
377 "kind": "compute#urlMapList", # Type of resource.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]378 "id": "A String", # [Output Only] Unique identifier for the resource. Set by the server.
379 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]380 }</pre>
381</div>
382
383<div class="method">
384 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
385 <pre>Retrieves the next page of results.
386
387Args:
388 previous_request: The request for the previous page. (required)
389 previous_response: The response from the request for the previous page. (required)
390
391Returns:
392 A request object that you can call 'execute()' on to request the next
393 page. Returns None if there are no more items in the collection.
394 </pre>
395</div>
396
397<div class="method">
398 <code class="details" id="patch">patch(project, urlMap, body)</code>
399 <pre>Update the entire content of the UrlMap resource. This method supports patch semantics.
400
401Args:
402 project: string, Name of the project scoping this request. (required)
403 urlMap: string, Name of the UrlMap resource to update. (required)
404 body: object, The request body. (required)
405 The object takes the form of:
406
407{ # 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.
408 "kind": "compute#urlMap", # Type of the resource.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]409 "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]410 "defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
411 "tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only all of the test cases pass.
412 { # Message for the expected URL mappings.
413 "path": "A String", # Path portion of the URL.
414 "host": "A String", # Host portion of the URL.
415 "description": "A String", # Description of this test case.
416 "service": "A String", # Expected BackendService resource the given URL should be mapped to.
417 },
418 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]419 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]420 "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.
421 "pathMatchers": [ # The list of named PathMatchers to use against the URL.
422 { # 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.
423 "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.
424 "pathRules": [ # The list of path rules.
425 { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.
426 "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.
427 "A String",
428 ],
429 "service": "A String", # The URL of the BackendService resource if this rule is matched.
430 },
431 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]432 "description": "A String", # An optional textual description of the resource.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]433 "name": "A String", # The name to which this PathMatcher is referred by the HostRule.
434 },
435 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]436 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
437 "id": "A String", # [Output Only] Unique identifier for the resource. Set by the server.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]438 "hostRules": [ # The list of HostRules to use against the URL.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]439 { # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]440 "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.
441 "A String",
442 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]443 "description": "A String", # An optional textual description.
444 "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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]445 },
446 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]447 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]448 }
449
450
451Returns:
452 An object of the form:
453
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]454 { # An Operation resource, used to manage asynchronous API requests.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]455 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]456 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]457 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]458 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]459 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
460 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
461 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]462 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should monotonically increase as the operation progresses.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]463 "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]464 "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]465 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
466 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
467 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]468 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]469 "message": "A String", # [Output Only] Optional human-readable details for this warning.
470 "code": "A String", # [Output Only] The warning type identifier for this warning.
471 "data": [ # [Output Only] Metadata for this warning in key: value format.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]472 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]473 "value": "A String", # [Output Only] A warning data value corresponding to the key.
474 "key": "A String", # [Output Only] A key for the warning data.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]475 },
476 ],
477 },
478 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]479 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
480 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
481 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
482 "name": "A String", # [Output Only] Name of the resource.
483 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
484 "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]485 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]486 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]487 "message": "A String", # [Output Only] An optional, human-readable error message.
488 "code": "A String", # [Output Only] The error type identifier for this error.
489 "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]490 },
491 ],
492 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]493 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]494 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]495 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]496 }</pre>
497</div>
498
499<div class="method">
500 <code class="details" id="update">update(project, urlMap, body)</code>
501 <pre>Update the entire content of the UrlMap resource.
502
503Args:
504 project: string, Name of the project scoping this request. (required)
505 urlMap: string, Name of the UrlMap resource to update. (required)
506 body: object, The request body. (required)
507 The object takes the form of:
508
509{ # 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.
510 "kind": "compute#urlMap", # Type of the resource.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]511 "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]512 "defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
513 "tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only all of the test cases pass.
514 { # Message for the expected URL mappings.
515 "path": "A String", # Path portion of the URL.
516 "host": "A String", # Host portion of the URL.
517 "description": "A String", # Description of this test case.
518 "service": "A String", # Expected BackendService resource the given URL should be mapped to.
519 },
520 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]521 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]522 "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.
523 "pathMatchers": [ # The list of named PathMatchers to use against the URL.
524 { # 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.
525 "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.
526 "pathRules": [ # The list of path rules.
527 { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.
528 "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.
529 "A String",
530 ],
531 "service": "A String", # The URL of the BackendService resource if this rule is matched.
532 },
533 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]534 "description": "A String", # An optional textual description of the resource.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]535 "name": "A String", # The name to which this PathMatcher is referred by the HostRule.
536 },
537 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]538 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
539 "id": "A String", # [Output Only] Unique identifier for the resource. Set by the server.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]540 "hostRules": [ # The list of HostRules to use against the URL.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]541 { # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]542 "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.
543 "A String",
544 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]545 "description": "A String", # An optional textual description.
546 "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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]547 },
548 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]549 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]550 }
551
552
553Returns:
554 An object of the form:
555
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]556 { # An Operation resource, used to manage asynchronous API requests.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]557 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]558 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]559 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]560 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]561 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
562 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
563 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]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 at when the operation will be complete. This number should monotonically increase as the operation progresses.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]565 "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]566 "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]567 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
568 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
569 "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]570 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]571 "message": "A String", # [Output Only] Optional human-readable details for this warning.
572 "code": "A String", # [Output Only] The warning type identifier for this warning.
573 "data": [ # [Output Only] Metadata for this warning in key: value format.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]574 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]575 "value": "A String", # [Output Only] A warning data value corresponding to the key.
576 "key": "A String", # [Output Only] A key for the warning data.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]577 },
578 ],
579 },
580 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]581 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
582 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
583 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
584 "name": "A String", # [Output Only] Name of the resource.
585 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
586 "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]587 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]588 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]589 "message": "A String", # [Output Only] An optional, human-readable error message.
590 "code": "A String", # [Output Only] The error type identifier for this error.
591 "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]592 },
593 ],
594 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]595 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]596 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]597 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]598 }</pre>
599</div>
600
601<div class="method">
602 <code class="details" id="validate">validate(project, urlMap, body)</code>
603 <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.
604
605Args:
606 project: string, Name of the project scoping this request. (required)
607 urlMap: string, Name of the UrlMap resource to be validated as. (required)
608 body: object, The request body. (required)
609 The object takes the form of:
610
611{
612 "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.
613 "kind": "compute#urlMap", # Type of the resource.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]614 "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]615 "defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
616 "tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only all of the test cases pass.
617 { # Message for the expected URL mappings.
618 "path": "A String", # Path portion of the URL.
619 "host": "A String", # Host portion of the URL.
620 "description": "A String", # Description of this test case.
621 "service": "A String", # Expected BackendService resource the given URL should be mapped to.
622 },
623 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]624 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]625 "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.
626 "pathMatchers": [ # The list of named PathMatchers to use against the URL.
627 { # 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.
628 "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.
629 "pathRules": [ # The list of path rules.
630 { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.
631 "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.
632 "A String",
633 ],
634 "service": "A String", # The URL of the BackendService resource if this rule is matched.
635 },
636 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]637 "description": "A String", # An optional textual description of the resource.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]638 "name": "A String", # The name to which this PathMatcher is referred by the HostRule.
639 },
640 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]641 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
642 "id": "A String", # [Output Only] Unique identifier for the resource. Set by the server.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]643 "hostRules": [ # The list of HostRules to use against the URL.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]644 { # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]645 "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.
646 "A String",
647 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]648 "description": "A String", # An optional textual description.
649 "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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]650 },
651 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]652 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]653 },
654 }
655
656
657Returns:
658 An object of the form:
659
660 {
661 "result": { # Message representing the validation result for a UrlMap.
662 "testFailures": [
663 {
664 "path": "A String",
665 "actualService": "A String",
666 "host": "A String",
667 "expectedService": "A String",
668 },
669 ],
670 "loadErrors": [
671 "A String",
672 ],
673 "testPassed": True or False, # If successfully loaded, this field indicates whether the test passed. If false, 'testFailures's indicate the reason of failure.
674 "loadSucceeded": True or False, # Whether the given UrlMap can be successfully loaded. If false, 'loadErrors' indicates the reasons.
675 },
676 }</pre>
677</div>
678
679</body></html>