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