chore: regens API reference docs (#889)
diff --git a/docs/dyn/compute_v1.vpnTunnels.html b/docs/dyn/compute_v1.vpnTunnels.html
index 3e59099..a5d6ae7 100644
--- a/docs/dyn/compute_v1.vpnTunnels.html
+++ b/docs/dyn/compute_v1.vpnTunnels.html
@@ -75,7 +75,7 @@
<h1><a href="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.vpnTunnels.html">vpnTunnels</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+ <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None, includeAllScopes=None)</a></code></p>
<p class="firstline">Retrieves an aggregated list of VPN tunnels.</p>
<p class="toc_element">
<code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
@@ -87,7 +87,7 @@
<code><a href="#get">get(project, region, vpnTunnel)</a></code></p>
<p class="firstline">Returns the specified VpnTunnel resource. Gets a list of available VPN tunnels by making a list() request.</p>
<p class="toc_element">
- <code><a href="#insert">insert(project, region, body, requestId=None)</a></code></p>
+ <code><a href="#insert">insert(project, region, body=None, requestId=None)</a></code></p>
<p class="firstline">Creates a VpnTunnel resource in the specified project and region using the data included in the request.</p>
<p class="toc_element">
<code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
@@ -97,25 +97,26 @@
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None, includeAllScopes=None)</code>
<pre>Retrieves an aggregated list of VPN tunnels.
Args:
project: string, Project ID for this request. (required)
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.
+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.
- 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)
- 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.
- filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.
+Currently, only sorting by `name` or `creationTimestamp desc` is supported.
+ 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`)
+ 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.
+ filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.
-For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.
+For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
-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.
+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).
+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) ```
+ 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.
Returns:
An object of the form:
@@ -128,19 +129,13 @@
"vpnTunnels": [ # A list of VPN tunnels contained in this scope.
{ # Represents a Cloud VPN Tunnel resource.
#
- # For more information about VPN, read the the Cloud VPN Overview. (== resource_for beta.vpnTunnels ==) (== resource_for v1.vpnTunnels ==)
+ # For more information about VPN, read the the Cloud VPN Overview. (== resource_for {$api_version}.vpnTunnels ==)
"detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel.
- "ikeVersion": 42, # IKE protocol version to use when establishing the VPN tunnel with the peer VPN gateway. Acceptable IKE versions are 1 or 2. The default version is 2.
- "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
- "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported.
- "A String",
- ],
- "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "vpnGateway": "A String", # URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This must be used (instead of target_vpn_gateway) if a High Availability VPN gateway resource is created.
+ "peerExternalGatewayInterface": 42, # The interface ID of the external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
"peerIp": "A String", # IP address of the peer VPN gateway. Only IPv4 is supported.
- "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
- "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported.
- "A String",
- ],
"targetVpnGateway": "A String", # URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.
"status": "A String", # [Output Only] The status of the VPN tunnel, which can be one of the following:
# - PROVISIONING: Resource is being allocated for the VPN tunnel.
@@ -152,13 +147,30 @@
# - NEGOTIATION_FAILURE: Handshake failed.
# - DEPROVISIONING: Resources are being deallocated for the VPN tunnel.
# - FAILED: Tunnel creation has failed and the tunnel is not ready to be used.
+ # - NO_INCOMING_PACKETS: No incoming packets from peer.
+ # - REJECTED: Tunnel configuration was rejected, can be result of being blacklisted.
+ # - ALLOCATING_RESOURCES: Cloud VPN is in the process of allocating all required resources.
+ # - STOPPED: Tunnel is stopped due to its Forwarding Rules being deleted for Classic VPN tunnels or the project is in frozen state.
+ # - PEER_IDENTITY_MISMATCH: Peer identity does not match peer IP, probably behind NAT.
+ # - TS_NARROWING_NOT_ALLOWED: Traffic selector narrowing not allowed for an HA-VPN tunnel.
+ "ikeVersion": 42, # IKE protocol version to use when establishing the VPN tunnel with the peer VPN gateway. Acceptable IKE versions are 1 or 2. The default version is 2.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported.
+ "A String",
+ ],
+ "peerGcpGateway": "A String", # URL of the peer side HA GCP VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field can be used when creating highly available VPN from VPC network to VPC network, the field is exclusive with the field peerExternalGateway. If provided, the VPN tunnel will automatically use the same vpnGatewayInterface ID in the peer GCP VPN gateway.
"sharedSecretHash": "A String", # Hash of the shared secret.
- "router": "A String", # URL of the router resource to be used for dynamic routing.
+ "vpnGatewayInterface": 42, # The interface ID of the VPN gateway with which this VPN tunnel is associated.
"sharedSecret": "A String", # Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
- "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
+ "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported.
+ "A String",
+ ],
"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.
+ "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+ "peerExternalGateway": "A String", # URL of the peer side external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field is exclusive with the field peerGcpGateway.
+ "router": "A String", # URL of the router resource to be used for dynamic routing.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
},
],
"warning": { # Informational warning which replaces the list of addresses when the list is empty.
@@ -223,26 +235,30 @@
{ # Represents an Operation resource.
#
+ # Google Compute Engine has three Operation resources:
+ #
+ # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/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 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. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
+ # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
- "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
- "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
"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.
- "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.
+ "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.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
@@ -257,10 +273,10 @@
],
},
],
- "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+ "name": "A String", # [Output Only] Name of the operation.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
@@ -291,19 +307,13 @@
{ # Represents a Cloud VPN Tunnel resource.
#
- # For more information about VPN, read the the Cloud VPN Overview. (== resource_for beta.vpnTunnels ==) (== resource_for v1.vpnTunnels ==)
+ # For more information about VPN, read the the Cloud VPN Overview. (== resource_for {$api_version}.vpnTunnels ==)
"detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel.
- "ikeVersion": 42, # IKE protocol version to use when establishing the VPN tunnel with the peer VPN gateway. Acceptable IKE versions are 1 or 2. The default version is 2.
- "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
- "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported.
- "A String",
- ],
- "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "vpnGateway": "A String", # URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This must be used (instead of target_vpn_gateway) if a High Availability VPN gateway resource is created.
+ "peerExternalGatewayInterface": 42, # The interface ID of the external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
"peerIp": "A String", # IP address of the peer VPN gateway. Only IPv4 is supported.
- "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
- "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported.
- "A String",
- ],
"targetVpnGateway": "A String", # URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.
"status": "A String", # [Output Only] The status of the VPN tunnel, which can be one of the following:
# - PROVISIONING: Resource is being allocated for the VPN tunnel.
@@ -315,41 +325,52 @@
# - NEGOTIATION_FAILURE: Handshake failed.
# - DEPROVISIONING: Resources are being deallocated for the VPN tunnel.
# - FAILED: Tunnel creation has failed and the tunnel is not ready to be used.
+ # - NO_INCOMING_PACKETS: No incoming packets from peer.
+ # - REJECTED: Tunnel configuration was rejected, can be result of being blacklisted.
+ # - ALLOCATING_RESOURCES: Cloud VPN is in the process of allocating all required resources.
+ # - STOPPED: Tunnel is stopped due to its Forwarding Rules being deleted for Classic VPN tunnels or the project is in frozen state.
+ # - PEER_IDENTITY_MISMATCH: Peer identity does not match peer IP, probably behind NAT.
+ # - TS_NARROWING_NOT_ALLOWED: Traffic selector narrowing not allowed for an HA-VPN tunnel.
+ "ikeVersion": 42, # IKE protocol version to use when establishing the VPN tunnel with the peer VPN gateway. Acceptable IKE versions are 1 or 2. The default version is 2.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported.
+ "A String",
+ ],
+ "peerGcpGateway": "A String", # URL of the peer side HA GCP VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field can be used when creating highly available VPN from VPC network to VPC network, the field is exclusive with the field peerExternalGateway. If provided, the VPN tunnel will automatically use the same vpnGatewayInterface ID in the peer GCP VPN gateway.
"sharedSecretHash": "A String", # Hash of the shared secret.
- "router": "A String", # URL of the router resource to be used for dynamic routing.
+ "vpnGatewayInterface": 42, # The interface ID of the VPN gateway with which this VPN tunnel is associated.
"sharedSecret": "A String", # Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
- "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
+ "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported.
+ "A String",
+ ],
"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.
+ "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+ "peerExternalGateway": "A String", # URL of the peer side external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field is exclusive with the field peerGcpGateway.
+ "router": "A String", # URL of the router resource to be used for dynamic routing.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
}</pre>
</div>
<div class="method">
- <code class="details" id="insert">insert(project, region, body, requestId=None)</code>
+ <code class="details" id="insert">insert(project, region, body=None, requestId=None)</code>
<pre>Creates a VpnTunnel resource in the specified project and region using the data included in the request.
Args:
project: string, Project ID for this request. (required)
region: string, Name of the region for this request. (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # Represents a Cloud VPN Tunnel resource.
#
- # For more information about VPN, read the the Cloud VPN Overview. (== resource_for beta.vpnTunnels ==) (== resource_for v1.vpnTunnels ==)
+ # For more information about VPN, read the the Cloud VPN Overview. (== resource_for {$api_version}.vpnTunnels ==)
"detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel.
- "ikeVersion": 42, # IKE protocol version to use when establishing the VPN tunnel with the peer VPN gateway. Acceptable IKE versions are 1 or 2. The default version is 2.
- "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
- "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported.
- "A String",
- ],
- "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "vpnGateway": "A String", # URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This must be used (instead of target_vpn_gateway) if a High Availability VPN gateway resource is created.
+ "peerExternalGatewayInterface": 42, # The interface ID of the external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
"peerIp": "A String", # IP address of the peer VPN gateway. Only IPv4 is supported.
- "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
- "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported.
- "A String",
- ],
"targetVpnGateway": "A String", # URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.
"status": "A String", # [Output Only] The status of the VPN tunnel, which can be one of the following:
# - PROVISIONING: Resource is being allocated for the VPN tunnel.
@@ -361,13 +382,30 @@
# - NEGOTIATION_FAILURE: Handshake failed.
# - DEPROVISIONING: Resources are being deallocated for the VPN tunnel.
# - FAILED: Tunnel creation has failed and the tunnel is not ready to be used.
+ # - NO_INCOMING_PACKETS: No incoming packets from peer.
+ # - REJECTED: Tunnel configuration was rejected, can be result of being blacklisted.
+ # - ALLOCATING_RESOURCES: Cloud VPN is in the process of allocating all required resources.
+ # - STOPPED: Tunnel is stopped due to its Forwarding Rules being deleted for Classic VPN tunnels or the project is in frozen state.
+ # - PEER_IDENTITY_MISMATCH: Peer identity does not match peer IP, probably behind NAT.
+ # - TS_NARROWING_NOT_ALLOWED: Traffic selector narrowing not allowed for an HA-VPN tunnel.
+ "ikeVersion": 42, # IKE protocol version to use when establishing the VPN tunnel with the peer VPN gateway. Acceptable IKE versions are 1 or 2. The default version is 2.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported.
+ "A String",
+ ],
+ "peerGcpGateway": "A String", # URL of the peer side HA GCP VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field can be used when creating highly available VPN from VPC network to VPC network, the field is exclusive with the field peerExternalGateway. If provided, the VPN tunnel will automatically use the same vpnGatewayInterface ID in the peer GCP VPN gateway.
"sharedSecretHash": "A String", # Hash of the shared secret.
- "router": "A String", # URL of the router resource to be used for dynamic routing.
+ "vpnGatewayInterface": 42, # The interface ID of the VPN gateway with which this VPN tunnel is associated.
"sharedSecret": "A String", # Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
- "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
+ "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported.
+ "A String",
+ ],
"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.
+ "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+ "peerExternalGateway": "A String", # URL of the peer side external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field is exclusive with the field peerGcpGateway.
+ "router": "A String", # URL of the router resource to be used for dynamic routing.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
}
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.
@@ -381,26 +419,30 @@
{ # Represents an Operation resource.
#
+ # Google Compute Engine has three Operation resources:
+ #
+ # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/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 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. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
+ # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
- "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
- "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
"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.
- "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.
+ "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.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
@@ -415,10 +457,10 @@
],
},
],
- "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+ "name": "A String", # [Output Only] Name of the operation.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
@@ -444,18 +486,18 @@
region: string, Name of the region for this request. (required)
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.
+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.
- 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)
- 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.
- filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.
+Currently, only sorting by `name` or `creationTimestamp desc` is supported.
+ 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`)
+ 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.
+ filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.
-For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.
+For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
-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.
+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).
+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) ```
Returns:
An object of the form:
@@ -466,19 +508,13 @@
"items": [ # A list of VpnTunnel resources.
{ # Represents a Cloud VPN Tunnel resource.
#
- # For more information about VPN, read the the Cloud VPN Overview. (== resource_for beta.vpnTunnels ==) (== resource_for v1.vpnTunnels ==)
+ # For more information about VPN, read the the Cloud VPN Overview. (== resource_for {$api_version}.vpnTunnels ==)
"detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel.
- "ikeVersion": 42, # IKE protocol version to use when establishing the VPN tunnel with the peer VPN gateway. Acceptable IKE versions are 1 or 2. The default version is 2.
- "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
- "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported.
- "A String",
- ],
- "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "vpnGateway": "A String", # URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This must be used (instead of target_vpn_gateway) if a High Availability VPN gateway resource is created.
+ "peerExternalGatewayInterface": 42, # The interface ID of the external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created.
+ "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
"peerIp": "A String", # IP address of the peer VPN gateway. Only IPv4 is supported.
- "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
- "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported.
- "A String",
- ],
"targetVpnGateway": "A String", # URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.
"status": "A String", # [Output Only] The status of the VPN tunnel, which can be one of the following:
# - PROVISIONING: Resource is being allocated for the VPN tunnel.
@@ -490,13 +526,30 @@
# - NEGOTIATION_FAILURE: Handshake failed.
# - DEPROVISIONING: Resources are being deallocated for the VPN tunnel.
# - FAILED: Tunnel creation has failed and the tunnel is not ready to be used.
+ # - NO_INCOMING_PACKETS: No incoming packets from peer.
+ # - REJECTED: Tunnel configuration was rejected, can be result of being blacklisted.
+ # - ALLOCATING_RESOURCES: Cloud VPN is in the process of allocating all required resources.
+ # - STOPPED: Tunnel is stopped due to its Forwarding Rules being deleted for Classic VPN tunnels or the project is in frozen state.
+ # - PEER_IDENTITY_MISMATCH: Peer identity does not match peer IP, probably behind NAT.
+ # - TS_NARROWING_NOT_ALLOWED: Traffic selector narrowing not allowed for an HA-VPN tunnel.
+ "ikeVersion": 42, # IKE protocol version to use when establishing the VPN tunnel with the peer VPN gateway. Acceptable IKE versions are 1 or 2. The default version is 2.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported.
+ "A String",
+ ],
+ "peerGcpGateway": "A String", # URL of the peer side HA GCP VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field can be used when creating highly available VPN from VPC network to VPC network, the field is exclusive with the field peerExternalGateway. If provided, the VPN tunnel will automatically use the same vpnGatewayInterface ID in the peer GCP VPN gateway.
"sharedSecretHash": "A String", # Hash of the shared secret.
- "router": "A String", # URL of the router resource to be used for dynamic routing.
+ "vpnGatewayInterface": 42, # The interface ID of the VPN gateway with which this VPN tunnel is associated.
"sharedSecret": "A String", # Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
- "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
+ "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported.
+ "A String",
+ ],
"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.
+ "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+ "peerExternalGateway": "A String", # URL of the peer side external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field is exclusive with the field peerGcpGateway.
+ "router": "A String", # URL of the router resource to be used for dynamic routing.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
},
],
"warning": { # [Output Only] Informational warning message.