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, orderBy=None, maxResults=None, pageToken=None, filter=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="#delete">delete(project, region, vpnTunnel, requestId=None)</a></code></p> 85<p class="firstline">Deletes the specified VpnTunnel resource.</p> 86<p class="toc_element"> 87 <code><a href="#get">get(project, region, vpnTunnel)</a></code></p> 88<p class="firstline">Returns the specified VpnTunnel resource. Gets a list of available VPN tunnels by making a list() request.</p> 89<p class="toc_element"> 90 <code><a href="#insert">insert(project, region, body, requestId=None)</a></code></p> 91<p class="firstline">Creates a VpnTunnel resource in the specified project and region using the data included in the request.</p> 92<p class="toc_element"> 93 <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p> 94<p class="firstline">Retrieves a list of VpnTunnel resources contained in the specified project and region.</p> 95<p class="toc_element"> 96 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 97<p class="firstline">Retrieves the next page of results.</p> 98<p class="toc_element"> 99 <code><a href="#setLabels">setLabels(project, region, resource, body, requestId=None)</a></code></p> 100<p class="firstline">Sets the labels on a VpnTunnel. To learn more about labels, read the Labeling Resources documentation.</p> 101<p class="toc_element"> 102 <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body)</a></code></p> 103<p class="firstline">Returns permissions that a caller has on the specified resource.</p> 104<h3>Method Details</h3> 105<div class="method"> 106 <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 107 <pre>Retrieves an aggregated list of VPN tunnels. 108 109Args: 110 project: string, Project ID for this request. (required) 111 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 112 113You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. 114 115Currently, only sorting by name or creationTimestamp desc is supported. 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 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. 118 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. 119 120For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. 121 122You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. 123 124To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). 125 126Returns: 127 An object of the form: 128 129 { 130 "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. 131 "kind": "compute#vpnTunnelAggregatedList", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels. 132 "items": { # A list of VpnTunnelsScopedList resources. 133 "a_key": { # Name of the scope containing this set of VPN tunnels. 134 "vpnTunnels": [ # A list of VPN tunnels contained in this scope. 135 { # Represents a Cloud VPN Tunnel resource. 136 # 137 # For more information about VPN, read the the Cloud VPN Overview. (== resource_for beta.vpnTunnels ==) (== resource_for v1.vpnTunnels ==) 138 "detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel. 139 "labels": { # Labels to apply to this VpnTunnel. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. 140 "a_key": "A String", 141 }, 142 "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. 143 "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. 144 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 145 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 146 "peerIp": "A String", # IP address of the peer VPN gateway. Only IPv4 is supported. 147 "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. 148 "status": "A String", # [Output Only] The status of the VPN tunnel, which can be one of the following: 149 # - PROVISIONING: Resource is being allocated for the VPN tunnel. 150 # - 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. 151 # - FIRST_HANDSHAKE: Successful first handshake with the peer VPN. 152 # - ESTABLISHED: Secure session is successfully established with the peer VPN. 153 # - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS 154 # - AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). 155 # - NEGOTIATION_FAILURE: Handshake failed. 156 # - DEPROVISIONING: Resources are being deallocated for the VPN tunnel. 157 # - FAILED: Tunnel creation has failed and the tunnel is not ready to be used. 158 "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. 159 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 160 "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. 161 # 162 # To see the latest fingerprint, make a get() request to retrieve a VpnTunnel. 163 "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. 164 "A String", 165 ], 166 "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. 167 "sharedSecretHash": "A String", # Hash of the shared secret. 168 "vpnGatewayInterface": 42, # The interface ID of the VPN gateway with which this VPN tunnel is associated. 169 "sharedSecret": "A String", # Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway. 170 "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels. 171 "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. 172 "A String", 173 ], 174 "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. 175 "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. 176 "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. 177 "router": "A String", # URL of the router resource to be used for dynamic routing. 178 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 179 }, 180 ], 181 "warning": { # Informational warning which replaces the list of addresses when the list is empty. 182 "message": "A String", # [Output Only] A human-readable description of the warning code. 183 "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. 184 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 185 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 186 { 187 "value": "A String", # [Output Only] A warning data value corresponding to the key. 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 }, 190 ], 191 }, 192 }, 193 }, 194 "warning": { # [Output Only] Informational warning message. 195 "message": "A String", # [Output Only] A human-readable description of the warning code. 196 "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. 197 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 198 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 199 { 200 "value": "A String", # [Output Only] A warning data value corresponding to the key. 201 "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). 202 }, 203 ], 204 }, 205 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 206 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 207 }</pre> 208</div> 209 210<div class="method"> 211 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code> 212 <pre>Retrieves the next page of results. 213 214Args: 215 previous_request: The request for the previous page. (required) 216 previous_response: The response from the request for the previous page. (required) 217 218Returns: 219 A request object that you can call 'execute()' on to request the next 220 page. Returns None if there are no more items in the collection. 221 </pre> 222</div> 223 224<div class="method"> 225 <code class="details" id="delete">delete(project, region, vpnTunnel, requestId=None)</code> 226 <pre>Deletes the specified VpnTunnel resource. 227 228Args: 229 project: string, Project ID for this request. (required) 230 region: string, Name of the region for this request. (required) 231 vpnTunnel: string, Name of the VpnTunnel resource to delete. (required) 232 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. 233 234For 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. 235 236The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 237 238Returns: 239 An object of the form: 240 241 { # Represents an Operation resource. 242 # 243 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 244 # 245 # Operations can be global, regional or zonal. 246 # - For global operations, use the globalOperations resource. 247 # - For regional operations, use the regionOperations resource. 248 # - For zonal operations, use the zonalOperations resource. 249 # 250 # 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 ==) 251 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 252 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 253 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 254 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 255 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 256 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 257 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 258 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 259 "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. 260 "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. 261 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 262 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 263 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 264 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 265 { 266 "message": "A String", # [Output Only] A human-readable description of the warning code. 267 "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. 268 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 269 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 270 { 271 "value": "A String", # [Output Only] A warning data value corresponding to the key. 272 "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). 273 }, 274 ], 275 }, 276 ], 277 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 278 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 279 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 280 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 281 "name": "A String", # [Output Only] Name of the resource. 282 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 283 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 284 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 285 { 286 "message": "A String", # [Output Only] An optional, human-readable error message. 287 "code": "A String", # [Output Only] The error type identifier for this error. 288 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 289 }, 290 ], 291 }, 292 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 293 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 294 "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. 295 }</pre> 296</div> 297 298<div class="method"> 299 <code class="details" id="get">get(project, region, vpnTunnel)</code> 300 <pre>Returns the specified VpnTunnel resource. Gets a list of available VPN tunnels by making a list() request. 301 302Args: 303 project: string, Project ID for this request. (required) 304 region: string, Name of the region for this request. (required) 305 vpnTunnel: string, Name of the VpnTunnel resource to return. (required) 306 307Returns: 308 An object of the form: 309 310 { # Represents a Cloud VPN Tunnel resource. 311 # 312 # For more information about VPN, read the the Cloud VPN Overview. (== resource_for beta.vpnTunnels ==) (== resource_for v1.vpnTunnels ==) 313 "detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel. 314 "labels": { # Labels to apply to this VpnTunnel. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. 315 "a_key": "A String", 316 }, 317 "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. 318 "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. 319 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 320 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 321 "peerIp": "A String", # IP address of the peer VPN gateway. Only IPv4 is supported. 322 "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. 323 "status": "A String", # [Output Only] The status of the VPN tunnel, which can be one of the following: 324 # - PROVISIONING: Resource is being allocated for the VPN tunnel. 325 # - 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. 326 # - FIRST_HANDSHAKE: Successful first handshake with the peer VPN. 327 # - ESTABLISHED: Secure session is successfully established with the peer VPN. 328 # - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS 329 # - AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). 330 # - NEGOTIATION_FAILURE: Handshake failed. 331 # - DEPROVISIONING: Resources are being deallocated for the VPN tunnel. 332 # - FAILED: Tunnel creation has failed and the tunnel is not ready to be used. 333 "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. 334 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 335 "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. 336 # 337 # To see the latest fingerprint, make a get() request to retrieve a VpnTunnel. 338 "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. 339 "A String", 340 ], 341 "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. 342 "sharedSecretHash": "A String", # Hash of the shared secret. 343 "vpnGatewayInterface": 42, # The interface ID of the VPN gateway with which this VPN tunnel is associated. 344 "sharedSecret": "A String", # Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway. 345 "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels. 346 "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. 347 "A String", 348 ], 349 "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. 350 "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. 351 "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. 352 "router": "A String", # URL of the router resource to be used for dynamic routing. 353 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 354 }</pre> 355</div> 356 357<div class="method"> 358 <code class="details" id="insert">insert(project, region, body, requestId=None)</code> 359 <pre>Creates a VpnTunnel resource in the specified project and region using the data included in the request. 360 361Args: 362 project: string, Project ID for this request. (required) 363 region: string, Name of the region for this request. (required) 364 body: object, The request body. (required) 365 The object takes the form of: 366 367{ # Represents a Cloud VPN Tunnel resource. 368 # 369 # For more information about VPN, read the the Cloud VPN Overview. (== resource_for beta.vpnTunnels ==) (== resource_for v1.vpnTunnels ==) 370 "detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel. 371 "labels": { # Labels to apply to this VpnTunnel. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. 372 "a_key": "A String", 373 }, 374 "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. 375 "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. 376 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 377 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 378 "peerIp": "A String", # IP address of the peer VPN gateway. Only IPv4 is supported. 379 "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. 380 "status": "A String", # [Output Only] The status of the VPN tunnel, which can be one of the following: 381 # - PROVISIONING: Resource is being allocated for the VPN tunnel. 382 # - 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. 383 # - FIRST_HANDSHAKE: Successful first handshake with the peer VPN. 384 # - ESTABLISHED: Secure session is successfully established with the peer VPN. 385 # - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS 386 # - AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). 387 # - NEGOTIATION_FAILURE: Handshake failed. 388 # - DEPROVISIONING: Resources are being deallocated for the VPN tunnel. 389 # - FAILED: Tunnel creation has failed and the tunnel is not ready to be used. 390 "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. 391 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 392 "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. 393 # 394 # To see the latest fingerprint, make a get() request to retrieve a VpnTunnel. 395 "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. 396 "A String", 397 ], 398 "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. 399 "sharedSecretHash": "A String", # Hash of the shared secret. 400 "vpnGatewayInterface": 42, # The interface ID of the VPN gateway with which this VPN tunnel is associated. 401 "sharedSecret": "A String", # Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway. 402 "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels. 403 "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. 404 "A String", 405 ], 406 "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. 407 "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. 408 "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. 409 "router": "A String", # URL of the router resource to be used for dynamic routing. 410 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 411 } 412 413 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. 414 415For 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. 416 417The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 418 419Returns: 420 An object of the form: 421 422 { # Represents an Operation resource. 423 # 424 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 425 # 426 # Operations can be global, regional or zonal. 427 # - For global operations, use the globalOperations resource. 428 # - For regional operations, use the regionOperations resource. 429 # - For zonal operations, use the zonalOperations resource. 430 # 431 # 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 ==) 432 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 433 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 434 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 435 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 436 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 437 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 438 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 439 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 440 "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. 441 "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. 442 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 443 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 444 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 445 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 446 { 447 "message": "A String", # [Output Only] A human-readable description of the warning code. 448 "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. 449 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 450 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 451 { 452 "value": "A String", # [Output Only] A warning data value corresponding to the key. 453 "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). 454 }, 455 ], 456 }, 457 ], 458 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 459 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 460 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 461 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 462 "name": "A String", # [Output Only] Name of the resource. 463 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 464 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 465 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 466 { 467 "message": "A String", # [Output Only] An optional, human-readable error message. 468 "code": "A String", # [Output Only] The error type identifier for this error. 469 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 470 }, 471 ], 472 }, 473 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 474 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 475 "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. 476 }</pre> 477</div> 478 479<div class="method"> 480 <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 481 <pre>Retrieves a list of VpnTunnel resources contained in the specified project and region. 482 483Args: 484 project: string, Project ID for this request. (required) 485 region: string, Name of the region for this request. (required) 486 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 487 488You 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. 489 490Currently, only sorting by name or creationTimestamp desc is supported. 491 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) 492 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. 493 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 <. 494 495For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. 496 497You 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. 498 499To 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). 500 501Returns: 502 An object of the form: 503 504 { # Contains a list of VpnTunnel resources. 505 "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. 506 "kind": "compute#vpnTunnelList", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels. 507 "items": [ # A list of VpnTunnel resources. 508 { # Represents a Cloud VPN Tunnel resource. 509 # 510 # For more information about VPN, read the the Cloud VPN Overview. (== resource_for beta.vpnTunnels ==) (== resource_for v1.vpnTunnels ==) 511 "detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel. 512 "labels": { # Labels to apply to this VpnTunnel. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. 513 "a_key": "A String", 514 }, 515 "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. 516 "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. 517 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 518 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 519 "peerIp": "A String", # IP address of the peer VPN gateway. Only IPv4 is supported. 520 "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. 521 "status": "A String", # [Output Only] The status of the VPN tunnel, which can be one of the following: 522 # - PROVISIONING: Resource is being allocated for the VPN tunnel. 523 # - 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. 524 # - FIRST_HANDSHAKE: Successful first handshake with the peer VPN. 525 # - ESTABLISHED: Secure session is successfully established with the peer VPN. 526 # - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS 527 # - AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). 528 # - NEGOTIATION_FAILURE: Handshake failed. 529 # - DEPROVISIONING: Resources are being deallocated for the VPN tunnel. 530 # - FAILED: Tunnel creation has failed and the tunnel is not ready to be used. 531 "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. 532 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 533 "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. 534 # 535 # To see the latest fingerprint, make a get() request to retrieve a VpnTunnel. 536 "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. 537 "A String", 538 ], 539 "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. 540 "sharedSecretHash": "A String", # Hash of the shared secret. 541 "vpnGatewayInterface": 42, # The interface ID of the VPN gateway with which this VPN tunnel is associated. 542 "sharedSecret": "A String", # Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway. 543 "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels. 544 "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. 545 "A String", 546 ], 547 "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. 548 "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. 549 "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. 550 "router": "A String", # URL of the router resource to be used for dynamic routing. 551 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 552 }, 553 ], 554 "warning": { # [Output Only] Informational warning message. 555 "message": "A String", # [Output Only] A human-readable description of the warning code. 556 "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. 557 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 558 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 559 { 560 "value": "A String", # [Output Only] A warning data value corresponding to the key. 561 "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). 562 }, 563 ], 564 }, 565 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 566 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 567 }</pre> 568</div> 569 570<div class="method"> 571 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 572 <pre>Retrieves the next page of results. 573 574Args: 575 previous_request: The request for the previous page. (required) 576 previous_response: The response from the request for the previous page. (required) 577 578Returns: 579 A request object that you can call 'execute()' on to request the next 580 page. Returns None if there are no more items in the collection. 581 </pre> 582</div> 583 584<div class="method"> 585 <code class="details" id="setLabels">setLabels(project, region, resource, body, requestId=None)</code> 586 <pre>Sets the labels on a VpnTunnel. To learn more about labels, read the Labeling Resources documentation. 587 588Args: 589 project: string, Project ID for this request. (required) 590 region: string, The region for this request. (required) 591 resource: string, Name or id of the resource for this request. (required) 592 body: object, The request body. (required) 593 The object takes the form of: 594 595{ 596 "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. 597 "labels": { # The labels to set for this resource. 598 "a_key": "A String", 599 }, 600 } 601 602 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. 603 604For 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. 605 606The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 607 608Returns: 609 An object of the form: 610 611 { # Represents an Operation resource. 612 # 613 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 614 # 615 # Operations can be global, regional or zonal. 616 # - For global operations, use the globalOperations resource. 617 # - For regional operations, use the regionOperations resource. 618 # - For zonal operations, use the zonalOperations resource. 619 # 620 # 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 ==) 621 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 622 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 623 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 624 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 625 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 626 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 627 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 628 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 629 "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. 630 "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. 631 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 632 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 633 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 634 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 635 { 636 "message": "A String", # [Output Only] A human-readable description of the warning code. 637 "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. 638 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 639 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 640 { 641 "value": "A String", # [Output Only] A warning data value corresponding to the key. 642 "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). 643 }, 644 ], 645 }, 646 ], 647 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 648 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 649 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 650 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 651 "name": "A String", # [Output Only] Name of the resource. 652 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 653 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 654 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 655 { 656 "message": "A String", # [Output Only] An optional, human-readable error message. 657 "code": "A String", # [Output Only] The error type identifier for this error. 658 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 659 }, 660 ], 661 }, 662 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 663 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 664 "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. 665 }</pre> 666</div> 667 668<div class="method"> 669 <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body)</code> 670 <pre>Returns permissions that a caller has on the specified resource. 671 672Args: 673 project: string, Project ID for this request. (required) 674 region: string, The name of the region for this request. (required) 675 resource: string, Name or id of the resource for this request. (required) 676 body: object, The request body. (required) 677 The object takes the form of: 678 679{ 680 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. 681 "A String", 682 ], 683 } 684 685 686Returns: 687 An object of the form: 688 689 { 690 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 691 "A String", 692 ], 693 }</pre> 694</div> 695 696</body></html>