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