1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="compute_beta.html">Compute Engine API</a> . <a href="compute_beta.targetVpnGateways.html">targetVpnGateways</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> 79<p class="firstline">Retrieves an aggregated list of target VPN gateways.</p> 80<p class="toc_element"> 81 <code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p> 82<p class="firstline">Retrieves the next page of results.</p> 83<p class="toc_element"> 84 <code><a href="#close">close()</a></code></p> 85<p class="firstline">Close httplib2 connections.</p> 86<p class="toc_element"> 87 <code><a href="#delete">delete(project, region, targetVpnGateway, requestId=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Deletes the specified target VPN gateway.</p> 89<p class="toc_element"> 90 <code><a href="#get">get(project, region, targetVpnGateway, x__xgafv=None)</a></code></p> 91<p class="firstline">Returns the specified target VPN gateway. Gets a list of available target VPN gateways by making a list() request.</p> 92<p class="toc_element"> 93 <code><a href="#insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</a></code></p> 94<p class="firstline">Creates a target VPN gateway in the specified project and region using the data included in the request.</p> 95<p class="toc_element"> 96 <code><a href="#list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Retrieves a list of target VPN gateways available to the specified project and region.</p> 98<p class="toc_element"> 99 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 100<p class="firstline">Retrieves the next page of results.</p> 101<p class="toc_element"> 102 <code><a href="#setLabels">setLabels(project, region, resource, body=None, requestId=None, x__xgafv=None)</a></code></p> 103<p class="firstline">Sets the labels on a TargetVpnGateway. To learn more about labels, read the Labeling Resources documentation.</p> 104<p class="toc_element"> 105 <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</a></code></p> 106<p class="firstline">Returns permissions that a caller has on the specified resource.</p> 107<h3>Method Details</h3> 108<div class="method"> 109 <code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 110 <pre>Retrieves an aggregated list of target VPN gateways. 111 112Args: 113 project: string, Project ID for this request. (required) 114 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` 115 includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. 116 maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) 117 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. 118 pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. 119 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 120 x__xgafv: string, V1 error format. 121 Allowed values 122 1 - v1 error format 123 2 - v2 error format 124 125Returns: 126 An object of the form: 127 128 { 129 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 130 "items": { # A list of TargetVpnGateway resources. 131 "a_key": { # [Output Only] Name of the scope containing this set of target VPN gateways. 132 "targetVpnGateways": [ # [Output Only] A list of target VPN gateways contained in this scope. 133 { # Represents a Target VPN Gateway resource. The target VPN gateway resource represents a Classic Cloud VPN gateway. For more information, read the the Cloud VPN Overview. 134 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 135 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 136 "forwardingRules": [ # [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated with a VPN gateway. 137 "A String", 138 ], 139 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 140 "kind": "compute#targetVpnGateway", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways. 141 "labelFingerprint": "A String", # A fingerprint for the labels being applied to this TargetVpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a TargetVpnGateway. 142 "labels": { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. 143 "a_key": "A String", 144 }, 145 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 146 "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. 147 "region": "A String", # [Output Only] URL of the region where the target VPN gateway resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. 148 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 149 "status": "A String", # [Output Only] The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING. 150 "tunnels": [ # [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using the compute.vpntunnels.insert method and associated with a VPN gateway. 151 "A String", 152 ], 153 }, 154 ], 155 "warning": { # [Output Only] Informational warning which replaces the list of addresses when the list is empty. 156 "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. 157 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 158 { 159 "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). 160 "value": "A String", # [Output Only] A warning data value corresponding to the key. 161 }, 162 ], 163 "message": "A String", # [Output Only] A human-readable description of the warning code. 164 }, 165 }, 166 }, 167 "kind": "compute#targetVpnGatewayAggregatedList", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways. 168 "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. 169 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 170 "unreachables": [ # [Output Only] Unreachable resources. 171 "A String", 172 ], 173 "warning": { # [Output Only] Informational warning message. 174 "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. 175 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 176 { 177 "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). 178 "value": "A String", # [Output Only] A warning data value corresponding to the key. 179 }, 180 ], 181 "message": "A String", # [Output Only] A human-readable description of the warning code. 182 }, 183}</pre> 184</div> 185 186<div class="method"> 187 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code> 188 <pre>Retrieves the next page of results. 189 190Args: 191 previous_request: The request for the previous page. (required) 192 previous_response: The response from the request for the previous page. (required) 193 194Returns: 195 A request object that you can call 'execute()' on to request the next 196 page. Returns None if there are no more items in the collection. 197 </pre> 198</div> 199 200<div class="method"> 201 <code class="details" id="close">close()</code> 202 <pre>Close httplib2 connections.</pre> 203</div> 204 205<div class="method"> 206 <code class="details" id="delete">delete(project, region, targetVpnGateway, requestId=None, x__xgafv=None)</code> 207 <pre>Deletes the specified target VPN gateway. 208 209Args: 210 project: string, Project ID for this request. (required) 211 region: string, Name of the region for this request. (required) 212 targetVpnGateway: string, Name of the target VPN gateway to delete. (required) 213 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 214 x__xgafv: string, V1 error format. 215 Allowed values 216 1 - v1 error format 217 2 - v2 error format 218 219Returns: 220 An object of the form: 221 222 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 223 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 224 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 225 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 226 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 227 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 228 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 229 { 230 "code": "A String", # [Output Only] The error type identifier for this error. 231 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 232 "message": "A String", # [Output Only] An optional, human-readable error message. 233 }, 234 ], 235 }, 236 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 237 "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. 238 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 239 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 240 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 241 "name": "A String", # [Output Only] Name of the operation. 242 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 243 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 244 "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. 245 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 246 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 247 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 248 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 249 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 250 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 251 "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. 252 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 253 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 254 { 255 "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. 256 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 257 { 258 "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). 259 "value": "A String", # [Output Only] A warning data value corresponding to the key. 260 }, 261 ], 262 "message": "A String", # [Output Only] A human-readable description of the warning code. 263 }, 264 ], 265 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 266}</pre> 267</div> 268 269<div class="method"> 270 <code class="details" id="get">get(project, region, targetVpnGateway, x__xgafv=None)</code> 271 <pre>Returns the specified target VPN gateway. Gets a list of available target VPN gateways by making a list() request. 272 273Args: 274 project: string, Project ID for this request. (required) 275 region: string, Name of the region for this request. (required) 276 targetVpnGateway: string, Name of the target VPN gateway to return. (required) 277 x__xgafv: string, V1 error format. 278 Allowed values 279 1 - v1 error format 280 2 - v2 error format 281 282Returns: 283 An object of the form: 284 285 { # Represents a Target VPN Gateway resource. The target VPN gateway resource represents a Classic Cloud VPN gateway. For more information, read the the Cloud VPN Overview. 286 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 287 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 288 "forwardingRules": [ # [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated with a VPN gateway. 289 "A String", 290 ], 291 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 292 "kind": "compute#targetVpnGateway", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways. 293 "labelFingerprint": "A String", # A fingerprint for the labels being applied to this TargetVpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a TargetVpnGateway. 294 "labels": { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. 295 "a_key": "A String", 296 }, 297 "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. 298 "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. 299 "region": "A String", # [Output Only] URL of the region where the target VPN gateway resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. 300 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 301 "status": "A String", # [Output Only] The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING. 302 "tunnels": [ # [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using the compute.vpntunnels.insert method and associated with a VPN gateway. 303 "A String", 304 ], 305}</pre> 306</div> 307 308<div class="method"> 309 <code class="details" id="insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</code> 310 <pre>Creates a target VPN gateway in the specified project and region using the data included in the request. 311 312Args: 313 project: string, Project ID for this request. (required) 314 region: string, Name of the region for this request. (required) 315 body: object, The request body. 316 The object takes the form of: 317 318{ # Represents a Target VPN Gateway resource. The target VPN gateway resource represents a Classic Cloud VPN gateway. For more information, read the the Cloud VPN Overview. 319 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 320 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 321 "forwardingRules": [ # [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated with a VPN gateway. 322 "A String", 323 ], 324 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 325 "kind": "compute#targetVpnGateway", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways. 326 "labelFingerprint": "A String", # A fingerprint for the labels being applied to this TargetVpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a TargetVpnGateway. 327 "labels": { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. 328 "a_key": "A String", 329 }, 330 "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. 331 "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. 332 "region": "A String", # [Output Only] URL of the region where the target VPN gateway resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. 333 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 334 "status": "A String", # [Output Only] The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING. 335 "tunnels": [ # [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using the compute.vpntunnels.insert method and associated with a VPN gateway. 336 "A String", 337 ], 338} 339 340 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 341 x__xgafv: string, V1 error format. 342 Allowed values 343 1 - v1 error format 344 2 - v2 error format 345 346Returns: 347 An object of the form: 348 349 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 350 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 351 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 352 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 353 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 354 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 355 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 356 { 357 "code": "A String", # [Output Only] The error type identifier for this error. 358 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 359 "message": "A String", # [Output Only] An optional, human-readable error message. 360 }, 361 ], 362 }, 363 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 364 "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. 365 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 366 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 367 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 368 "name": "A String", # [Output Only] Name of the operation. 369 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 370 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 371 "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. 372 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 373 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 374 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 375 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 376 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 377 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 378 "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. 379 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 380 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 381 { 382 "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. 383 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 384 { 385 "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). 386 "value": "A String", # [Output Only] A warning data value corresponding to the key. 387 }, 388 ], 389 "message": "A String", # [Output Only] A human-readable description of the warning code. 390 }, 391 ], 392 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 393}</pre> 394</div> 395 396<div class="method"> 397 <code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 398 <pre>Retrieves a list of target VPN gateways available to the specified project and region. 399 400Args: 401 project: string, Project ID for this request. (required) 402 region: string, Name of the region for this request. (required) 403 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` 404 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`) 405 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. 406 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. 407 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 408 x__xgafv: string, V1 error format. 409 Allowed values 410 1 - v1 error format 411 2 - v2 error format 412 413Returns: 414 An object of the form: 415 416 { # Contains a list of TargetVpnGateway resources. 417 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 418 "items": [ # A list of TargetVpnGateway resources. 419 { # Represents a Target VPN Gateway resource. The target VPN gateway resource represents a Classic Cloud VPN gateway. For more information, read the the Cloud VPN Overview. 420 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 421 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 422 "forwardingRules": [ # [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated with a VPN gateway. 423 "A String", 424 ], 425 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 426 "kind": "compute#targetVpnGateway", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways. 427 "labelFingerprint": "A String", # A fingerprint for the labels being applied to this TargetVpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a TargetVpnGateway. 428 "labels": { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. 429 "a_key": "A String", 430 }, 431 "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. 432 "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. 433 "region": "A String", # [Output Only] URL of the region where the target VPN gateway resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. 434 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 435 "status": "A String", # [Output Only] The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING. 436 "tunnels": [ # [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using the compute.vpntunnels.insert method and associated with a VPN gateway. 437 "A String", 438 ], 439 }, 440 ], 441 "kind": "compute#targetVpnGatewayList", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways. 442 "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. 443 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 444 "warning": { # [Output Only] Informational warning message. 445 "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. 446 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 447 { 448 "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). 449 "value": "A String", # [Output Only] A warning data value corresponding to the key. 450 }, 451 ], 452 "message": "A String", # [Output Only] A human-readable description of the warning code. 453 }, 454}</pre> 455</div> 456 457<div class="method"> 458 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 459 <pre>Retrieves the next page of results. 460 461Args: 462 previous_request: The request for the previous page. (required) 463 previous_response: The response from the request for the previous page. (required) 464 465Returns: 466 A request object that you can call 'execute()' on to request the next 467 page. Returns None if there are no more items in the collection. 468 </pre> 469</div> 470 471<div class="method"> 472 <code class="details" id="setLabels">setLabels(project, region, resource, body=None, requestId=None, x__xgafv=None)</code> 473 <pre>Sets the labels on a TargetVpnGateway. To learn more about labels, read the Labeling Resources documentation. 474 475Args: 476 project: string, Project ID for this request. (required) 477 region: string, The region for this request. (required) 478 resource: string, Name or id of the resource for this request. (required) 479 body: object, The request body. 480 The object takes the form of: 481 482{ 483 "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. 484 "labels": { # The labels to set for this resource. 485 "a_key": "A String", 486 }, 487} 488 489 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 490 x__xgafv: string, V1 error format. 491 Allowed values 492 1 - v1 error format 493 2 - v2 error format 494 495Returns: 496 An object of the form: 497 498 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 499 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 500 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 501 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 502 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 503 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 504 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 505 { 506 "code": "A String", # [Output Only] The error type identifier for this error. 507 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 508 "message": "A String", # [Output Only] An optional, human-readable error message. 509 }, 510 ], 511 }, 512 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 513 "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. 514 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 515 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 516 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 517 "name": "A String", # [Output Only] Name of the operation. 518 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 519 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 520 "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. 521 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 522 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 523 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 524 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 525 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 526 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 527 "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. 528 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 529 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 530 { 531 "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. 532 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 533 { 534 "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). 535 "value": "A String", # [Output Only] A warning data value corresponding to the key. 536 }, 537 ], 538 "message": "A String", # [Output Only] A human-readable description of the warning code. 539 }, 540 ], 541 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 542}</pre> 543</div> 544 545<div class="method"> 546 <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</code> 547 <pre>Returns permissions that a caller has on the specified resource. 548 549Args: 550 project: string, Project ID for this request. (required) 551 region: string, The name of the region for this request. (required) 552 resource: string, Name or id of the resource for this request. (required) 553 body: object, The request body. 554 The object takes the form of: 555 556{ 557 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. 558 "A String", 559 ], 560} 561 562 x__xgafv: string, V1 error format. 563 Allowed values 564 1 - v1 error format 565 2 - v2 error format 566 567Returns: 568 An object of the form: 569 570 { 571 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 572 "A String", 573 ], 574}</pre> 575</div> 576 577</body></html>