1 <html><body> 2 <style> 3 4 body, 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 15 body { 16 font-size: 13px; 17 padding: 1em; 18 } 19 20 h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23 } 24 25 h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28 } 29 30 h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34 } 35 36 pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39 } 40 41 pre { 42 margin-top: 0.5em; 43 } 44 45 h1, h2, h3, p { 46 font-family: Arial, sans serif; 47 } 48 49 h1, 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. Get 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 or Tagging 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 109 Args: 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 113 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. 114 115 Currently, 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, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. 119 120 The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. 121 122 For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. 123 124 You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. 125 126 To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. 127 128 Returns: 129 An object of the form: 130 131 { 132 "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. 133 "items": { # [Output Only] A map of scoped vpn tunnel lists. 134 "a_key": { # Name of the scope containing this set of vpn tunnels. 135 "vpnTunnels": [ # List of vpn tunnels contained in this scope. 136 { 137 "detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel. 138 "ikeVersion": 42, # IKE protocol version to use when establishing the VPN tunnel with peer VPN gateway. Acceptable IKE versions are 1 or 2. Default version is 2. 139 "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels. 140 "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with 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. 141 "A String", 142 ], 143 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 144 "peerIp": "A String", # IP address of the peer VPN gateway. Only IPv4 is supported. 145 "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. 146 # 147 # To see the latest fingerprint, make a get() request to retrieve a VpnTunnel. 148 "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. 149 "a_key": "A String", 150 }, 151 "targetVpnGateway": "A String", # URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. 152 "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with 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. 153 "A String", 154 ], 155 "status": "A String", # [Output Only] The status of the VPN tunnel. 156 "sharedSecretHash": "A String", # Hash of the shared secret. 157 "router": "A String", # URL of router resource to be used for dynamic routing. 158 "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides. 159 "sharedSecret": "A String", # Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway. 160 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 161 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 162 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 163 "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. 164 }, 165 ], 166 "warning": { # Informational warning which replaces the list of addresses when the list is empty. 167 "message": "A String", # [Output Only] A human-readable description of the warning code. 168 "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. 169 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 170 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 171 { 172 "value": "A String", # [Output Only] A warning data value corresponding to the key. 173 "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). 174 }, 175 ], 176 }, 177 }, 178 }, 179 "kind": "compute#vpnTunnelAggregatedList", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels. 180 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 181 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 182 }</pre> 183 </div> 184 185 <div class="method"> 186 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code> 187 <pre>Retrieves the next page of results. 188 189 Args: 190 previous_request: The request for the previous page. (required) 191 previous_response: The response from the request for the previous page. (required) 192 193 Returns: 194 A request object that you can call 'execute()' on to request the next 195 page. Returns None if there are no more items in the collection. 196 </pre> 197 </div> 198 199 <div class="method"> 200 <code class="details" id="delete">delete(project, region, vpnTunnel, requestId=None)</code> 201 <pre>Deletes the specified VpnTunnel resource. 202 203 Args: 204 project: string, Project ID for this request. (required) 205 region: string, Name of the region for this request. (required) 206 vpnTunnel: string, Name of the VpnTunnel resource to delete. (required) 207 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 208 209 Returns: 210 An object of the form: 211 212 { # An Operation resource, used to manage asynchronous API requests. 213 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 214 "clientOperationId": "A String", # [Output Only] Reserved for future use. 215 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 216 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 217 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 218 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 219 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 220 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 221 "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. 222 "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. 223 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 224 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 225 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 226 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 227 { 228 "message": "A String", # [Output Only] A human-readable description of the warning code. 229 "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. 230 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 231 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 232 { 233 "value": "A String", # [Output Only] A warning data value corresponding to the key. 234 "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). 235 }, 236 ], 237 }, 238 ], 239 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 240 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 241 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 242 "name": "A String", # [Output Only] Name of the resource. 243 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 244 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 245 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 246 { 247 "message": "A String", # [Output Only] An optional, human-readable error message. 248 "code": "A String", # [Output Only] The error type identifier for this error. 249 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 250 }, 251 ], 252 }, 253 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 254 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 255 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 256 }</pre> 257 </div> 258 259 <div class="method"> 260 <code class="details" id="get">get(project, region, vpnTunnel)</code> 261 <pre>Returns the specified VpnTunnel resource. Get a list of available VPN tunnels by making a list() request. 262 263 Args: 264 project: string, Project ID for this request. (required) 265 region: string, Name of the region for this request. (required) 266 vpnTunnel: string, Name of the VpnTunnel resource to return. (required) 267 268 Returns: 269 An object of the form: 270 271 { 272 "detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel. 273 "ikeVersion": 42, # IKE protocol version to use when establishing the VPN tunnel with peer VPN gateway. Acceptable IKE versions are 1 or 2. Default version is 2. 274 "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels. 275 "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with 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. 276 "A String", 277 ], 278 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 279 "peerIp": "A String", # IP address of the peer VPN gateway. Only IPv4 is supported. 280 "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. 281 # 282 # To see the latest fingerprint, make a get() request to retrieve a VpnTunnel. 283 "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. 284 "a_key": "A String", 285 }, 286 "targetVpnGateway": "A String", # URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. 287 "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with 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. 288 "A String", 289 ], 290 "status": "A String", # [Output Only] The status of the VPN tunnel. 291 "sharedSecretHash": "A String", # Hash of the shared secret. 292 "router": "A String", # URL of router resource to be used for dynamic routing. 293 "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides. 294 "sharedSecret": "A String", # Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway. 295 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 296 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 297 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 298 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 299 }</pre> 300 </div> 301 302 <div class="method"> 303 <code class="details" id="insert">insert(project, region, body, requestId=None)</code> 304 <pre>Creates a VpnTunnel resource in the specified project and region using the data included in the request. 305 306 Args: 307 project: string, Project ID for this request. (required) 308 region: string, Name of the region for this request. (required) 309 body: object, The request body. (required) 310 The object takes the form of: 311 312 { 313 "detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel. 314 "ikeVersion": 42, # IKE protocol version to use when establishing the VPN tunnel with peer VPN gateway. Acceptable IKE versions are 1 or 2. Default version is 2. 315 "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels. 316 "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with 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. 317 "A String", 318 ], 319 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 320 "peerIp": "A String", # IP address of the peer VPN gateway. Only IPv4 is supported. 321 "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. 322 # 323 # To see the latest fingerprint, make a get() request to retrieve a VpnTunnel. 324 "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. 325 "a_key": "A String", 326 }, 327 "targetVpnGateway": "A String", # URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. 328 "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with 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. 329 "A String", 330 ], 331 "status": "A String", # [Output Only] The status of the VPN tunnel. 332 "sharedSecretHash": "A String", # Hash of the shared secret. 333 "router": "A String", # URL of router resource to be used for dynamic routing. 334 "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides. 335 "sharedSecret": "A String", # Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway. 336 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 337 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 338 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 339 "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. 340 } 341 342 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 343 344 Returns: 345 An object of the form: 346 347 { # An Operation resource, used to manage asynchronous API requests. 348 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 349 "clientOperationId": "A String", # [Output Only] Reserved for future use. 350 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 351 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 352 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 353 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 354 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 355 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 356 "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. 357 "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. 358 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 359 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 360 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 361 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 362 { 363 "message": "A String", # [Output Only] A human-readable description of the warning code. 364 "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. 365 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 366 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 367 { 368 "value": "A String", # [Output Only] A warning data value corresponding to the key. 369 "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). 370 }, 371 ], 372 }, 373 ], 374 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 375 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 376 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 377 "name": "A String", # [Output Only] Name of the resource. 378 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 379 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 380 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 381 { 382 "message": "A String", # [Output Only] An optional, human-readable error message. 383 "code": "A String", # [Output Only] The error type identifier for this error. 384 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 385 }, 386 ], 387 }, 388 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 389 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 390 "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. 391 }</pre> 392 </div> 393 394 <div class="method"> 395 <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 396 <pre>Retrieves a list of VpnTunnel resources contained in the specified project and region. 397 398 Args: 399 project: string, Project ID for this request. (required) 400 region: string, Name of the region for this request. (required) 401 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 402 403 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. 404 405 Currently, only sorting by name or creationTimestamp desc is supported. 406 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) 407 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. 408 filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. 409 410 The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. 411 412 For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. 413 414 You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. 415 416 To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. 417 418 Returns: 419 An object of the form: 420 421 { # Contains a list of VpnTunnel resources. 422 "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. 423 "items": [ # [Output Only] A list of VpnTunnel resources. 424 { 425 "detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel. 426 "ikeVersion": 42, # IKE protocol version to use when establishing the VPN tunnel with peer VPN gateway. Acceptable IKE versions are 1 or 2. Default version is 2. 427 "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels. 428 "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with 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. 429 "A String", 430 ], 431 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 432 "peerIp": "A String", # IP address of the peer VPN gateway. Only IPv4 is supported. 433 "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. 434 # 435 # To see the latest fingerprint, make a get() request to retrieve a VpnTunnel. 436 "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. 437 "a_key": "A String", 438 }, 439 "targetVpnGateway": "A String", # URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. 440 "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with 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. 441 "A String", 442 ], 443 "status": "A String", # [Output Only] The status of the VPN tunnel. 444 "sharedSecretHash": "A String", # Hash of the shared secret. 445 "router": "A String", # URL of router resource to be used for dynamic routing. 446 "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides. 447 "sharedSecret": "A String", # Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway. 448 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 449 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 450 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 451 "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. 452 }, 453 ], 454 "kind": "compute#vpnTunnelList", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels. 455 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 456 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 457 }</pre> 458 </div> 459 460 <div class="method"> 461 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 462 <pre>Retrieves the next page of results. 463 464 Args: 465 previous_request: The request for the previous page. (required) 466 previous_response: The response from the request for the previous page. (required) 467 468 Returns: 469 A request object that you can call 'execute()' on to request the next 470 page. Returns None if there are no more items in the collection. 471 </pre> 472 </div> 473 474 <div class="method"> 475 <code class="details" id="setLabels">setLabels(project, region, resource, body, requestId=None)</code> 476 <pre>Sets the labels on a VpnTunnel. To learn more about labels, read the Labeling or Tagging Resources documentation. 477 478 Args: 479 project: string, Project ID for this request. (required) 480 region: string, The region for this request. (required) 481 resource: string, Name of the resource for this request. (required) 482 body: object, The request body. (required) 483 The object takes the form of: 484 485 { 486 "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. 487 "labels": { # The labels to set for this resource. 488 "a_key": "A String", 489 }, 490 } 491 492 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 493 494 Returns: 495 An object of the form: 496 497 { # An Operation resource, used to manage asynchronous API requests. 498 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 499 "clientOperationId": "A String", # [Output Only] Reserved for future use. 500 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 501 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 502 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 503 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 504 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 505 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 506 "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. 507 "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. 508 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 509 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 510 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 511 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 512 { 513 "message": "A String", # [Output Only] A human-readable description of the warning code. 514 "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. 515 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 516 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 517 { 518 "value": "A String", # [Output Only] A warning data value corresponding to the key. 519 "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). 520 }, 521 ], 522 }, 523 ], 524 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 525 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 526 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 527 "name": "A String", # [Output Only] Name of the resource. 528 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 529 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 530 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 531 { 532 "message": "A String", # [Output Only] An optional, human-readable error message. 533 "code": "A String", # [Output Only] The error type identifier for this error. 534 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 535 }, 536 ], 537 }, 538 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 539 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 540 "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. 541 }</pre> 542 </div> 543 544 <div class="method"> 545 <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body)</code> 546 <pre>Returns permissions that a caller has on the specified resource. 547 548 Args: 549 project: string, Project ID for this request. (required) 550 region: string, The name of the region for this request. (required) 551 resource: string, Name of the resource for this request. (required) 552 body: object, The request body. (required) 553 The object takes the form of: 554 555 { 556 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. 557 "A String", 558 ], 559 } 560 561 562 Returns: 563 An object of the form: 564 565 { 566 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 567 "A String", 568 ], 569 }</pre> 570 </div> 571 572 </body></html>
