Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / compute_alpha.externalVpnGateways.html
blob: 60b93ed4cc7f5801d2211bfd01da0e7e022f9795 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.externalVpnGateways.html">externalVpnGateways</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(project, externalVpnGateway, requestId=None)</a></code></p>
79<p class="firstline">Deletes the specified externalVpnGateway.</p>
80<p class="toc_element">
81 <code><a href="#get">get(project, externalVpnGateway)</a></code></p>
82<p class="firstline">Returns the specified externalVpnGateway. Get a list of available externalVpnGateways by making a list() request.</p>
83<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]84 <code><a href="#insert">insert(project, body=None, requestId=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]85<p class="firstline">Creates a ExternalVpnGateway in the specified project using the data included in the request.</p>
86<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]87 <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, returnPartialSuccess=None, filter=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]88<p class="firstline">Retrieves the list of ExternalVpnGateway available to the specified project.</p>
89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]93 <code><a href="#setLabels">setLabels(project, resource, body=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]94<p class="firstline">Sets the labels on an ExternalVpnGateway. To learn more about labels, read the Labeling Resources documentation.</p>
95<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]96 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]97<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
98<h3>Method Details</h3>
99<div class="method">
100 <code class="details" id="delete">delete(project, externalVpnGateway, requestId=None)</code>
101 <pre>Deletes the specified externalVpnGateway.
102
103Args:
104 project: string, Project ID for this request. (required)
105 externalVpnGateway: string, Name of the externalVpnGateways to delete. (required)
106 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.
107
108For 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.
109
110The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
111
112Returns:
113 An object of the form:
114
115 { # Represents an Operation resource.
116 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]117 # Google Compute Engine has three Operation resources:
118 #
119 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
120 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]121 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
122 #
123 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]124 # - For global operations, use the `globalOperations` resource.
125 # - For regional operations, use the `regionOperations` resource.
126 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]127 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]128 # 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]129 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
130 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
131 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]132 "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]133 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
134 "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^]135 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
136 "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]137 "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^]138 "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]139 "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^]140 "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]141 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
142 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
143 {
144 "message": "A String", # [Output Only] A human-readable description of the warning code.
145 "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.
146 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
147 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
148 {
149 "value": "A String", # [Output Only] A warning data value corresponding to the key.
150 "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).
151 },
152 ],
153 },
154 ],
155 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]156 "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]157 "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^]158 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
159 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]160 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
161 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
162 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
163 {
164 "message": "A String", # [Output Only] An optional, human-readable error message.
165 "code": "A String", # [Output Only] The error type identifier for this error.
166 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
167 },
168 ],
169 },
170 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
171 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
172 "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.
173 }</pre>
174</div>
175
176<div class="method">
177 <code class="details" id="get">get(project, externalVpnGateway)</code>
178 <pre>Returns the specified externalVpnGateway. Get a list of available externalVpnGateways by making a list() request.
179
180Args:
181 project: string, Project ID for this request. (required)
182 externalVpnGateway: string, Name of the externalVpnGateway to return. (required)
183
184Returns:
185 An object of the form:
186
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]187 { # External VPN gateway is the on-premises VPN gateway(s) or another cloud provider's VPN gateway that connects to your Google Cloud VPN gateway. To create a highly available VPN from Google Cloud to your on-premises side or another Cloud provider's VPN gateway, you must create a external VPN gateway resource in GCP, which provides the information to GCP about your external VPN gateway.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]188 "kind": "compute#externalVpnGateway", # [Output Only] Type of the resource. Always compute#externalVpnGateway for externalVpnGateways.
189 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
190 "labelFingerprint": "A String", # A fingerprint for the labels being applied to this ExternalVpnGateway, 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.
191 #
192 # To see the latest fingerprint, make a get() request to retrieve an ExternalVpnGateway.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]193 "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]194 "a_key": "A String",
195 },
196 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
197 "redundancyType": "A String", # Indicates the user-supplied redundancy type of this external VPN gateway.
198 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
199 "interfaces": [ # List of interfaces for this external VPN gateway.
200 { # The interface for the external VPN gateway.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]201 "ipAddress": "A String", # IP address of the interface in the external VPN gateway. Only IPv4 is supported. This IP address can be either from your on-premise gateway or another Cloud provider's VPN gateway, it cannot be an IP address from Google Compute Engine.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]202 "id": 42, # The numeric ID of this interface. The allowed input values for this id for different redundancy types of external VPN gateway: SINGLE_IP_INTERNALLY_REDUNDANT - 0 TWO_IPS_REDUNDANCY - 0, 1 FOUR_IPS_REDUNDANCY - 0, 1, 2, 3
203 },
204 ],
205 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
206 "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.
207 }</pre>
208</div>
209
210<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]211 <code class="details" id="insert">insert(project, body=None, requestId=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]212 <pre>Creates a ExternalVpnGateway in the specified project using the data included in the request.
213
214Args:
215 project: string, Project ID for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]216 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]217 The object takes the form of:
218
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]219{ # External VPN gateway is the on-premises VPN gateway(s) or another cloud provider's VPN gateway that connects to your Google Cloud VPN gateway. To create a highly available VPN from Google Cloud to your on-premises side or another Cloud provider's VPN gateway, you must create a external VPN gateway resource in GCP, which provides the information to GCP about your external VPN gateway.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]220 "kind": "compute#externalVpnGateway", # [Output Only] Type of the resource. Always compute#externalVpnGateway for externalVpnGateways.
221 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
222 "labelFingerprint": "A String", # A fingerprint for the labels being applied to this ExternalVpnGateway, 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.
223 #
224 # To see the latest fingerprint, make a get() request to retrieve an ExternalVpnGateway.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]225 "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]226 "a_key": "A String",
227 },
228 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
229 "redundancyType": "A String", # Indicates the user-supplied redundancy type of this external VPN gateway.
230 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
231 "interfaces": [ # List of interfaces for this external VPN gateway.
232 { # The interface for the external VPN gateway.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]233 "ipAddress": "A String", # IP address of the interface in the external VPN gateway. Only IPv4 is supported. This IP address can be either from your on-premise gateway or another Cloud provider's VPN gateway, it cannot be an IP address from Google Compute Engine.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]234 "id": 42, # The numeric ID of this interface. The allowed input values for this id for different redundancy types of external VPN gateway: SINGLE_IP_INTERNALLY_REDUNDANT - 0 TWO_IPS_REDUNDANCY - 0, 1 FOUR_IPS_REDUNDANCY - 0, 1, 2, 3
235 },
236 ],
237 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
238 "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.
239 }
240
241 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.
242
243For 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.
244
245The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
246
247Returns:
248 An object of the form:
249
250 { # Represents an Operation resource.
251 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]252 # Google Compute Engine has three Operation resources:
253 #
254 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
255 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]256 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
257 #
258 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]259 # - For global operations, use the `globalOperations` resource.
260 # - For regional operations, use the `regionOperations` resource.
261 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]262 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]263 # 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]264 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
265 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
266 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]267 "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]268 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
269 "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^]270 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
271 "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]272 "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^]273 "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]274 "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^]275 "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]276 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
277 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
278 {
279 "message": "A String", # [Output Only] A human-readable description of the warning code.
280 "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.
281 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
282 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
283 {
284 "value": "A String", # [Output Only] A warning data value corresponding to the key.
285 "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).
286 },
287 ],
288 },
289 ],
290 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]291 "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]292 "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^]293 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
294 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]295 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
296 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
297 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
298 {
299 "message": "A String", # [Output Only] An optional, human-readable error message.
300 "code": "A String", # [Output Only] The error type identifier for this error.
301 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
302 },
303 ],
304 },
305 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
306 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
307 "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.
308 }</pre>
309</div>
310
311<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]312 <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, returnPartialSuccess=None, filter=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]313 <pre>Retrieves the list of ExternalVpnGateway available to the specified project.
314
315Args:
316 project: string, Project ID for this request. (required)
317 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
318
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]319You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]320
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]321Currently, only sorting by `name` or `creationTimestamp desc` is supported.
322 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`)
323 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.
324 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
325 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `&gt;`, or `&lt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]326
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]327For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]328
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]329You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]330
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]331To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]332
333Returns:
334 An object of the form:
335
336 { # Response to the list request, and contains a list of externalVpnGateways.
337 "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.
338 "kind": "compute#externalVpnGatewayList", # [Output Only] Type of resource. Always compute#externalVpnGatewayList for lists of externalVpnGateways.
339 "items": [ # A list of ExternalVpnGateway resources.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]340 { # External VPN gateway is the on-premises VPN gateway(s) or another cloud provider's VPN gateway that connects to your Google Cloud VPN gateway. To create a highly available VPN from Google Cloud to your on-premises side or another Cloud provider's VPN gateway, you must create a external VPN gateway resource in GCP, which provides the information to GCP about your external VPN gateway.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]341 "kind": "compute#externalVpnGateway", # [Output Only] Type of the resource. Always compute#externalVpnGateway for externalVpnGateways.
342 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
343 "labelFingerprint": "A String", # A fingerprint for the labels being applied to this ExternalVpnGateway, 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.
344 #
345 # To see the latest fingerprint, make a get() request to retrieve an ExternalVpnGateway.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]346 "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]347 "a_key": "A String",
348 },
349 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
350 "redundancyType": "A String", # Indicates the user-supplied redundancy type of this external VPN gateway.
351 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
352 "interfaces": [ # List of interfaces for this external VPN gateway.
353 { # The interface for the external VPN gateway.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]354 "ipAddress": "A String", # IP address of the interface in the external VPN gateway. Only IPv4 is supported. This IP address can be either from your on-premise gateway or another Cloud provider's VPN gateway, it cannot be an IP address from Google Compute Engine.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]355 "id": 42, # The numeric ID of this interface. The allowed input values for this id for different redundancy types of external VPN gateway: SINGLE_IP_INTERNALLY_REDUNDANT - 0 TWO_IPS_REDUNDANCY - 0, 1 FOUR_IPS_REDUNDANCY - 0, 1, 2, 3
356 },
357 ],
358 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
359 "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.
360 },
361 ],
362 "etag": "A String",
363 "warning": { # [Output Only] Informational warning message.
364 "message": "A String", # [Output Only] A human-readable description of the warning code.
365 "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.
366 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
367 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
368 {
369 "value": "A String", # [Output Only] A warning data value corresponding to the key.
370 "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).
371 },
372 ],
373 },
374 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
375 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
376 }</pre>
377</div>
378
379<div class="method">
380 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
381 <pre>Retrieves the next page of results.
382
383Args:
384 previous_request: The request for the previous page. (required)
385 previous_response: The response from the request for the previous page. (required)
386
387Returns:
388 A request object that you can call 'execute()' on to request the next
389 page. Returns None if there are no more items in the collection.
390 </pre>
391</div>
392
393<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]394 <code class="details" id="setLabels">setLabels(project, resource, body=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]395 <pre>Sets the labels on an ExternalVpnGateway. To learn more about labels, read the Labeling Resources documentation.
396
397Args:
398 project: string, Project ID for this request. (required)
399 resource: string, Name or id of the resource for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]400 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]401 The object takes the form of:
402
403{
404 "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 when updating or changing labels, otherwise the request will fail with error 412 conditionNotMet. Make a get() request to the resource to get the latest fingerprint.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]405 "labels": { # A list of labels to apply for this resource. Each label key &amp; value must 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. For example, "webserver-frontend": "images". A label value can also be empty (e.g. "my-label": "").
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]406 "a_key": "A String",
407 },
408 }
409
410
411Returns:
412 An object of the form:
413
414 { # Represents an Operation resource.
415 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]416 # Google Compute Engine has three Operation resources:
417 #
418 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
419 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]420 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
421 #
422 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]423 # - For global operations, use the `globalOperations` resource.
424 # - For regional operations, use the `regionOperations` resource.
425 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]426 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]427 # 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]428 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
429 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
430 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]431 "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]432 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
433 "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^]434 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
435 "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]436 "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^]437 "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]438 "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^]439 "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]440 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
441 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
442 {
443 "message": "A String", # [Output Only] A human-readable description of the warning code.
444 "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.
445 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
446 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
447 {
448 "value": "A String", # [Output Only] A warning data value corresponding to the key.
449 "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).
450 },
451 ],
452 },
453 ],
454 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]455 "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]456 "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^]457 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
458 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]459 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
460 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
461 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
462 {
463 "message": "A String", # [Output Only] An optional, human-readable error message.
464 "code": "A String", # [Output Only] The error type identifier for this error.
465 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
466 },
467 ],
468 },
469 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
470 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
471 "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.
472 }</pre>
473</div>
474
475<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]476 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]477 <pre>Returns permissions that a caller has on the specified resource.
478
479Args:
480 project: string, Project ID for this request. (required)
481 resource: string, Name or id of the resource for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]482 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]483 The object takes the form of:
484
485{
486 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
487 "A String",
488 ],
489 }
490
491
492Returns:
493 An object of the form:
494
495 {
496 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
497 "A String",
498 ],
499 }</pre>
500</div>
501
502</body></html>