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