Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / compute_beta.regionTargetHttpProxies.html
blob: 5021073ff232c70b9159325284915e26b0c6db48 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -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_beta.html">Compute Engine API</a> . <a href="compute_beta.regionTargetHttpProxies.html">regionTargetHttpProxies</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(project, region, targetHttpProxy, requestId=None)</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, region, targetHttpProxy)</a></code></p>
82<p class="firstline">Returns the specified TargetHttpProxy resource in the specified region. Gets a list of available target HTTP proxies by making a list() request.</p>
83<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]84 <code><a href="#insert">insert(project, region, body=None, requestId=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]85<p class="firstline">Creates a TargetHttpProxy resource in the specified project and region using the data included in the request.</p>
86<p class="toc_element">
87 <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
88<p class="firstline">Retrieves the list of TargetHttpProxy resources available to the specified project in the specified region.</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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]93 <code><a href="#setUrlMap">setUrlMap(project, region, targetHttpProxy, body=None, requestId=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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, region, targetHttpProxy, requestId=None)</code>
98 <pre>Deletes the specified TargetHttpProxy resource.
99
100Args:
101 project: string, Project ID for this request. (required)
102 region: string, Name of the region scoping this request. (required)
103 targetHttpProxy: string, Name of the TargetHttpProxy resource to delete. (required)
104 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.
105
106For 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.
107
108The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
109
110Returns:
111 An object of the form:
112
113 { # Represents an Operation resource.
114 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]115 # Google Compute Engine has three Operation resources:
116 #
117 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
118 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]119 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
120 #
121 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]122 # - For global operations, use the `globalOperations` resource.
123 # - For regional operations, use the `regionOperations` resource.
124 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]125 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]126 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]127 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
128 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
129 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]130 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]131 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
132 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]133 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
134 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]135 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]136 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]137 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]138 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]139 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
140 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
141 {
142 "message": "A String", # [Output Only] A human-readable description of the warning code.
143 "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.
144 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
145 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
146 {
147 "value": "A String", # [Output Only] A warning data value corresponding to the key.
148 "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).
149 },
150 ],
151 },
152 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]153 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]154 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]155 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
156 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]157 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
158 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
159 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
160 {
161 "message": "A String", # [Output Only] An optional, human-readable error message.
162 "code": "A String", # [Output Only] The error type identifier for this error.
163 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
164 },
165 ],
166 },
167 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
168 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
169 "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.
170 }</pre>
171</div>
172
173<div class="method">
174 <code class="details" id="get">get(project, region, targetHttpProxy)</code>
175 <pre>Returns the specified TargetHttpProxy resource in the specified region. Gets a list of available target HTTP proxies by making a list() request.
176
177Args:
178 project: string, Project ID for this request. (required)
179 region: string, Name of the region scoping this request. (required)
180 targetHttpProxy: string, Name of the TargetHttpProxy resource to return. (required)
181
182Returns:
183 An object of the form:
184
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]185 { # Represents a Target HTTP Proxy resource.
186 #
187 # Google Compute Engine has two Target HTTP Proxy resources:
188 #
189 # * [Global](/compute/docs/reference/rest/{$api_version}/targetHttpProxies) * [Regional](/compute/docs/reference/rest/{$api_version}/regionTargetHttpProxies)
190 #
191 # A target HTTP proxy is a component of GCP HTTP load balancers.
192 #
193 # * targetHttpProxies are used by external HTTP load balancers and Traffic Director. * regionTargetHttpProxies are used by internal HTTP load balancers.
194 #
195 # Forwarding rules reference a target HTTP proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts. (== resource_for {$api_version}.targetHttpProxies ==) (== resource_for {$api_version}.regionTargetHttpProxies ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]196 "kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies.
197 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
198 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]199 "proxyBind": True or False, # This field only applies when the loadBalancingScheme is INTERNAL_SELF_MANAGED. When set to true the Envoy binds on the IP address specified by the forwarding rule. Default is false.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]200 "urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService.
201 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
202 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
203 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
204 "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.
205 }</pre>
206</div>
207
208<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]209 <code class="details" id="insert">insert(project, region, body=None, requestId=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]210 <pre>Creates a TargetHttpProxy resource in the specified project and region using the data included in the request.
211
212Args:
213 project: string, Project ID for this request. (required)
214 region: string, Name of the region scoping this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]215 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]216 The object takes the form of:
217
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]218{ # Represents a Target HTTP Proxy resource.
219 #
220 # Google Compute Engine has two Target HTTP Proxy resources:
221 #
222 # * [Global](/compute/docs/reference/rest/{$api_version}/targetHttpProxies) * [Regional](/compute/docs/reference/rest/{$api_version}/regionTargetHttpProxies)
223 #
224 # A target HTTP proxy is a component of GCP HTTP load balancers.
225 #
226 # * targetHttpProxies are used by external HTTP load balancers and Traffic Director. * regionTargetHttpProxies are used by internal HTTP load balancers.
227 #
228 # Forwarding rules reference a target HTTP proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts. (== resource_for {$api_version}.targetHttpProxies ==) (== resource_for {$api_version}.regionTargetHttpProxies ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]229 "kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies.
230 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
231 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]232 "proxyBind": True or False, # This field only applies when the loadBalancingScheme is INTERNAL_SELF_MANAGED. When set to true the Envoy binds on the IP address specified by the forwarding rule. Default is false.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]233 "urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService.
234 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
235 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
236 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
237 "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.
238 }
239
240 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.
241
242For 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.
243
244The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
245
246Returns:
247 An object of the form:
248
249 { # Represents an Operation resource.
250 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]251 # Google Compute Engine has three Operation resources:
252 #
253 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
254 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]255 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
256 #
257 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]258 # - For global operations, use the `globalOperations` resource.
259 # - For regional operations, use the `regionOperations` resource.
260 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]261 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]262 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]263 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
264 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
265 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]266 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]267 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
268 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]269 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
270 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]271 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]272 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]273 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]274 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]275 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
276 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
277 {
278 "message": "A String", # [Output Only] A human-readable description of the warning code.
279 "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.
280 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
281 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
282 {
283 "value": "A String", # [Output Only] A warning data value corresponding to the key.
284 "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).
285 },
286 ],
287 },
288 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]289 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]290 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]291 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
292 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]293 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
294 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
295 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
296 {
297 "message": "A String", # [Output Only] An optional, human-readable error message.
298 "code": "A String", # [Output Only] The error type identifier for this error.
299 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
300 },
301 ],
302 },
303 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
304 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
305 "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.
306 }</pre>
307</div>
308
309<div class="method">
310 <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
311 <pre>Retrieves the list of TargetHttpProxy resources available to the specified project in the specified region.
312
313Args:
314 project: string, Project ID for this request. (required)
315 region: string, Name of the region scoping this request. (required)
316 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
317
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]318You 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]319
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]320Currently, only sorting by `name` or `creationTimestamp desc` is supported.
321 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`)
322 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.
323 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 `=`, `!=`, `&gt;`, or `&lt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]324
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]325For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]326
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]327You 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]328
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]329To 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) ```
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]330
331Returns:
332 An object of the form:
333
334 { # A list of TargetHttpProxy resources.
335 "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.
336 "kind": "compute#targetHttpProxyList", # Type of resource. Always compute#targetHttpProxyList for lists of target HTTP proxies.
337 "items": [ # A list of TargetHttpProxy resources.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]338 { # Represents a Target HTTP Proxy resource.
339 #
340 # Google Compute Engine has two Target HTTP Proxy resources:
341 #
342 # * [Global](/compute/docs/reference/rest/{$api_version}/targetHttpProxies) * [Regional](/compute/docs/reference/rest/{$api_version}/regionTargetHttpProxies)
343 #
344 # A target HTTP proxy is a component of GCP HTTP load balancers.
345 #
346 # * targetHttpProxies are used by external HTTP load balancers and Traffic Director. * regionTargetHttpProxies are used by internal HTTP load balancers.
347 #
348 # Forwarding rules reference a target HTTP proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts. (== resource_for {$api_version}.targetHttpProxies ==) (== resource_for {$api_version}.regionTargetHttpProxies ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]349 "kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies.
350 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
351 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]352 "proxyBind": True or False, # This field only applies when the loadBalancingScheme is INTERNAL_SELF_MANAGED. When set to true the Envoy binds on the IP address specified by the forwarding rule. Default is false.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]353 "urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService.
354 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
355 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
356 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
357 "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.
358 },
359 ],
360 "warning": { # [Output Only] Informational warning message.
361 "message": "A String", # [Output Only] A human-readable description of the warning code.
362 "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.
363 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
364 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
365 {
366 "value": "A String", # [Output Only] A warning data value corresponding to the key.
367 "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).
368 },
369 ],
370 },
371 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
372 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
373 }</pre>
374</div>
375
376<div class="method">
377 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
378 <pre>Retrieves the next page of results.
379
380Args:
381 previous_request: The request for the previous page. (required)
382 previous_response: The response from the request for the previous page. (required)
383
384Returns:
385 A request object that you can call 'execute()' on to request the next
386 page. Returns None if there are no more items in the collection.
387 </pre>
388</div>
389
390<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]391 <code class="details" id="setUrlMap">setUrlMap(project, region, targetHttpProxy, body=None, requestId=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]392 <pre>Changes the URL map for TargetHttpProxy.
393
394Args:
395 project: string, Project ID for this request. (required)
396 region: string, Name of the region scoping this request. (required)
397 targetHttpProxy: string, Name of the TargetHttpProxy to set a URL map for. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]398 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]399 The object takes the form of:
400
401{
402 "urlMap": "A String",
403 }
404
405 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.
406
407For 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.
408
409The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
410
411Returns:
412 An object of the form:
413
414 { # Represents an Operation resource.
415 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]416 # Google Compute Engine has three Operation resources:
417 #
418 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
419 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]420 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
421 #
422 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]423 # - For global operations, use the `globalOperations` resource.
424 # - For regional operations, use the `regionOperations` resource.
425 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]426 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]427 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]428 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
429 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
430 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]431 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]432 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
433 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]434 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
435 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]436 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]437 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]438 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]439 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]440 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
441 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
442 {
443 "message": "A String", # [Output Only] A human-readable description of the warning code.
444 "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.
445 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
446 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
447 {
448 "value": "A String", # [Output Only] A warning data value corresponding to the key.
449 "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).
450 },
451 ],
452 },
453 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]454 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]455 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]456 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
457 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]458 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
459 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
460 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
461 {
462 "message": "A String", # [Output Only] An optional, human-readable error message.
463 "code": "A String", # [Output Only] The error type identifier for this error.
464 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
465 },
466 ],
467 },
468 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
469 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
470 "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.
471 }</pre>
472</div>
473
474</body></html>