Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 02bae1c909ec28088ebbc4007f3ef9b968b55e0a / . / docs / dyn / compute_v1.targetHttpProxies.html
blob: 4bff28da050352a7f38d3396079c129037d48bd0 [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>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]82<p class="firstline">Returns the specified TargetHttpProxy resource. Get a list of available target HTTP proxies by making a list() request.</p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]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">
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]87 <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]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:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]101 project: string, Project ID for this request. (required)
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]102 targetHttpProxy: string, Name of the TargetHttpProxy resource to delete. (required)
103
104Returns:
105 An object of the form:
106
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]107 { # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]108 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
109 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]110 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]111 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
112 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
113 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
114 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]115 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]116 "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.
117 "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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]118 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]119 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
120 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]121 "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]122 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]123 "message": "A String", # [Output Only] A human-readable description of the warning code.
124 "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.
125 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
126 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]127 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]128 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]129 "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).
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]130 },
131 ],
132 },
133 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]134 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]135 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
136 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]137 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]138 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]139 "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]140 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]141 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]142 "message": "A String", # [Output Only] An optional, human-readable error message.
143 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]144 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]145 },
146 ],
147 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]148 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]149 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]150 "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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]151 }</pre>
152</div>
153
154<div class="method">
155 <code class="details" id="get">get(project, targetHttpProxy)</code>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]156 <pre>Returns the specified TargetHttpProxy resource. Get a list of available target HTTP proxies by making a list() request.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]157
158Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]159 project: string, Project ID for this request. (required)
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]160 targetHttpProxy: string, Name of the TargetHttpProxy resource to return. (required)
161
162Returns:
163 An object of the form:
164
165 { # A TargetHttpProxy resource. This resource defines an HTTP proxy.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]166 "kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies.
167 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]168 "urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]169 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]170 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]171 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]172 "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]173 }</pre>
174</div>
175
176<div class="method">
177 <code class="details" id="insert">insert(project, body)</code>
178 <pre>Creates a TargetHttpProxy resource in the specified project using the data included in the request.
179
180Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]181 project: string, Project ID for this request. (required)
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]182 body: object, The request body. (required)
183 The object takes the form of:
184
185{ # A TargetHttpProxy resource. This resource defines an HTTP proxy.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]186 "kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies.
187 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]188 "urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]189 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]190 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]191 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]192 "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]193 }
194
195
196Returns:
197 An object of the form:
198
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]199 { # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]200 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
201 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]202 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]203 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
204 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
205 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
206 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]207 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]208 "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.
209 "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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]210 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]211 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
212 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]213 "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]214 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]215 "message": "A String", # [Output Only] A human-readable description of the warning code.
216 "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.
217 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
218 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]219 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]220 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]221 "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).
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]222 },
223 ],
224 },
225 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]226 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]227 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
228 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]229 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]230 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]231 "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]232 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]233 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]234 "message": "A String", # [Output Only] An optional, human-readable error message.
235 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]236 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]237 },
238 ],
239 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]240 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]241 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]242 "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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]243 }</pre>
244</div>
245
246<div class="method">
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]247 <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]248 <pre>Retrieves the list of TargetHttpProxy resources available to the specified project.
249
250Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]251 project: string, Project ID for this request. (required)
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]252 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
253
254You 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.
255
256Currently, only sorting by name or creationTimestamp desc is supported.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]257 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)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]258 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.
259 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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]260
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]261The 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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]262
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]263For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]264
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]265You 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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]266
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]267To 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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]268
269Returns:
270 An object of the form:
271
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]272 { # A list of TargetHttpProxy resources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]273 "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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]274 "items": [ # A list of TargetHttpProxy resources.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]275 { # A TargetHttpProxy resource. This resource defines an HTTP proxy.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]276 "kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies.
277 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]278 "urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]279 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]280 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]281 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]282 "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]283 },
284 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]285 "kind": "compute#targetHttpProxyList", # Type of resource. Always compute#targetHttpProxyList for lists of target HTTP proxies.
286 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]287 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]288 }</pre>
289</div>
290
291<div class="method">
292 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
293 <pre>Retrieves the next page of results.
294
295Args:
296 previous_request: The request for the previous page. (required)
297 previous_response: The response from the request for the previous page. (required)
298
299Returns:
300 A request object that you can call 'execute()' on to request the next
301 page. Returns None if there are no more items in the collection.
302 </pre>
303</div>
304
305<div class="method">
306 <code class="details" id="setUrlMap">setUrlMap(project, targetHttpProxy, body)</code>
307 <pre>Changes the URL map for TargetHttpProxy.
308
309Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]310 project: string, Project ID for this request. (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]311 targetHttpProxy: string, Name of the TargetHttpProxy to set a URL map for. (required)
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]312 body: object, The request body. (required)
313 The object takes the form of:
314
315{
316 "urlMap": "A String",
317 }
318
319
320Returns:
321 An object of the form:
322
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]323 { # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]324 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
325 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]326 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]327 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
328 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
329 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
330 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]331 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]332 "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.
333 "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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]334 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]335 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
336 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]337 "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]338 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]339 "message": "A String", # [Output Only] A human-readable description of the warning code.
340 "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.
341 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
342 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]343 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]344 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]345 "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).
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]346 },
347 ],
348 },
349 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]350 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]351 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
352 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]353 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]354 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]355 "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]356 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]357 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]358 "message": "A String", # [Output Only] An optional, human-readable error message.
359 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]360 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]361 },
362 ],
363 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]364 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]365 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]366 "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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]367 }</pre>
368</div>
369
370</body></html>