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