Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3bf2781e29cb828409f3a8a21939323286524569 / . / docs / dyn / compute_alpha.targetHttpProxies.html
blob: 12507e4e421e2c8bf468a2b06edd4e1175103f3a [file] [log] [blame]
Sai Cheemalapatidf613972016-10-21 13:59:49 -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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.targetHttpProxies.html">targetHttpProxies</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]84 <code><a href="#delete">delete(project, targetHttpProxy, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]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>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]88<p class="firstline">Returns the specified TargetHttpProxy resource. Gets a list of available target HTTP proxies by making a list() request.</p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]89<p class="toc_element">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]90 <code><a href="#insert">insert(project, body, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]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">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]99 <code><a href="#setUrlMap">setUrlMap(project, targetHttpProxy, body, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]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">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
151 "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.
152 "urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService.
153 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
154 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
155 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
156 "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.
157 },
158 ],
159 },
160 },
161 "warning": { # [Output Only] Informational warning message.
162 "message": "A String", # [Output Only] A human-readable description of the warning code.
163 "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.
164 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
165 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
166 {
167 "value": "A String", # [Output Only] A warning data value corresponding to the key.
168 "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).
169 },
170 ],
171 },
172 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
173 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
174 }</pre>
175</div>
176
177<div class="method">
178 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
179 <pre>Retrieves the next page of results.
180
181Args:
182 previous_request: The request for the previous page. (required)
183 previous_response: The response from the request for the previous page. (required)
184
185Returns:
186 A request object that you can call 'execute()' on to request the next
187 page. Returns None if there are no more items in the collection.
188 </pre>
189</div>
190
191<div class="method">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]192 <code class="details" id="delete">delete(project, targetHttpProxy, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]193 <pre>Deletes the specified TargetHttpProxy resource.
194
195Args:
196 project: string, Project ID for this request. (required)
197 targetHttpProxy: string, Name of the TargetHttpProxy resource to delete. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]198 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.
199
200For 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.
201
202The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]203
204Returns:
205 An object of the form:
206
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]207 { # Represents an Operation resource.
208 #
209 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
210 #
211 # Operations can be global, regional or zonal.
212 # - For global operations, use the globalOperations resource.
213 # - For regional operations, use the regionOperations resource.
214 # - For zonal operations, use the zonalOperations resource.
215 #
216 # 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 ==)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]217 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]218 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]219 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]220 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]221 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]222 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
223 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
224 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
225 "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.
226 "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.
227 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
228 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
229 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
230 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
231 {
232 "message": "A String", # [Output Only] A human-readable description of the warning code.
233 "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.
234 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
235 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
236 {
237 "value": "A String", # [Output Only] A warning data value corresponding to the key.
238 "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).
239 },
240 ],
241 },
242 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]243 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]244 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
245 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
246 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
247 "name": "A String", # [Output Only] Name of the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]248 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]249 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
250 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
251 {
252 "message": "A String", # [Output Only] An optional, human-readable error message.
253 "code": "A String", # [Output Only] The error type identifier for this error.
254 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
255 },
256 ],
257 },
258 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
259 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]260 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]261 }</pre>
262</div>
263
264<div class="method">
265 <code class="details" id="get">get(project, targetHttpProxy)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]266 <pre>Returns the specified TargetHttpProxy resource. Gets a list of available target HTTP proxies by making a list() request.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]267
268Args:
269 project: string, Project ID for this request. (required)
270 targetHttpProxy: string, Name of the TargetHttpProxy resource to return. (required)
271
272Returns:
273 An object of the form:
274
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]275 { # A TargetHttpProxy resource. This resource defines an HTTP proxy. (== resource_for beta.targetHttpProxies ==) (== resource_for v1.targetHttpProxies ==)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]278 "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.
279 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
280 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]281 "urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService.
282 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
283 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
284 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]285 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]286 }</pre>
287</div>
288
289<div class="method">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]290 <code class="details" id="insert">insert(project, body, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]291 <pre>Creates a TargetHttpProxy resource in the specified project using the data included in the request.
292
293Args:
294 project: string, Project ID for this request. (required)
295 body: object, The request body. (required)
296 The object takes the form of:
297
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]298{ # A TargetHttpProxy resource. This resource defines an HTTP proxy. (== resource_for beta.targetHttpProxies ==) (== resource_for v1.targetHttpProxies ==)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]299 "kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies.
300 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]301 "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.
302 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
303 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]304 "urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService.
305 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
306 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
307 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]308 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]309 }
310
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]311 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.
312
313For 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.
314
315The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]316
317Returns:
318 An object of the form:
319
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]320 { # Represents an Operation resource.
321 #
322 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
323 #
324 # Operations can be global, regional or zonal.
325 # - For global operations, use the globalOperations resource.
326 # - For regional operations, use the regionOperations resource.
327 # - For zonal operations, use the zonalOperations resource.
328 #
329 # 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 ==)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]330 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]331 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]332 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]333 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]334 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]335 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
336 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
337 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
338 "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.
339 "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.
340 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
341 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
342 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
343 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
344 {
345 "message": "A String", # [Output Only] A human-readable description of the warning code.
346 "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.
347 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
348 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
349 {
350 "value": "A String", # [Output Only] A warning data value corresponding to the key.
351 "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).
352 },
353 ],
354 },
355 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]356 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]357 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
358 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
359 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
360 "name": "A String", # [Output Only] Name of the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]361 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]362 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
363 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
364 {
365 "message": "A String", # [Output Only] An optional, human-readable error message.
366 "code": "A String", # [Output Only] The error type identifier for this error.
367 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
368 },
369 ],
370 },
371 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
372 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]373 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]374 }</pre>
375</div>
376
377<div class="method">
378 <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
379 <pre>Retrieves the list of TargetHttpProxy resources available to the specified project.
380
381Args:
382 project: string, Project ID for this request. (required)
383 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
384
385You 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.
386
387Currently, only sorting by name or creationTimestamp desc is supported.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]388 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)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]389 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]390 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 <.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]391
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]392For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]393
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]394You 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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]395
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]396To 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).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]397
398Returns:
399 An object of the form:
400
401 { # A list of TargetHttpProxy resources.
402 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]403 "kind": "compute#targetHttpProxyList", # Type of resource. Always compute#targetHttpProxyList for lists of target HTTP proxies.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]404 "items": [ # A list of TargetHttpProxy resources.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]405 { # A TargetHttpProxy resource. This resource defines an HTTP proxy. (== resource_for beta.targetHttpProxies ==) (== resource_for v1.targetHttpProxies ==)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]406 "kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies.
407 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]408 "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.
409 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
410 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]411 "urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService.
412 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
413 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
414 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]415 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]416 },
417 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]418 "warning": { # [Output Only] Informational warning message.
419 "message": "A String", # [Output Only] A human-readable description of the warning code.
420 "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.
421 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
422 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
423 {
424 "value": "A String", # [Output Only] A warning data value corresponding to the key.
425 "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).
426 },
427 ],
428 },
429 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]430 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
431 }</pre>
432</div>
433
434<div class="method">
435 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
436 <pre>Retrieves the next page of results.
437
438Args:
439 previous_request: The request for the previous page. (required)
440 previous_response: The response from the request for the previous page. (required)
441
442Returns:
443 A request object that you can call 'execute()' on to request the next
444 page. Returns None if there are no more items in the collection.
445 </pre>
446</div>
447
448<div class="method">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]449 <code class="details" id="setUrlMap">setUrlMap(project, targetHttpProxy, body, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]450 <pre>Changes the URL map for TargetHttpProxy.
451
452Args:
453 project: string, Project ID for this request. (required)
454 targetHttpProxy: string, Name of the TargetHttpProxy to set a URL map for. (required)
455 body: object, The request body. (required)
456 The object takes the form of:
457
458{
459 "urlMap": "A String",
460 }
461
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]462 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.
463
464For 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.
465
466The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]467
468Returns:
469 An object of the form:
470
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]471 { # Represents an Operation resource.
472 #
473 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
474 #
475 # Operations can be global, regional or zonal.
476 # - For global operations, use the globalOperations resource.
477 # - For regional operations, use the regionOperations resource.
478 # - For zonal operations, use the zonalOperations resource.
479 #
480 # 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 ==)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]481 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]482 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]483 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]484 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]485 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]486 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
487 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
488 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
489 "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.
490 "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.
491 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
492 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
493 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
494 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
495 {
496 "message": "A String", # [Output Only] A human-readable description of the warning code.
497 "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.
498 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
499 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
500 {
501 "value": "A String", # [Output Only] A warning data value corresponding to the key.
502 "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).
503 },
504 ],
505 },
506 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]507 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]508 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
509 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
510 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
511 "name": "A String", # [Output Only] Name of the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]512 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]513 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
514 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
515 {
516 "message": "A String", # [Output Only] An optional, human-readable error message.
517 "code": "A String", # [Output Only] The error type identifier for this error.
518 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
519 },
520 ],
521 },
522 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
523 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]524 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]525 }</pre>
526</div>
527
528<div class="method">
529 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code>
530 <pre>Returns permissions that a caller has on the specified resource.
531
532Args:
533 project: string, Project ID for this request. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]534 resource: string, Name or id of the resource for this request. (required)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]535 body: object, The request body. (required)
536 The object takes the form of:
537
538{
539 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
540 "A String",
541 ],
542 }
543
544
545Returns:
546 An object of the form:
547
548 {
549 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
550 "A String",
551 ],
552 }</pre>
553</div>
554
555</body></html>