Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / compute_alpha.targetTcpProxies.html
blob: 1830baca146b1bd273a512fc304ac095a9bd4287 [file] [log] [blame]
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[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
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]75<h1><a href="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.targetTcpProxies.html">targetTcpProxies</a></h1>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]78 <code><a href="#delete">delete(project, targetTcpProxy, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]79<p class="firstline">Deletes the specified TargetTcpProxy resource.</p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]80<p class="toc_element">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]81 <code><a href="#get">get(project, targetTcpProxy)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]82<p class="firstline">Returns the specified TargetTcpProxy resource. Gets a list of available target TCP proxies by making a list() request.</p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]83<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]84 <code><a href="#insert">insert(project, body=None, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]85<p class="firstline">Creates a TargetTcpProxy resource in the specified project using the data included in the request.</p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]86<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]87 <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, returnPartialSuccess=None, filter=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]88<p class="firstline">Retrieves the list of TargetTcpProxy resources available to the specified project.</p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]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="#setBackendService">setBackendService(project, targetTcpProxy, body=None, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]94<p class="firstline">Changes the BackendService for TargetTcpProxy.</p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]95<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]96 <code><a href="#setProxyHeader">setProxyHeader(project, targetTcpProxy, body=None, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]97<p class="firstline">Changes the ProxyHeaderType for TargetTcpProxy.</p>
98<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]99 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]100<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]101<h3>Method Details</h3>
102<div class="method">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]103 <code class="details" id="delete">delete(project, targetTcpProxy, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]104 <pre>Deletes the specified TargetTcpProxy resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]105
106Args:
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]107 project: string, Project ID for this request. (required)
108 targetTcpProxy: string, Name of the TargetTcpProxy resource to delete. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]109 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.
110
111For 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.
112
113The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]114
115Returns:
116 An object of the form:
117
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]118 { # Represents an Operation resource.
119 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]120 # Google Compute Engine has three Operation resources:
121 #
122 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
123 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]124 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
125 #
126 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]127 # - For global operations, use the `globalOperations` resource.
128 # - For regional operations, use the `regionOperations` resource.
129 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]130 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]131 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]132 "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]133 "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]134 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]135 "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]136 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]137 "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^]138 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
139 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]140 "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^]141 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]142 "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^]143 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]144 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
145 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
146 {
147 "message": "A String", # [Output Only] A human-readable description of the warning code.
148 "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.
149 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
150 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
151 {
152 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]153 "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).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]154 },
155 ],
156 },
157 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]158 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]159 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]160 "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^]161 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
162 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]163 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]164 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
165 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
166 {
167 "message": "A String", # [Output Only] An optional, human-readable error message.
168 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]169 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]170 },
171 ],
172 },
173 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
174 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]175 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]176 }</pre>
177</div>
178
179<div class="method">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]180 <code class="details" id="get">get(project, targetTcpProxy)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]181 <pre>Returns the specified TargetTcpProxy resource. Gets a list of available target TCP proxies by making a list() request.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]182
183Args:
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]184 project: string, Project ID for this request. (required)
185 targetTcpProxy: string, Name of the TargetTcpProxy resource to return. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]186
187Returns:
188 An object of the form:
189
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]190 { # Represents a Target TCP Proxy resource.
191 #
192 # A target TCP proxy is a component of a TCP Proxy load balancer. Global forwarding rules reference target TCP proxy, and the target proxy then references an external backend service. For more information, read TCP Proxy Load Balancing overview. (== resource_for {$api_version}.targetTcpProxies ==)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]193 "kind": "compute#targetTcpProxy", # [Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies.
194 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
195 "service": "A String", # URL to the BackendService resource.
196 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]197 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]198 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
199 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]200 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]201 }</pre>
202</div>
203
204<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]205 <code class="details" id="insert">insert(project, body=None, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]206 <pre>Creates a TargetTcpProxy resource in the specified project using the data included in the request.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]207
208Args:
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]209 project: string, Project ID for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]210 body: object, The request body.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]211 The object takes the form of:
212
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]213{ # Represents a Target TCP Proxy resource.
214 #
215 # A target TCP proxy is a component of a TCP Proxy load balancer. Global forwarding rules reference target TCP proxy, and the target proxy then references an external backend service. For more information, read TCP Proxy Load Balancing overview. (== resource_for {$api_version}.targetTcpProxies ==)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]216 "kind": "compute#targetTcpProxy", # [Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies.
217 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
218 "service": "A String", # URL to the BackendService resource.
219 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]220 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]221 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
222 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]223 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]224 }
225
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]226 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.
227
228For 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.
229
230The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]231
232Returns:
233 An object of the form:
234
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]235 { # Represents an Operation resource.
236 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]237 # Google Compute Engine has three Operation resources:
238 #
239 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
240 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]241 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
242 #
243 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]244 # - For global operations, use the `globalOperations` resource.
245 # - For regional operations, use the `regionOperations` resource.
246 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]247 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]248 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]249 "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]250 "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]251 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]252 "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]253 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]254 "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^]255 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
256 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]257 "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^]258 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]259 "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^]260 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]261 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
262 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
263 {
264 "message": "A String", # [Output Only] A human-readable description of the warning code.
265 "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.
266 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
267 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
268 {
269 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]270 "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).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]271 },
272 ],
273 },
274 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]275 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]276 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]277 "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^]278 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
279 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]280 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]281 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
282 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
283 {
284 "message": "A String", # [Output Only] An optional, human-readable error message.
285 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]286 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]287 },
288 ],
289 },
290 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
291 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]292 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]293 }</pre>
294</div>
295
296<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]297 <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, returnPartialSuccess=None, filter=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]298 <pre>Retrieves the list of TargetTcpProxy resources available to the specified project.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]299
300Args:
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]301 project: string, Project ID for this request. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]302 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
303
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]304You 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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]305
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]306Currently, only sorting by `name` or `creationTimestamp desc` is supported.
307 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`)
308 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.
309 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
310 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;`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]311
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]312For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]313
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]314You 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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]315
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]316To 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) ```
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]317
318Returns:
319 An object of the form:
320
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]321 { # Contains a list of TargetTcpProxy resources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]322 "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]323 "kind": "compute#targetTcpProxyList", # Type of resource.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]324 "items": [ # A list of TargetTcpProxy resources.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]325 { # Represents a Target TCP Proxy resource.
326 #
327 # A target TCP proxy is a component of a TCP Proxy load balancer. Global forwarding rules reference target TCP proxy, and the target proxy then references an external backend service. For more information, read TCP Proxy Load Balancing overview. (== resource_for {$api_version}.targetTcpProxies ==)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]328 "kind": "compute#targetTcpProxy", # [Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies.
329 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
330 "service": "A String", # URL to the BackendService resource.
331 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]332 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
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.
334 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]335 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]336 },
337 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]338 "warning": { # [Output Only] Informational warning message.
339 "message": "A String", # [Output Only] A human-readable description of the warning code.
340 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
341 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
342 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
343 {
344 "value": "A String", # [Output Only] A warning data value corresponding to the key.
345 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
346 },
347 ],
348 },
349 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]350 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]351 }</pre>
352</div>
353
354<div class="method">
355 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
356 <pre>Retrieves the next page of results.
357
358Args:
359 previous_request: The request for the previous page. (required)
360 previous_response: The response from the request for the previous page. (required)
361
362Returns:
363 A request object that you can call 'execute()' on to request the next
364 page. Returns None if there are no more items in the collection.
365 </pre>
366</div>
367
368<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]369 <code class="details" id="setBackendService">setBackendService(project, targetTcpProxy, body=None, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]370 <pre>Changes the BackendService for TargetTcpProxy.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]371
372Args:
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]373 project: string, Project ID for this request. (required)
374 targetTcpProxy: string, Name of the TargetTcpProxy resource whose BackendService resource is to be set. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]375 body: object, The request body.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]376 The object takes the form of:
377
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]378{
379 "service": "A String", # The URL of the new BackendService resource for the targetTcpProxy.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]380 }
381
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]382 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.
383
384For 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.
385
386The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]387
388Returns:
389 An object of the form:
390
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]391 { # Represents an Operation resource.
392 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]393 # Google Compute Engine has three Operation resources:
394 #
395 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
396 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]397 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
398 #
399 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]400 # - For global operations, use the `globalOperations` resource.
401 # - For regional operations, use the `regionOperations` resource.
402 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]403 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]404 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]405 "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]406 "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]407 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]408 "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]409 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]410 "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^]411 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
412 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]413 "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^]414 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]415 "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^]416 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]417 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
418 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
419 {
420 "message": "A String", # [Output Only] A human-readable description of the warning code.
421 "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.
422 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
423 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
424 {
425 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]426 "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).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]427 },
428 ],
429 },
430 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]431 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]432 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]433 "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^]434 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
435 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]436 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]437 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
438 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
439 {
440 "message": "A String", # [Output Only] An optional, human-readable error message.
441 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]442 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]443 },
444 ],
445 },
446 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
447 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]448 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]449 }</pre>
450</div>
451
452<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]453 <code class="details" id="setProxyHeader">setProxyHeader(project, targetTcpProxy, body=None, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]454 <pre>Changes the ProxyHeaderType for TargetTcpProxy.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]455
456Args:
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]457 project: string, Project ID for this request. (required)
458 targetTcpProxy: string, Name of the TargetTcpProxy resource whose ProxyHeader is to be set. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]459 body: object, The request body.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]460 The object takes the form of:
461
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]462{
463 "proxyHeader": "A String", # The new type of proxy header to append before sending data to the backend. NONE or PROXY_V1 are allowed.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]464 }
465
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]466 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.
467
468For 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.
469
470The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]471
472Returns:
473 An object of the form:
474
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]475 { # Represents an Operation resource.
476 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]477 # Google Compute Engine has three Operation resources:
478 #
479 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
480 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]481 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
482 #
483 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]484 # - For global operations, use the `globalOperations` resource.
485 # - For regional operations, use the `regionOperations` resource.
486 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]487 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]488 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]489 "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]490 "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]491 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]492 "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]493 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]494 "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^]495 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
496 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]497 "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^]498 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]499 "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^]500 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]501 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
502 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
503 {
504 "message": "A String", # [Output Only] A human-readable description of the warning code.
505 "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.
506 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
507 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
508 {
509 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]510 "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).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]511 },
512 ],
513 },
514 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]515 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]516 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]517 "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^]518 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
519 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]520 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]521 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
522 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
523 {
524 "message": "A String", # [Output Only] An optional, human-readable error message.
525 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]526 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]527 },
528 ],
529 },
530 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
531 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]532 "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]533 }</pre>
534</div>
535
536<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]537 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]538 <pre>Returns permissions that a caller has on the specified resource.
539
540Args:
541 project: string, Project ID for this request. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]542 resource: string, Name or id of the resource for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]543 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]544 The object takes the form of:
545
546{
547 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
548 "A String",
549 ],
550 }
551
552
553Returns:
554 An object of the form:
555
556 {
557 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
558 "A String",
559 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]560 }</pre>
561</div>
562
563</body></html>