1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.vpnTunnels.html">vpnTunnels</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 tunnels.</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, vpnTunnel, requestId=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Deletes the specified VpnTunnel resource.</p> 89<p class="toc_element"> 90 <code><a href="#get">get(project, region, vpnTunnel, x__xgafv=None)</a></code></p> 91<p class="firstline">Returns the specified VpnTunnel resource. Gets a list of available VPN tunnels by making a list() request.</p> 92<p class="toc_element"> 93 <code><a href="#insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</a></code></p> 94<p class="firstline">Creates a VpnTunnel resource in the specified project and region using the data included in the request.</p> 95<p class="toc_element"> 96 <code><a href="#list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Retrieves a list of VpnTunnel resources contained in the specified project and region.</p> 98<p class="toc_element"> 99 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 100<p class="firstline">Retrieves the next page of results.</p> 101<p class="toc_element"> 102 <code><a href="#setLabels">setLabels(project, region, resource, body=None, requestId=None, x__xgafv=None)</a></code></p> 103<p class="firstline">Sets the labels on a VpnTunnel. To learn more about labels, read the Labeling Resources documentation.</p> 104<p class="toc_element"> 105 <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</a></code></p> 106<p class="firstline">Returns permissions that a caller has on the specified resource.</p> 107<h3>Method Details</h3> 108<div class="method"> 109 <code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 110 <pre>Retrieves an aggregated list of VPN tunnels. 111 112Args: 113 project: string, Project ID for this request. (required) 114 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) ``` 115 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. 116 maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) 117 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. 118 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. 119 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 120 x__xgafv: string, V1 error format. 121 Allowed values 122 1 - v1 error format 123 2 - v2 error format 124 125Returns: 126 An object of the form: 127 128 { 129 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 130 "items": { # A list of VpnTunnelsScopedList resources. 131 "a_key": { # Name of the scope containing this set of VPN tunnels. 132 "vpnTunnels": [ # A list of VPN tunnels contained in this scope. 133 { # Represents a Cloud VPN Tunnel resource. For more information about VPN, read the the Cloud VPN Overview. 134 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 135 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 136 "detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel. 137 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 138 "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. 139 "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels. 140 "labelFingerprint": "A String", # A fingerprint for the labels being applied to this VpnTunnel, 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 a VpnTunnel. 141 "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. 142 "a_key": "A String", 143 }, 144 "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. 145 "A String", 146 ], 147 "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. 148 "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. 149 "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. 150 "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. 151 "peerIp": "A String", # IP address of the peer VPN gateway. Only IPv4 is supported. 152 "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. 153 "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. 154 "A String", 155 ], 156 "router": "A String", # URL of the router resource to be used for dynamic routing. 157 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 158 "sharedSecret": "A String", # Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway. 159 "sharedSecretHash": "A String", # Hash of the shared secret. 160 "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. - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, and Route resources are needed to setup the VPN tunnel. - FIRST_HANDSHAKE: Successful first handshake with the peer VPN. - ESTABLISHED: Secure session is successfully established with the peer VPN. - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS - AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). - 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 denied access. - 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. 161 "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. 162 "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. 163 "vpnGatewayInterface": 42, # The interface ID of the VPN gateway with which this VPN tunnel is associated. 164 }, 165 ], 166 "warning": { # Informational warning which replaces the list of addresses when the list is empty. 167 "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. 168 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 169 { 170 "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). 171 "value": "A String", # [Output Only] A warning data value corresponding to the key. 172 }, 173 ], 174 "message": "A String", # [Output Only] A human-readable description of the warning code. 175 }, 176 }, 177 }, 178 "kind": "compute#vpnTunnelAggregatedList", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels. 179 "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. 180 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 181 "unreachables": [ # [Output Only] Unreachable resources. 182 "A String", 183 ], 184 "warning": { # [Output Only] Informational warning message. 185 "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. 186 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 187 { 188 "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). 189 "value": "A String", # [Output Only] A warning data value corresponding to the key. 190 }, 191 ], 192 "message": "A String", # [Output Only] A human-readable description of the warning code. 193 }, 194}</pre> 195</div> 196 197<div class="method"> 198 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code> 199 <pre>Retrieves the next page of results. 200 201Args: 202 previous_request: The request for the previous page. (required) 203 previous_response: The response from the request for the previous page. (required) 204 205Returns: 206 A request object that you can call 'execute()' on to request the next 207 page. Returns None if there are no more items in the collection. 208 </pre> 209</div> 210 211<div class="method"> 212 <code class="details" id="close">close()</code> 213 <pre>Close httplib2 connections.</pre> 214</div> 215 216<div class="method"> 217 <code class="details" id="delete">delete(project, region, vpnTunnel, requestId=None, x__xgafv=None)</code> 218 <pre>Deletes the specified VpnTunnel resource. 219 220Args: 221 project: string, Project ID for this request. (required) 222 region: string, Name of the region for this request. (required) 223 vpnTunnel: string, Name of the VpnTunnel resource to delete. (required) 224 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). 225 x__xgafv: string, V1 error format. 226 Allowed values 227 1 - v1 error format 228 2 - v2 error format 229 230Returns: 231 An object of the form: 232 233 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/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. 234 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 235 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 236 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 237 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 238 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 239 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 240 { 241 "code": "A String", # [Output Only] The error type identifier for this error. 242 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 243 "message": "A String", # [Output Only] An optional, human-readable error message. 244 }, 245 ], 246 }, 247 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 248 "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. 249 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 250 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 251 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 252 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 253 "a_key": "", # Properties of the object. Contains field @type with type URL. 254 }, 255 "name": "A String", # [Output Only] Name of the operation. 256 "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. 257 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 258 "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. 259 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 260 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 261 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 262 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 263 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 264 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 265 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 266 "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. 267 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 268 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 269 { 270 "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. 271 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 272 { 273 "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). 274 "value": "A String", # [Output Only] A warning data value corresponding to the key. 275 }, 276 ], 277 "message": "A String", # [Output Only] A human-readable description of the warning code. 278 }, 279 ], 280 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 281}</pre> 282</div> 283 284<div class="method"> 285 <code class="details" id="get">get(project, region, vpnTunnel, x__xgafv=None)</code> 286 <pre>Returns the specified VpnTunnel resource. Gets a list of available VPN tunnels by making a list() request. 287 288Args: 289 project: string, Project ID for this request. (required) 290 region: string, Name of the region for this request. (required) 291 vpnTunnel: string, Name of the VpnTunnel resource to return. (required) 292 x__xgafv: string, V1 error format. 293 Allowed values 294 1 - v1 error format 295 2 - v2 error format 296 297Returns: 298 An object of the form: 299 300 { # Represents a Cloud VPN Tunnel resource. For more information about VPN, read the the Cloud VPN Overview. 301 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 302 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 303 "detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel. 304 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 305 "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. 306 "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels. 307 "labelFingerprint": "A String", # A fingerprint for the labels being applied to this VpnTunnel, 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 a VpnTunnel. 308 "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. 309 "a_key": "A String", 310 }, 311 "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. 312 "A String", 313 ], 314 "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. 315 "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. 316 "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. 317 "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. 318 "peerIp": "A String", # IP address of the peer VPN gateway. Only IPv4 is supported. 319 "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. 320 "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. 321 "A String", 322 ], 323 "router": "A String", # URL of the router resource to be used for dynamic routing. 324 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 325 "sharedSecret": "A String", # Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway. 326 "sharedSecretHash": "A String", # Hash of the shared secret. 327 "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. - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, and Route resources are needed to setup the VPN tunnel. - FIRST_HANDSHAKE: Successful first handshake with the peer VPN. - ESTABLISHED: Secure session is successfully established with the peer VPN. - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS - AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). - 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 denied access. - 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. 328 "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. 329 "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. 330 "vpnGatewayInterface": 42, # The interface ID of the VPN gateway with which this VPN tunnel is associated. 331}</pre> 332</div> 333 334<div class="method"> 335 <code class="details" id="insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</code> 336 <pre>Creates a VpnTunnel resource in the specified project and region using the data included in the request. 337 338Args: 339 project: string, Project ID for this request. (required) 340 region: string, Name of the region for this request. (required) 341 body: object, The request body. 342 The object takes the form of: 343 344{ # Represents a Cloud VPN Tunnel resource. For more information about VPN, read the the Cloud VPN Overview. 345 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 346 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 347 "detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel. 348 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 349 "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. 350 "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels. 351 "labelFingerprint": "A String", # A fingerprint for the labels being applied to this VpnTunnel, 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 a VpnTunnel. 352 "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. 353 "a_key": "A String", 354 }, 355 "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. 356 "A String", 357 ], 358 "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. 359 "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. 360 "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. 361 "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. 362 "peerIp": "A String", # IP address of the peer VPN gateway. Only IPv4 is supported. 363 "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. 364 "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. 365 "A String", 366 ], 367 "router": "A String", # URL of the router resource to be used for dynamic routing. 368 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 369 "sharedSecret": "A String", # Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway. 370 "sharedSecretHash": "A String", # Hash of the shared secret. 371 "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. - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, and Route resources are needed to setup the VPN tunnel. - FIRST_HANDSHAKE: Successful first handshake with the peer VPN. - ESTABLISHED: Secure session is successfully established with the peer VPN. - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS - AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). - 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 denied access. - 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. 372 "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. 373 "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. 374 "vpnGatewayInterface": 42, # The interface ID of the VPN gateway with which this VPN tunnel is associated. 375} 376 377 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). 378 x__xgafv: string, V1 error format. 379 Allowed values 380 1 - v1 error format 381 2 - v2 error format 382 383Returns: 384 An object of the form: 385 386 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/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. 387 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 388 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 389 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 390 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 391 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 392 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 393 { 394 "code": "A String", # [Output Only] The error type identifier for this error. 395 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 396 "message": "A String", # [Output Only] An optional, human-readable error message. 397 }, 398 ], 399 }, 400 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 401 "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. 402 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 403 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 404 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 405 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 406 "a_key": "", # Properties of the object. Contains field @type with type URL. 407 }, 408 "name": "A String", # [Output Only] Name of the operation. 409 "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. 410 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 411 "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. 412 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 413 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 414 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 415 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 416 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 417 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 418 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 419 "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. 420 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 421 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 422 { 423 "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. 424 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 425 { 426 "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). 427 "value": "A String", # [Output Only] A warning data value corresponding to the key. 428 }, 429 ], 430 "message": "A String", # [Output Only] A human-readable description of the warning code. 431 }, 432 ], 433 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 434}</pre> 435</div> 436 437<div class="method"> 438 <code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 439 <pre>Retrieves a list of VpnTunnel resources contained in the specified project and region. 440 441Args: 442 project: string, Project ID for this request. (required) 443 region: string, Name of the region for this request. (required) 444 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) ``` 445 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`) 446 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. 447 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. 448 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 449 x__xgafv: string, V1 error format. 450 Allowed values 451 1 - v1 error format 452 2 - v2 error format 453 454Returns: 455 An object of the form: 456 457 { # Contains a list of VpnTunnel resources. 458 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 459 "items": [ # A list of VpnTunnel resources. 460 { # Represents a Cloud VPN Tunnel resource. For more information about VPN, read the the Cloud VPN Overview. 461 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 462 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 463 "detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel. 464 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 465 "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. 466 "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels. 467 "labelFingerprint": "A String", # A fingerprint for the labels being applied to this VpnTunnel, 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 a VpnTunnel. 468 "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. 469 "a_key": "A String", 470 }, 471 "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. 472 "A String", 473 ], 474 "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. 475 "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. 476 "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. 477 "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. 478 "peerIp": "A String", # IP address of the peer VPN gateway. Only IPv4 is supported. 479 "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. 480 "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. 481 "A String", 482 ], 483 "router": "A String", # URL of the router resource to be used for dynamic routing. 484 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 485 "sharedSecret": "A String", # Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway. 486 "sharedSecretHash": "A String", # Hash of the shared secret. 487 "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. - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, and Route resources are needed to setup the VPN tunnel. - FIRST_HANDSHAKE: Successful first handshake with the peer VPN. - ESTABLISHED: Secure session is successfully established with the peer VPN. - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS - AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). - 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 denied access. - 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. 488 "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. 489 "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. 490 "vpnGatewayInterface": 42, # The interface ID of the VPN gateway with which this VPN tunnel is associated. 491 }, 492 ], 493 "kind": "compute#vpnTunnelList", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels. 494 "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. 495 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 496 "warning": { # [Output Only] Informational warning message. 497 "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. 498 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 499 { 500 "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). 501 "value": "A String", # [Output Only] A warning data value corresponding to the key. 502 }, 503 ], 504 "message": "A String", # [Output Only] A human-readable description of the warning code. 505 }, 506}</pre> 507</div> 508 509<div class="method"> 510 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 511 <pre>Retrieves the next page of results. 512 513Args: 514 previous_request: The request for the previous page. (required) 515 previous_response: The response from the request for the previous page. (required) 516 517Returns: 518 A request object that you can call 'execute()' on to request the next 519 page. Returns None if there are no more items in the collection. 520 </pre> 521</div> 522 523<div class="method"> 524 <code class="details" id="setLabels">setLabels(project, region, resource, body=None, requestId=None, x__xgafv=None)</code> 525 <pre>Sets the labels on a VpnTunnel. To learn more about labels, read the Labeling Resources documentation. 526 527Args: 528 project: string, Project ID for this request. (required) 529 region: string, The region for this request. (required) 530 resource: string, Name or id of the resource for this request. (required) 531 body: object, The request body. 532 The object takes the form of: 533 534{ 535 "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. 536 "labels": { # The labels to set for this resource. 537 "a_key": "A String", 538 }, 539} 540 541 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). 542 x__xgafv: string, V1 error format. 543 Allowed values 544 1 - v1 error format 545 2 - v2 error format 546 547Returns: 548 An object of the form: 549 550 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/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. 551 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 552 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 553 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 554 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 555 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 556 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 557 { 558 "code": "A String", # [Output Only] The error type identifier for this error. 559 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 560 "message": "A String", # [Output Only] An optional, human-readable error message. 561 }, 562 ], 563 }, 564 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 565 "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. 566 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 567 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 568 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 569 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 570 "a_key": "", # Properties of the object. Contains field @type with type URL. 571 }, 572 "name": "A String", # [Output Only] Name of the operation. 573 "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. 574 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 575 "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. 576 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 577 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 578 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 579 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 580 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 581 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 582 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 583 "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. 584 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 585 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 586 { 587 "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. 588 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 589 { 590 "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). 591 "value": "A String", # [Output Only] A warning data value corresponding to the key. 592 }, 593 ], 594 "message": "A String", # [Output Only] A human-readable description of the warning code. 595 }, 596 ], 597 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 598}</pre> 599</div> 600 601<div class="method"> 602 <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</code> 603 <pre>Returns permissions that a caller has on the specified resource. 604 605Args: 606 project: string, Project ID for this request. (required) 607 region: string, The name of the region for this request. (required) 608 resource: string, Name or id of the resource for this request. (required) 609 body: object, The request body. 610 The object takes the form of: 611 612{ 613 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. 614 "A String", 615 ], 616} 617 618 x__xgafv: string, V1 error format. 619 Allowed values 620 1 - v1 error format 621 2 - v2 error format 622 623Returns: 624 An object of the form: 625 626 { 627 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 628 "A String", 629 ], 630}</pre> 631</div> 632 633</body></html>