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.vpnGateways.html">vpnGateways</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p> 79<p class="firstline">Retrieves an aggregated list of VPN 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, vpnGateway, requestId=None)</a></code></p> 85<p class="firstline">Deletes the specified VPN gateway.</p> 86<p class="toc_element"> 87 <code><a href="#get">get(project, region, vpnGateway)</a></code></p> 88<p class="firstline">Returns the specified VPN gateway. Gets a list of available VPN gateways by making a list() request.</p> 89<p class="toc_element"> 90 <code><a href="#getStatus">getStatus(project, region, vpnGateway)</a></code></p> 91<p class="firstline">Returns the status for the specified VPN gateway.</p> 92<p class="toc_element"> 93 <code><a href="#insert">insert(project, region, body, requestId=None)</a></code></p> 94<p class="firstline">Creates a 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, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p> 97<p class="firstline">Retrieves a list of 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, requestId=None)</a></code></p> 103<p class="firstline">Sets the labels on a VpnGateway. To learn more about labels, read the Labeling Resources documentation.</p> 104<h3>Method Details</h3> 105<div class="method"> 106 <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 107 <pre>Retrieves an aggregated list of VPN 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#vpnGatewayAggregatedList", # [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways. 132 "items": { # A list of VpnGateway resources. 133 "a_key": { # [Output Only] Name of the scope containing this set of VPN gateways. 134 "warning": { # [Output Only] Informational warning which replaces the list of addresses when the list is empty. 135 "message": "A String", # [Output Only] A human-readable description of the warning code. 136 "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. 137 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 138 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 139 { 140 "value": "A String", # [Output Only] A warning data value corresponding to the key. 141 "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). 142 }, 143 ], 144 }, 145 "vpnGateways": [ # [Output Only] A list of VPN gateways contained in this scope. 146 { # Represents a VPN gateway resource. 147 "kind": "compute#vpnGateway", # [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways. 148 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 149 "labelFingerprint": "A String", # A fingerprint for the labels being applied to this VpnGateway, 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. 150 # 151 # To see the latest fingerprint, make a get() request to retrieve an VpnGateway. 152 "labels": { # Labels to apply to this VpnGateway resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty. 153 "a_key": "A String", 154 }, 155 "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. 156 "vpnInterfaces": [ # [Output Only] A list of interfaces on this VPN gateway. 157 { # A VPN gateway interface. 158 "ipAddress": "A String", # The external IP address for this VPN gateway interface. 159 "id": 42, # The numeric ID of this VPN gateway interface. 160 }, 161 ], 162 "region": "A String", # [Output Only] URL of the region where the VPN gateway resides. 163 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 164 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 165 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 166 "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. 167 }, 168 ], 169 }, 170 }, 171 "warning": { # [Output Only] Informational warning message. 172 "message": "A String", # [Output Only] A human-readable description of the warning code. 173 "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. 174 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 175 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 176 { 177 "value": "A String", # [Output Only] A warning data value corresponding to the key. 178 "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). 179 }, 180 ], 181 }, 182 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 183 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 184 }</pre> 185</div> 186 187<div class="method"> 188 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code> 189 <pre>Retrieves the next page of results. 190 191Args: 192 previous_request: The request for the previous page. (required) 193 previous_response: The response from the request for the previous page. (required) 194 195Returns: 196 A request object that you can call 'execute()' on to request the next 197 page. Returns None if there are no more items in the collection. 198 </pre> 199</div> 200 201<div class="method"> 202 <code class="details" id="delete">delete(project, region, vpnGateway, requestId=None)</code> 203 <pre>Deletes the specified VPN gateway. 204 205Args: 206 project: string, Project ID for this request. (required) 207 region: string, Name of the region for this request. (required) 208 vpnGateway: string, Name of the VPN gateway to delete. (required) 209 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. 210 211For 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. 212 213The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 214 215Returns: 216 An object of the form: 217 218 { # Represents an Operation resource. 219 # 220 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 221 # 222 # Operations can be global, regional or zonal. 223 # - For global operations, use the globalOperations resource. 224 # - For regional operations, use the regionOperations resource. 225 # - For zonal operations, use the zonalOperations resource. 226 # 227 # 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 ==) 228 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 229 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 230 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 231 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 232 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 233 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 234 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 235 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 236 "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. 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 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 239 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 240 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 241 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 242 { 243 "message": "A String", # [Output Only] A human-readable description of the warning code. 244 "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. 245 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 246 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 247 { 248 "value": "A String", # [Output Only] A warning data value corresponding to the key. 249 "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). 250 }, 251 ], 252 }, 253 ], 254 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 255 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 256 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 257 "name": "A String", # [Output Only] Name of the resource. 258 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 259 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 260 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 261 { 262 "message": "A String", # [Output Only] An optional, human-readable error message. 263 "code": "A String", # [Output Only] The error type identifier for this error. 264 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 265 }, 266 ], 267 }, 268 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 269 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 270 "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. 271 }</pre> 272</div> 273 274<div class="method"> 275 <code class="details" id="get">get(project, region, vpnGateway)</code> 276 <pre>Returns the specified VPN gateway. Gets a list of available VPN gateways by making a list() request. 277 278Args: 279 project: string, Project ID for this request. (required) 280 region: string, Name of the region for this request. (required) 281 vpnGateway: string, Name of the VPN gateway to return. (required) 282 283Returns: 284 An object of the form: 285 286 { # Represents a VPN gateway resource. 287 "kind": "compute#vpnGateway", # [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways. 288 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 289 "labelFingerprint": "A String", # A fingerprint for the labels being applied to this VpnGateway, 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. 290 # 291 # To see the latest fingerprint, make a get() request to retrieve an VpnGateway. 292 "labels": { # Labels to apply to this VpnGateway resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty. 293 "a_key": "A String", 294 }, 295 "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. 296 "vpnInterfaces": [ # [Output Only] A list of interfaces on this VPN gateway. 297 { # A VPN gateway interface. 298 "ipAddress": "A String", # The external IP address for this VPN gateway interface. 299 "id": 42, # The numeric ID of this VPN gateway interface. 300 }, 301 ], 302 "region": "A String", # [Output Only] URL of the region where the VPN gateway resides. 303 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 304 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 305 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 306 "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. 307 }</pre> 308</div> 309 310<div class="method"> 311 <code class="details" id="getStatus">getStatus(project, region, vpnGateway)</code> 312 <pre>Returns the status for the specified VPN gateway. 313 314Args: 315 project: string, Project ID for this request. (required) 316 region: string, Name of the region for this request. (required) 317 vpnGateway: string, Name of the VPN gateway to return. (required) 318 319Returns: 320 An object of the form: 321 322 { 323 "result": { 324 "vpnConnections": [ # List of VPN connection for this VpnGateway. 325 { # A VPN connection contains all VPN tunnels connected from this VpnGateway to the same peer gateway. The peer gateway could either be a external VPN gateway or GCP VPN gateway. 326 "peerExternalGateway": "A String", # URL reference to the peer external VPN gateways to which the VPN tunnels in this VPN connection are connected. This field is mutually exclusive with peer_gcp_gateway. 327 "peerGcpGateway": "A String", # URL reference to the peer side VPN gateways to which the VPN tunnels in this VPN connection are connected. This field is mutually exclusive with peer_gcp_gateway. 328 "tunnels": [ # List of VPN tunnels that are in this VPN connection. 329 { # Contains some information about a VPN tunnel. 330 "tunnelUrl": "A String", # URL reference to the VPN tunnel. 331 "localGatewayInterface": 42, # The VPN gateway interface this VPN tunnel is associated with. 332 "peerGatewayInterface": 42, # The peer gateway interface this VPN tunnel is connected to, the peer gateway could either be an external VPN gateway or GCP VPN gateway. 333 }, 334 ], 335 "state": { # Describes the high availability requirement state for the VPN connection between this Cloud VPN gateway and a peer gateway. # HighAvailabilityRequirementState for the VPN connection. 336 "state": "A String", # Indicates the high availability requirement state for the VPN connection. Valid values are CONNECTION_REDUNDANCY_MET, CONNECTION_REDUNDANCY_NOT_MET. 337 "unsatisfiedReason": "A String", # Indicates the reason why the VPN connection does not meet the high availability redundancy criteria/requirement. Valid values is INCOMPLETE_TUNNELS_COVERAGE. 338 }, 339 }, 340 ], 341 }, 342 }</pre> 343</div> 344 345<div class="method"> 346 <code class="details" id="insert">insert(project, region, body, requestId=None)</code> 347 <pre>Creates a VPN gateway in the specified project and region using the data included in the request. 348 349Args: 350 project: string, Project ID for this request. (required) 351 region: string, Name of the region for this request. (required) 352 body: object, The request body. (required) 353 The object takes the form of: 354 355{ # Represents a VPN gateway resource. 356 "kind": "compute#vpnGateway", # [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways. 357 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 358 "labelFingerprint": "A String", # A fingerprint for the labels being applied to this VpnGateway, 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. 359 # 360 # To see the latest fingerprint, make a get() request to retrieve an VpnGateway. 361 "labels": { # Labels to apply to this VpnGateway resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty. 362 "a_key": "A String", 363 }, 364 "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. 365 "vpnInterfaces": [ # [Output Only] A list of interfaces on this VPN gateway. 366 { # A VPN gateway interface. 367 "ipAddress": "A String", # The external IP address for this VPN gateway interface. 368 "id": 42, # The numeric ID of this VPN gateway interface. 369 }, 370 ], 371 "region": "A String", # [Output Only] URL of the region where the VPN gateway resides. 372 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 373 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 374 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 375 "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. 376 } 377 378 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. 379 380For 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. 381 382The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 383 384Returns: 385 An object of the form: 386 387 { # Represents an Operation resource. 388 # 389 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 390 # 391 # Operations can be global, regional or zonal. 392 # - For global operations, use the globalOperations resource. 393 # - For regional operations, use the regionOperations resource. 394 # - For zonal operations, use the zonalOperations resource. 395 # 396 # 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 ==) 397 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 398 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 399 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 400 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 401 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 402 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 403 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 404 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 405 "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. 406 "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. 407 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 408 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 409 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 410 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 411 { 412 "message": "A String", # [Output Only] A human-readable description of the warning code. 413 "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. 414 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 415 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 416 { 417 "value": "A String", # [Output Only] A warning data value corresponding to the key. 418 "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). 419 }, 420 ], 421 }, 422 ], 423 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 424 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 425 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 426 "name": "A String", # [Output Only] Name of the resource. 427 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 428 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 429 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 430 { 431 "message": "A String", # [Output Only] An optional, human-readable error message. 432 "code": "A String", # [Output Only] The error type identifier for this error. 433 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 434 }, 435 ], 436 }, 437 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 438 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 439 "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. 440 }</pre> 441</div> 442 443<div class="method"> 444 <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 445 <pre>Retrieves a list of VPN gateways available to the specified project and region. 446 447Args: 448 project: string, Project ID for this request. (required) 449 region: string, Name of the region for this request. (required) 450 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 451 452You 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. 453 454Currently, only sorting by name or creationTimestamp desc is supported. 455 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) 456 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. 457 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 <. 458 459For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. 460 461You 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. 462 463To 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). 464 465Returns: 466 An object of the form: 467 468 { # Contains a list of VpnGateway resources. 469 "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. 470 "kind": "compute#vpnGatewayList", # [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways. 471 "items": [ # A list of VpnGateway resources. 472 { # Represents a VPN gateway resource. 473 "kind": "compute#vpnGateway", # [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways. 474 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 475 "labelFingerprint": "A String", # A fingerprint for the labels being applied to this VpnGateway, 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. 476 # 477 # To see the latest fingerprint, make a get() request to retrieve an VpnGateway. 478 "labels": { # Labels to apply to this VpnGateway resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty. 479 "a_key": "A String", 480 }, 481 "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. 482 "vpnInterfaces": [ # [Output Only] A list of interfaces on this VPN gateway. 483 { # A VPN gateway interface. 484 "ipAddress": "A String", # The external IP address for this VPN gateway interface. 485 "id": 42, # The numeric ID of this VPN gateway interface. 486 }, 487 ], 488 "region": "A String", # [Output Only] URL of the region where the VPN gateway resides. 489 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 490 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 491 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 492 "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. 493 }, 494 ], 495 "warning": { # [Output Only] Informational warning message. 496 "message": "A String", # [Output Only] A human-readable description of the warning code. 497 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 498 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 499 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 500 { 501 "value": "A String", # [Output Only] A warning data value corresponding to the key. 502 "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). 503 }, 504 ], 505 }, 506 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 507 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 508 }</pre> 509</div> 510 511<div class="method"> 512 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 513 <pre>Retrieves the next page of results. 514 515Args: 516 previous_request: The request for the previous page. (required) 517 previous_response: The response from the request for the previous page. (required) 518 519Returns: 520 A request object that you can call 'execute()' on to request the next 521 page. Returns None if there are no more items in the collection. 522 </pre> 523</div> 524 525<div class="method"> 526 <code class="details" id="setLabels">setLabels(project, region, resource, body, requestId=None)</code> 527 <pre>Sets the labels on a VpnGateway. To learn more about labels, read the Labeling Resources documentation. 528 529Args: 530 project: string, Project ID for this request. (required) 531 region: string, The region for this request. (required) 532 resource: string, Name or id of the resource for this request. (required) 533 body: object, The request body. (required) 534 The object takes the form of: 535 536{ 537 "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. 538 "labels": { # The labels to set for this resource. 539 "a_key": "A String", 540 }, 541 } 542 543 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. 544 545For 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. 546 547The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 548 549Returns: 550 An object of the form: 551 552 { # Represents an Operation resource. 553 # 554 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 555 # 556 # Operations can be global, regional or zonal. 557 # - For global operations, use the globalOperations resource. 558 # - For regional operations, use the regionOperations resource. 559 # - For zonal operations, use the zonalOperations resource. 560 # 561 # 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 ==) 562 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 563 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 564 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 565 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 566 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 567 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 568 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 569 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 570 "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. 571 "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. 572 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 573 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 574 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 575 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 576 { 577 "message": "A String", # [Output Only] A human-readable description of the warning code. 578 "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. 579 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 580 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 581 { 582 "value": "A String", # [Output Only] A warning data value corresponding to the key. 583 "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). 584 }, 585 ], 586 }, 587 ], 588 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 589 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 590 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 591 "name": "A String", # [Output Only] Name of the resource. 592 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 593 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 594 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 595 { 596 "message": "A String", # [Output Only] An optional, human-readable error message. 597 "code": "A String", # [Output Only] The error type identifier for this error. 598 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 599 }, 600 ], 601 }, 602 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 603 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 604 "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. 605 }</pre> 606</div> 607 608</body></html>