Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 4f877e562986034f25ea4246ad1256eabd339526 / . / docs / dyn / compute_v1.targetHttpProxies.html
blob: d0aa6fb71f614ccdbb123d29c7a6f921a7d195d5 [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.targetHttpProxies.html">targetHttpProxies</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(project, targetHttpProxy)</a></code></p>
79<p class="firstline">Deletes the specified TargetHttpProxy resource.</p>
80<p class="toc_element">
81 <code><a href="#get">get(project, targetHttpProxy)</a></code></p>
82<p class="firstline">Returns the specified TargetHttpProxy resource.</p>
83<p class="toc_element">
84 <code><a href="#insert">insert(project, body)</a></code></p>
85<p class="firstline">Creates a TargetHttpProxy 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 TargetHttpProxy 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="#setUrlMap">setUrlMap(project, targetHttpProxy, body)</a></code></p>
94<p class="firstline">Changes the URL map for TargetHttpProxy.</p>
95<h3>Method Details</h3>
96<div class="method">
97 <code class="details" id="delete">delete(project, targetHttpProxy)</code>
98 <pre>Deletes the specified TargetHttpProxy resource.
99
100Args:
101 project: string, Name of the project scoping this request. (required)
102 targetHttpProxy: string, Name of the TargetHttpProxy resource to delete. (required)
103
104Returns:
105 An object of the form:
106
107 { # An operation resource, used to manage asynchronous API requests.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]108 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]109 "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]110 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]111 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]112 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
113 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
114 "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^]115 "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]116 "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]117 "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]118 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
119 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
120 "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]121 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]122 "message": "A String", # [Output Only] Optional human-readable details for this warning.
123 "code": "A String", # [Output Only] The warning type identifier for this warning.
124 "data": [ # [Output Only] Metadata for this warning in key: value format.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]125 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]126 "value": "A String", # [Output Only] A warning data value corresponding to the key.
127 "key": "A String", # [Output Only] A key for the warning data.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]128 },
129 ],
130 },
131 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]132 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
133 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
134 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
135 "name": "A String", # [Output Only] Name of the resource.
136 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
137 "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]138 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]139 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]140 "message": "A String", # [Output Only] An optional, human-readable error message.
141 "code": "A String", # [Output Only] The error type identifier for this error.
142 "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]143 },
144 ],
145 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]146 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]147 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]148 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]149 }</pre>
150</div>
151
152<div class="method">
153 <code class="details" id="get">get(project, targetHttpProxy)</code>
154 <pre>Returns the specified TargetHttpProxy resource.
155
156Args:
157 project: string, Name of the project scoping this request. (required)
158 targetHttpProxy: string, Name of the TargetHttpProxy resource to return. (required)
159
160Returns:
161 An object of the form:
162
163 { # A TargetHttpProxy resource. This resource defines an HTTP proxy.
164 "kind": "compute#targetHttpProxy", # Type of the resource.
165 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
166 "urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService.
167 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
168 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
169 "selfLink": "A String", # Server defined URL for the resource (output only).
170 "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.
171 }</pre>
172</div>
173
174<div class="method">
175 <code class="details" id="insert">insert(project, body)</code>
176 <pre>Creates a TargetHttpProxy resource in the specified project using the data included in the request.
177
178Args:
179 project: string, Name of the project scoping this request. (required)
180 body: object, The request body. (required)
181 The object takes the form of:
182
183{ # A TargetHttpProxy resource. This resource defines an HTTP proxy.
184 "kind": "compute#targetHttpProxy", # Type of the resource.
185 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
186 "urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService.
187 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
188 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
189 "selfLink": "A String", # Server defined URL for the resource (output only).
190 "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.
191 }
192
193
194Returns:
195 An object of the form:
196
197 { # An operation resource, used to manage asynchronous API requests.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]198 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]199 "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]200 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]201 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]202 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
203 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
204 "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^]205 "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]206 "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]207 "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]208 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
209 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
210 "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]211 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]212 "message": "A String", # [Output Only] Optional human-readable details for this warning.
213 "code": "A String", # [Output Only] The warning type identifier for this warning.
214 "data": [ # [Output Only] Metadata for this warning in key: value format.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]215 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]216 "value": "A String", # [Output Only] A warning data value corresponding to the key.
217 "key": "A String", # [Output Only] A key for the warning data.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]218 },
219 ],
220 },
221 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]222 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
223 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
224 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
225 "name": "A String", # [Output Only] Name of the resource.
226 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
227 "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]228 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]229 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]230 "message": "A String", # [Output Only] An optional, human-readable error message.
231 "code": "A String", # [Output Only] The error type identifier for this error.
232 "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]233 },
234 ],
235 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]236 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]237 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]238 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]239 }</pre>
240</div>
241
242<div class="method">
243 <code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
244 <pre>Retrieves the list of TargetHttpProxy resources available to the specified project.
245
246Args:
247 project: string, Name of the project scoping this request. (required)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]248 maxResults: integer, Maximum count of results to be returned.
249 pageToken: string, Tag returned by a previous list request when that list was truncated to maxResults. Used to continue a previous list request.
250 filter: string, Filter expression for filtering listed resources.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]251
252Returns:
253 An object of the form:
254
255 { # Contains a list of TargetHttpProxy resources.
256 "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]257 "items": [ # A list of TargetHttpProxy resources.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]258 { # A TargetHttpProxy resource. This resource defines an HTTP proxy.
259 "kind": "compute#targetHttpProxy", # Type of the resource.
260 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
261 "urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService.
262 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
263 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
264 "selfLink": "A String", # Server defined URL for the resource (output only).
265 "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.
266 },
267 ],
268 "kind": "compute#targetHttpProxyList", # Type of resource.
269 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
270 "selfLink": "A String", # Server defined URL for this resource (output only).
271 }</pre>
272</div>
273
274<div class="method">
275 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
276 <pre>Retrieves the next page of results.
277
278Args:
279 previous_request: The request for the previous page. (required)
280 previous_response: The response from the request for the previous page. (required)
281
282Returns:
283 A request object that you can call 'execute()' on to request the next
284 page. Returns None if there are no more items in the collection.
285 </pre>
286</div>
287
288<div class="method">
289 <code class="details" id="setUrlMap">setUrlMap(project, targetHttpProxy, body)</code>
290 <pre>Changes the URL map for TargetHttpProxy.
291
292Args:
293 project: string, Name of the project scoping this request. (required)
294 targetHttpProxy: string, Name of the TargetHttpProxy resource whose URL map is to be set. (required)
295 body: object, The request body. (required)
296 The object takes the form of:
297
298{
299 "urlMap": "A String",
300 }
301
302
303Returns:
304 An object of the form:
305
306 { # An operation resource, used to manage asynchronous API requests.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]307 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]308 "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]309 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]310 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]311 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
312 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
313 "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^]314 "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]315 "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]316 "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]317 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
318 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
319 "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]320 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]321 "message": "A String", # [Output Only] Optional human-readable details for this warning.
322 "code": "A String", # [Output Only] The warning type identifier for this warning.
323 "data": [ # [Output Only] Metadata for this warning in key: value format.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]324 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]325 "value": "A String", # [Output Only] A warning data value corresponding to the key.
326 "key": "A String", # [Output Only] A key for the warning data.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]327 },
328 ],
329 },
330 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]331 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
332 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
333 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
334 "name": "A String", # [Output Only] Name of the resource.
335 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
336 "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]337 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]338 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]339 "message": "A String", # [Output Only] An optional, human-readable error message.
340 "code": "A String", # [Output Only] The error type identifier for this error.
341 "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]342 },
343 ],
344 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]345 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]346 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]347 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]348 }</pre>
349</div>
350
351</body></html>