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_beta.html">Compute Engine API</a> . <a href="compute_beta.targetHttpProxies.html">targetHttpProxies</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
79<p class="firstline">Retrieves the list of all TargetHttpProxy resources, regional and global, available to the specified project.</p>
80<p class="toc_element">
81  <code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
82<p class="firstline">Retrieves the next page of results.</p>
83<p class="toc_element">
84  <code><a href="#delete">delete(project, targetHttpProxy, requestId=None)</a></code></p>
85<p class="firstline">Deletes the specified TargetHttpProxy resource.</p>
86<p class="toc_element">
87  <code><a href="#get">get(project, targetHttpProxy)</a></code></p>
88<p class="firstline">Returns the specified TargetHttpProxy resource. Gets a list of available target HTTP proxies by making a list() request.</p>
89<p class="toc_element">
90  <code><a href="#insert">insert(project, body, requestId=None)</a></code></p>
91<p class="firstline">Creates a TargetHttpProxy resource in the specified project using the data included in the request.</p>
92<p class="toc_element">
93  <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
94<p class="firstline">Retrieves the list of TargetHttpProxy resources available to the specified project.</p>
95<p class="toc_element">
96  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
97<p class="firstline">Retrieves the next page of results.</p>
98<p class="toc_element">
99  <code><a href="#setUrlMap">setUrlMap(project, targetHttpProxy, body, requestId=None)</a></code></p>
100<p class="firstline">Changes the URL map for TargetHttpProxy.</p>
101<p class="toc_element">
102  <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p>
103<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
104<h3>Method Details</h3>
105<div class="method">
106    <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
107  <pre>Retrieves the list of all TargetHttpProxy resources, regional and global, available to the specified project.
108
109Args:
110  project: string, Name of the project scoping this request. (required)
111  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
112
113You 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.
114
115Currently, only sorting by name or creationTimestamp desc is supported.
116  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)
117  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.
118  filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.
119
120For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.
121
122You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
123
124To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).
125
126Returns:
127  An object of the form:
128
129    {
130    "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.
131    "kind": "compute#targetHttpProxyAggregatedList", # [Output Only] Type of resource. Always compute#targetHttpProxyAggregatedList for lists of Target HTTP Proxies.
132    "items": { # A list of TargetHttpProxiesScopedList resources.
133      "a_key": { # Name of the scope containing this set of TargetHttpProxies.
134        "warning": { # Informational warning which replaces the list of backend services when the list is empty.
135          "message": "A String", # [Output Only] A human-readable description of the warning code.
136          "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.
137          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
138              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
139            {
140              "value": "A String", # [Output Only] A warning data value corresponding to the key.
141              "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).
142            },
143          ],
144        },
145        "targetHttpProxies": [ # A list of TargetHttpProxies contained in this scope.
146          { # A TargetHttpProxy resource. This resource defines an HTTP proxy. (== resource_for beta.targetHttpProxies ==) (== resource_for v1.targetHttpProxies ==)
147              "kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies.
148              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
149              "region": "A String", # [Output Only] URL of the region where the regional Target HTTP Proxy resides. This field is not applicable to global Target HTTP Proxies.
150              "urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService.
151              "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
152              "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
153              "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
154              "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.
155            },
156        ],
157      },
158    },
159    "warning": { # [Output Only] Informational warning message.
160      "message": "A String", # [Output Only] A human-readable description of the warning code.
161      "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.
162      "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
163          # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
164        {
165          "value": "A String", # [Output Only] A warning data value corresponding to the key.
166          "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).
167        },
168      ],
169    },
170    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
171    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
172  }</pre>
173</div>
174
175<div class="method">
176    <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
177  <pre>Retrieves the next page of results.
178
179Args:
180  previous_request: The request for the previous page. (required)
181  previous_response: The response from the request for the previous page. (required)
182
183Returns:
184  A request object that you can call 'execute()' on to request the next
185  page. Returns None if there are no more items in the collection.
186    </pre>
187</div>
188
189<div class="method">
190    <code class="details" id="delete">delete(project, targetHttpProxy, requestId=None)</code>
191  <pre>Deletes the specified TargetHttpProxy resource.
192
193Args:
194  project: string, Project ID for this request. (required)
195  targetHttpProxy: string, Name of the TargetHttpProxy resource to delete. (required)
196  requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
197
198For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
199
200The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
201
202Returns:
203  An object of the form:
204
205    { # Represents an Operation resource.
206      #
207      # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
208      #
209      # Operations can be global, regional or zonal.
210      # - For global operations, use the globalOperations resource.
211      # - For regional operations, use the regionOperations resource.
212      # - For zonal operations, use the zonalOperations resource.
213      #
214      # For more information, read  Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
215    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
216    "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
217    "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
218    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
219    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
220    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
221    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
222    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
223    "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.
224    "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.
225    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
226    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
227    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
228    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
229      {
230        "message": "A String", # [Output Only] A human-readable description of the warning code.
231        "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.
232        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
233            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
234          {
235            "value": "A String", # [Output Only] A warning data value corresponding to the key.
236            "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).
237          },
238        ],
239      },
240    ],
241    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
242    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
243    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
244    "name": "A String", # [Output Only] Name of the resource.
245    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
246    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
247      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
248        {
249          "message": "A String", # [Output Only] An optional, human-readable error message.
250          "code": "A String", # [Output Only] The error type identifier for this error.
251          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
252        },
253      ],
254    },
255    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
256    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
257    "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.
258  }</pre>
259</div>
260
261<div class="method">
262    <code class="details" id="get">get(project, targetHttpProxy)</code>
263  <pre>Returns the specified TargetHttpProxy resource. Gets a list of available target HTTP proxies by making a list() request.
264
265Args:
266  project: string, Project ID for this request. (required)
267  targetHttpProxy: string, Name of the TargetHttpProxy resource to return. (required)
268
269Returns:
270  An object of the form:
271
272    { # A TargetHttpProxy resource. This resource defines an HTTP proxy. (== resource_for beta.targetHttpProxies ==) (== resource_for v1.targetHttpProxies ==)
273      "kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies.
274      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
275      "region": "A String", # [Output Only] URL of the region where the regional Target HTTP Proxy resides. This field is not applicable to global Target HTTP Proxies.
276      "urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService.
277      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
278      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
279      "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
280      "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.
281    }</pre>
282</div>
283
284<div class="method">
285    <code class="details" id="insert">insert(project, body, requestId=None)</code>
286  <pre>Creates a TargetHttpProxy resource in the specified project using the data included in the request.
287
288Args:
289  project: string, Project ID for this request. (required)
290  body: object, The request body. (required)
291    The object takes the form of:
292
293{ # A TargetHttpProxy resource. This resource defines an HTTP proxy. (== resource_for beta.targetHttpProxies ==) (== resource_for v1.targetHttpProxies ==)
294    "kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies.
295    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
296    "region": "A String", # [Output Only] URL of the region where the regional Target HTTP Proxy resides. This field is not applicable to global Target HTTP Proxies.
297    "urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService.
298    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
299    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
300    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
301    "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.
302  }
303
304  requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
305
306For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
307
308The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
309
310Returns:
311  An object of the form:
312
313    { # Represents an Operation resource.
314      #
315      # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
316      #
317      # Operations can be global, regional or zonal.
318      # - For global operations, use the globalOperations resource.
319      # - For regional operations, use the regionOperations resource.
320      # - For zonal operations, use the zonalOperations resource.
321      #
322      # For more information, read  Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
323    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
324    "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
325    "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
326    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
327    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
328    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
329    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
330    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
331    "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.
332    "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.
333    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
334    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
335    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
336    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
337      {
338        "message": "A String", # [Output Only] A human-readable description of the warning code.
339        "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.
340        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
341            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
342          {
343            "value": "A String", # [Output Only] A warning data value corresponding to the key.
344            "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).
345          },
346        ],
347      },
348    ],
349    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
350    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
351    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
352    "name": "A String", # [Output Only] Name of the resource.
353    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
354    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
355      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
356        {
357          "message": "A String", # [Output Only] An optional, human-readable error message.
358          "code": "A String", # [Output Only] The error type identifier for this error.
359          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
360        },
361      ],
362    },
363    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
364    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
365    "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.
366  }</pre>
367</div>
368
369<div class="method">
370    <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
371  <pre>Retrieves the list of TargetHttpProxy resources available to the specified project.
372
373Args:
374  project: string, Project ID for this request. (required)
375  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
376
377You 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.
378
379Currently, only sorting by name or creationTimestamp desc is supported.
380  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)
381  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.
382  filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.
383
384For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.
385
386You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
387
388To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).
389
390Returns:
391  An object of the form:
392
393    { # A list of TargetHttpProxy resources.
394    "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.
395    "kind": "compute#targetHttpProxyList", # Type of resource. Always compute#targetHttpProxyList for lists of target HTTP proxies.
396    "items": [ # A list of TargetHttpProxy resources.
397      { # A TargetHttpProxy resource. This resource defines an HTTP proxy. (== resource_for beta.targetHttpProxies ==) (== resource_for v1.targetHttpProxies ==)
398          "kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies.
399          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
400          "region": "A String", # [Output Only] URL of the region where the regional Target HTTP Proxy resides. This field is not applicable to global Target HTTP Proxies.
401          "urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService.
402          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
403          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
404          "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
405          "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.
406        },
407    ],
408    "warning": { # [Output Only] Informational warning message.
409      "message": "A String", # [Output Only] A human-readable description of the warning code.
410      "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.
411      "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
412          # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
413        {
414          "value": "A String", # [Output Only] A warning data value corresponding to the key.
415          "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).
416        },
417      ],
418    },
419    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
420    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
421  }</pre>
422</div>
423
424<div class="method">
425    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
426  <pre>Retrieves the next page of results.
427
428Args:
429  previous_request: The request for the previous page. (required)
430  previous_response: The response from the request for the previous page. (required)
431
432Returns:
433  A request object that you can call 'execute()' on to request the next
434  page. Returns None if there are no more items in the collection.
435    </pre>
436</div>
437
438<div class="method">
439    <code class="details" id="setUrlMap">setUrlMap(project, targetHttpProxy, body, requestId=None)</code>
440  <pre>Changes the URL map for TargetHttpProxy.
441
442Args:
443  project: string, Project ID for this request. (required)
444  targetHttpProxy: string, Name of the TargetHttpProxy to set a URL map for. (required)
445  body: object, The request body. (required)
446    The object takes the form of:
447
448{
449    "urlMap": "A String",
450  }
451
452  requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
453
454For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
455
456The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
457
458Returns:
459  An object of the form:
460
461    { # Represents an Operation resource.
462      #
463      # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
464      #
465      # Operations can be global, regional or zonal.
466      # - For global operations, use the globalOperations resource.
467      # - For regional operations, use the regionOperations resource.
468      # - For zonal operations, use the zonalOperations resource.
469      #
470      # For more information, read  Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
471    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
472    "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
473    "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
474    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
475    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
476    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
477    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
478    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
479    "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.
480    "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.
481    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
482    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
483    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
484    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
485      {
486        "message": "A String", # [Output Only] A human-readable description of the warning code.
487        "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.
488        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
489            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
490          {
491            "value": "A String", # [Output Only] A warning data value corresponding to the key.
492            "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).
493          },
494        ],
495      },
496    ],
497    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
498    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
499    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
500    "name": "A String", # [Output Only] Name of the resource.
501    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
502    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
503      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
504        {
505          "message": "A String", # [Output Only] An optional, human-readable error message.
506          "code": "A String", # [Output Only] The error type identifier for this error.
507          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
508        },
509      ],
510    },
511    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
512    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
513    "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.
514  }</pre>
515</div>
516
517<div class="method">
518    <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code>
519  <pre>Returns permissions that a caller has on the specified resource.
520
521Args:
522  project: string, Project ID for this request. (required)
523  resource: string, Name or id of the resource for this request. (required)
524  body: object, The request body. (required)
525    The object takes the form of:
526
527{
528    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
529      "A String",
530    ],
531  }
532
533
534Returns:
535  An object of the form:
536
537    {
538    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
539      "A String",
540    ],
541  }</pre>
542</div>
543
544</body></html>