Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / compute_alpha.vpnGateways.html
blob: bb0f38b38314ced6d305cc3eb9885db1ae709193 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.vpnGateways.html">vpnGateways</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]78 <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, returnPartialSuccess=None, filter=None, includeAllScopes=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]79<p class="firstline">Retrieves an aggregated list of VPN gateways.</p>
80<p class="toc_element">
81 <code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
82<p class="firstline">Retrieves the next page of results.</p>
83<p class="toc_element">
84 <code><a href="#delete">delete(project, region, vpnGateway, requestId=None)</a></code></p>
85<p class="firstline">Deletes the specified VPN gateway.</p>
86<p class="toc_element">
87 <code><a href="#get">get(project, region, vpnGateway)</a></code></p>
88<p class="firstline">Returns the specified VPN gateway. Gets a list of available VPN gateways by making a list() request.</p>
89<p class="toc_element">
90 <code><a href="#getStatus">getStatus(project, region, vpnGateway)</a></code></p>
91<p class="firstline">Returns the status for the specified VPN gateway.</p>
92<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]93 <code><a href="#insert">insert(project, region, body=None, requestId=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]94<p class="firstline">Creates a VPN gateway in the specified project and region using the data included in the request.</p>
95<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]96 <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, returnPartialSuccess=None, filter=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]97<p class="firstline">Retrieves a list of VPN gateways available to the specified project and region.</p>
98<p class="toc_element">
99 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
100<p class="firstline">Retrieves the next page of results.</p>
101<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]102 <code><a href="#setLabels">setLabels(project, region, resource, body=None, requestId=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]103<p class="firstline">Sets the labels on a VpnGateway. To learn more about labels, read the Labeling Resources documentation.</p>
104<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]105 <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]106<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
107<h3>Method Details</h3>
108<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]109 <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, returnPartialSuccess=None, filter=None, includeAllScopes=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]110 <pre>Retrieves an aggregated list of VPN gateways.
111
112Args:
113 project: string, Project ID for this request. (required)
114 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
115
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]116You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]117
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]118Currently, only sorting by `name` or `creationTimestamp desc` is supported.
119 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`)
120 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.
121 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.
122 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `&gt;`, or `&lt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]123
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]124For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]125
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]126You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]127
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]128To 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) ```
129 includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]130
131Returns:
132 An object of the form:
133
134 {
135 "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.
136 "kind": "compute#vpnGatewayAggregatedList", # [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.
137 "items": { # A list of VpnGateway resources.
138 "a_key": { # [Output Only] Name of the scope containing this set of VPN gateways.
139 "warning": { # [Output Only] Informational warning which replaces the list of addresses when the list is empty.
140 "message": "A String", # [Output Only] A human-readable description of the warning code.
141 "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.
142 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
143 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
144 {
145 "value": "A String", # [Output Only] A warning data value corresponding to the key.
146 "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).
147 },
148 ],
149 },
150 "vpnGateways": [ # [Output Only] A list of VPN gateways contained in this scope.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]151 { # Represents a VPN gateway resource. Next ID: 13
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]152 "kind": "compute#vpnGateway", # [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.
153 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
154 "labelFingerprint": "A String", # A fingerprint for the labels being applied to this VpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet.
155 #
156 # To see the latest fingerprint, make a get() request to retrieve an VpnGateway.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]157 "labels": { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]158 "a_key": "A String",
159 },
160 "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]161 "vpnInterfaces": [ # A list of interfaces on this VPN gateway.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]162 { # A VPN gateway interface.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]163 "ipAddress": "A String", # [Output Only] The external IP address for this VPN gateway interface.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]164 "id": 42, # The numeric ID of this VPN gateway interface.
165 },
166 ],
167 "region": "A String", # [Output Only] URL of the region where the VPN gateway resides.
168 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
169 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
170 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
171 "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.
172 },
173 ],
174 },
175 },
176 "warning": { # [Output Only] Informational warning message.
177 "message": "A String", # [Output Only] A human-readable description of the warning code.
178 "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.
179 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
180 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
181 {
182 "value": "A String", # [Output Only] A warning data value corresponding to the key.
183 "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).
184 },
185 ],
186 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]187 "unreachables": [ # [Output Only] Unreachable resources.
188 "A String",
189 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]190 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
191 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
192 }</pre>
193</div>
194
195<div class="method">
196 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
197 <pre>Retrieves the next page of results.
198
199Args:
200 previous_request: The request for the previous page. (required)
201 previous_response: The response from the request for the previous page. (required)
202
203Returns:
204 A request object that you can call 'execute()' on to request the next
205 page. Returns None if there are no more items in the collection.
206 </pre>
207</div>
208
209<div class="method">
210 <code class="details" id="delete">delete(project, region, vpnGateway, requestId=None)</code>
211 <pre>Deletes the specified VPN gateway.
212
213Args:
214 project: string, Project ID for this request. (required)
215 region: string, Name of the region for this request. (required)
216 vpnGateway: string, Name of the VPN gateway to delete. (required)
217 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.
218
219For 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.
220
221The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
222
223Returns:
224 An object of the form:
225
226 { # Represents an Operation resource.
227 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]228 # Google Compute Engine has three Operation resources:
229 #
230 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
231 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]232 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
233 #
234 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]235 # - For global operations, use the `globalOperations` resource.
236 # - For regional operations, use the `regionOperations` resource.
237 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]238 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]239 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]240 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
241 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
242 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]243 "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]244 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
245 "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^]246 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
247 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]248 "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^]249 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]250 "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^]251 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]252 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
253 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
254 {
255 "message": "A String", # [Output Only] A human-readable description of the warning code.
256 "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.
257 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
258 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
259 {
260 "value": "A String", # [Output Only] A warning data value corresponding to the key.
261 "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).
262 },
263 ],
264 },
265 ],
266 "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^]267 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]268 "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^]269 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
270 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]271 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
272 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
273 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
274 {
275 "message": "A String", # [Output Only] An optional, human-readable error message.
276 "code": "A String", # [Output Only] The error type identifier for this error.
277 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
278 },
279 ],
280 },
281 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
282 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
283 "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.
284 }</pre>
285</div>
286
287<div class="method">
288 <code class="details" id="get">get(project, region, vpnGateway)</code>
289 <pre>Returns the specified VPN gateway. Gets a list of available VPN gateways by making a list() request.
290
291Args:
292 project: string, Project ID for this request. (required)
293 region: string, Name of the region for this request. (required)
294 vpnGateway: string, Name of the VPN gateway to return. (required)
295
296Returns:
297 An object of the form:
298
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]299 { # Represents a VPN gateway resource. Next ID: 13
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]300 "kind": "compute#vpnGateway", # [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.
301 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
302 "labelFingerprint": "A String", # A fingerprint for the labels being applied to this VpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet.
303 #
304 # To see the latest fingerprint, make a get() request to retrieve an VpnGateway.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]305 "labels": { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]306 "a_key": "A String",
307 },
308 "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]309 "vpnInterfaces": [ # A list of interfaces on this VPN gateway.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]310 { # A VPN gateway interface.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]311 "ipAddress": "A String", # [Output Only] The external IP address for this VPN gateway interface.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]312 "id": 42, # The numeric ID of this VPN gateway interface.
313 },
314 ],
315 "region": "A String", # [Output Only] URL of the region where the VPN gateway resides.
316 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
317 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
318 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
319 "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.
320 }</pre>
321</div>
322
323<div class="method">
324 <code class="details" id="getStatus">getStatus(project, region, vpnGateway)</code>
325 <pre>Returns the status for the specified VPN gateway.
326
327Args:
328 project: string, Project ID for this request. (required)
329 region: string, Name of the region for this request. (required)
330 vpnGateway: string, Name of the VPN gateway to return. (required)
331
332Returns:
333 An object of the form:
334
335 {
336 "result": {
337 "vpnConnections": [ # List of VPN connection for this VpnGateway.
338 { # A VPN connection contains all VPN tunnels connected from this VpnGateway to the same peer gateway. The peer gateway could either be a external VPN gateway or GCP VPN gateway.
339 "peerExternalGateway": "A String", # URL reference to the peer external VPN gateways to which the VPN tunnels in this VPN connection are connected. This field is mutually exclusive with peer_gcp_gateway.
340 "peerGcpGateway": "A String", # URL reference to the peer side VPN gateways to which the VPN tunnels in this VPN connection are connected. This field is mutually exclusive with peer_gcp_gateway.
341 "tunnels": [ # List of VPN tunnels that are in this VPN connection.
342 { # Contains some information about a VPN tunnel.
343 "tunnelUrl": "A String", # URL reference to the VPN tunnel.
344 "localGatewayInterface": 42, # The VPN gateway interface this VPN tunnel is associated with.
345 "peerGatewayInterface": 42, # The peer gateway interface this VPN tunnel is connected to, the peer gateway could either be an external VPN gateway or GCP VPN gateway.
346 },
347 ],
348 "state": { # Describes the high availability requirement state for the VPN connection between this Cloud VPN gateway and a peer gateway. # HighAvailabilityRequirementState for the VPN connection.
349 "state": "A String", # Indicates the high availability requirement state for the VPN connection. Valid values are CONNECTION_REDUNDANCY_MET, CONNECTION_REDUNDANCY_NOT_MET.
350 "unsatisfiedReason": "A String", # Indicates the reason why the VPN connection does not meet the high availability redundancy criteria/requirement. Valid values is INCOMPLETE_TUNNELS_COVERAGE.
351 },
352 },
353 ],
354 },
355 }</pre>
356</div>
357
358<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]359 <code class="details" id="insert">insert(project, region, body=None, requestId=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]360 <pre>Creates a VPN gateway in the specified project and region using the data included in the request.
361
362Args:
363 project: string, Project ID for this request. (required)
364 region: string, Name of the region for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]365 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]366 The object takes the form of:
367
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]368{ # Represents a VPN gateway resource. Next ID: 13
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]369 "kind": "compute#vpnGateway", # [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.
370 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
371 "labelFingerprint": "A String", # A fingerprint for the labels being applied to this VpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet.
372 #
373 # To see the latest fingerprint, make a get() request to retrieve an VpnGateway.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]374 "labels": { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]375 "a_key": "A String",
376 },
377 "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]378 "vpnInterfaces": [ # A list of interfaces on this VPN gateway.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]379 { # A VPN gateway interface.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]380 "ipAddress": "A String", # [Output Only] The external IP address for this VPN gateway interface.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]381 "id": 42, # The numeric ID of this VPN gateway interface.
382 },
383 ],
384 "region": "A String", # [Output Only] URL of the region where the VPN gateway resides.
385 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
386 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
387 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
388 "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.
389 }
390
391 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.
392
393For 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.
394
395The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
396
397Returns:
398 An object of the form:
399
400 { # Represents an Operation resource.
401 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]402 # Google Compute Engine has three Operation resources:
403 #
404 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
405 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]406 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
407 #
408 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]409 # - For global operations, use the `globalOperations` resource.
410 # - For regional operations, use the `regionOperations` resource.
411 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]412 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]413 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]414 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
415 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
416 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]417 "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]418 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
419 "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^]420 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
421 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]422 "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^]423 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]424 "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^]425 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]426 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
427 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
428 {
429 "message": "A String", # [Output Only] A human-readable description of the warning code.
430 "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.
431 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
432 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
433 {
434 "value": "A String", # [Output Only] A warning data value corresponding to the key.
435 "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).
436 },
437 ],
438 },
439 ],
440 "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^]441 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]442 "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^]443 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
444 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]445 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
446 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
447 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
448 {
449 "message": "A String", # [Output Only] An optional, human-readable error message.
450 "code": "A String", # [Output Only] The error type identifier for this error.
451 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
452 },
453 ],
454 },
455 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
456 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
457 "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.
458 }</pre>
459</div>
460
461<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]462 <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, returnPartialSuccess=None, filter=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]463 <pre>Retrieves a list of VPN gateways available to the specified project and region.
464
465Args:
466 project: string, Project ID for this request. (required)
467 region: string, Name of the region for this request. (required)
468 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
469
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]470You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]471
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]472Currently, only sorting by `name` or `creationTimestamp desc` is supported.
473 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`)
474 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.
475 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.
476 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `&gt;`, or `&lt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]477
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]478For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]479
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]480You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]481
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]482To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]483
484Returns:
485 An object of the form:
486
487 { # Contains a list of VpnGateway resources.
488 "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.
489 "kind": "compute#vpnGatewayList", # [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.
490 "items": [ # A list of VpnGateway resources.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]491 { # Represents a VPN gateway resource. Next ID: 13
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]492 "kind": "compute#vpnGateway", # [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.
493 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
494 "labelFingerprint": "A String", # A fingerprint for the labels being applied to this VpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet.
495 #
496 # To see the latest fingerprint, make a get() request to retrieve an VpnGateway.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]497 "labels": { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]498 "a_key": "A String",
499 },
500 "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]501 "vpnInterfaces": [ # A list of interfaces on this VPN gateway.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]502 { # A VPN gateway interface.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]503 "ipAddress": "A String", # [Output Only] The external IP address for this VPN gateway interface.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]504 "id": 42, # The numeric ID of this VPN gateway interface.
505 },
506 ],
507 "region": "A String", # [Output Only] URL of the region where the VPN gateway resides.
508 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
509 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
510 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
511 "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.
512 },
513 ],
514 "warning": { # [Output Only] Informational warning message.
515 "message": "A String", # [Output Only] A human-readable description of the warning code.
516 "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.
517 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
518 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
519 {
520 "value": "A String", # [Output Only] A warning data value corresponding to the key.
521 "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).
522 },
523 ],
524 },
525 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
526 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
527 }</pre>
528</div>
529
530<div class="method">
531 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
532 <pre>Retrieves the next page of results.
533
534Args:
535 previous_request: The request for the previous page. (required)
536 previous_response: The response from the request for the previous page. (required)
537
538Returns:
539 A request object that you can call 'execute()' on to request the next
540 page. Returns None if there are no more items in the collection.
541 </pre>
542</div>
543
544<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]545 <code class="details" id="setLabels">setLabels(project, region, resource, body=None, requestId=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]546 <pre>Sets the labels on a VpnGateway. To learn more about labels, read the Labeling Resources documentation.
547
548Args:
549 project: string, Project ID for this request. (required)
550 region: string, The region for this request. (required)
551 resource: string, Name or id of the resource for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]552 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]553 The object takes the form of:
554
555{
556 "labelFingerprint": "A String", # The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint.
557 "labels": { # The labels to set for this resource.
558 "a_key": "A String",
559 },
560 }
561
562 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.
563
564For 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.
565
566The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
567
568Returns:
569 An object of the form:
570
571 { # Represents an Operation resource.
572 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]573 # Google Compute Engine has three Operation resources:
574 #
575 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
576 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]577 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
578 #
579 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]580 # - For global operations, use the `globalOperations` resource.
581 # - For regional operations, use the `regionOperations` resource.
582 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]583 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]584 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]585 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
586 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
587 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]588 "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]589 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
590 "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^]591 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
592 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]593 "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^]594 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]595 "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^]596 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]597 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
598 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
599 {
600 "message": "A String", # [Output Only] A human-readable description of the warning code.
601 "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.
602 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
603 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
604 {
605 "value": "A String", # [Output Only] A warning data value corresponding to the key.
606 "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).
607 },
608 ],
609 },
610 ],
611 "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^]612 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]613 "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^]614 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
615 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]616 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
617 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
618 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
619 {
620 "message": "A String", # [Output Only] An optional, human-readable error message.
621 "code": "A String", # [Output Only] The error type identifier for this error.
622 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
623 },
624 ],
625 },
626 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
627 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
628 "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.
629 }</pre>
630</div>
631
632<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]633 <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]634 <pre>Returns permissions that a caller has on the specified resource.
635
636Args:
637 project: string, Project ID for this request. (required)
638 region: string, The name of the region for this request. (required)
639 resource: string, Name or id of the resource for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]640 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]641 The object takes the form of:
642
643{
644 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
645 "A String",
646 ],
647 }
648
649
650Returns:
651 An object of the form:
652
653 {
654 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
655 "A String",
656 ],
657 }</pre>
658</div>
659
660</body></html>