# Compute Engine API . vpnGateways

## Instance Methods

Retrieves an aggregated list of VPN gateways.

Retrieves the next page of results.

Deletes the specified VPN gateway.

Returns the specified VPN gateway. Gets a list of available VPN gateways by making a list() request.

Returns the status for the specified VPN gateway.

Creates a VPN gateway in the specified project and region using the data included in the request.

Retrieves a list of VPN gateways available to the specified project and region.

Retrieves the next page of results.

Sets the labels on a VpnGateway. To learn more about labels, read the Labeling Resources documentation.

### Method Details

`aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None)`

    Retrieves an aggregated list of VPN gateways.

    Args:
      project: string, Project ID for this request. (required)
      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 `<`.

    For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.

    You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

    To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```
      includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
      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`)
      orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

    You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

    Currently, only sorting by `name` or `creationTimestamp desc` is supported.
      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.

    Returns:
      An object of the form:

        {
        "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
        "items": { # A list of VpnGateway resources.
          "a_key": { # [Output Only] Name of the scope containing this set of VPN gateways.
            "vpnGateways": [ # [Output Only] A list of VPN gateways contained in this scope.
              { # Represents a HA VPN gateway.
                  #
                  # HA VPN is a high-availability (HA) Cloud VPN solution that lets you securely connect your on-premises network to your Google Cloud Virtual Private Cloud network through an IPsec VPN connection in a single region. For more information about Cloud HA VPN solutions, see  Cloud VPN topologies . (== resource_for {$api_version}.vpnGateways ==)
                "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
                "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
                "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
                "kind": "compute#vpnGateway", # [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.
                "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.
                    #
                    # To see the latest fingerprint, make a get() request to retrieve an VpnGateway.
                "labels": { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
                  "a_key": "A String",
                },
                "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.
                "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
                "region": "A String", # [Output Only] URL of the region where the VPN gateway resides.
                "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
                "vpnInterfaces": [ # A list of interfaces on this VPN gateway.
                  { # A VPN gateway interface.
                    "id": 42, # The numeric ID of this VPN gateway interface.
                    "ipAddress": "A String", # [Output Only] The external IP address for this VPN gateway interface.
                  },
                ],
              },
            ],
            "warning": { # [Output Only] Informational warning which replaces the list of addresses when the list is empty.
              "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.
              "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
                  # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
                {
                  "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).
                  "value": "A String", # [Output Only] A warning data value corresponding to the key.
                },
              ],
              "message": "A String", # [Output Only] A human-readable description of the warning code.
            },
          },
        },
        "kind": "compute#vpnGatewayAggregatedList", # [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.
        "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.
        "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
        "warning": { # [Output Only] Informational warning message.
          "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.
          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
            {
              "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).
              "value": "A String", # [Output Only] A warning data value corresponding to the key.
            },
          ],
          "message": "A String", # [Output Only] A human-readable description of the warning code.
        },
      }

`aggregatedList_next(previous_request, previous_response)`

    Retrieves the next page of results.

    Args:
      previous_request: The request for the previous page. (required)
      previous_response: The response from the request for the previous page. (required)

    Returns:
      A request object that you can call 'execute()' on to request the next
      page. Returns None if there are no more items in the collection.

`delete(project, region, vpnGateway, requestId=None)`

    Deletes the specified VPN gateway.

    Args:
      project: string, Project ID for this request. (required)
      region: string, Name of the region for this request. (required)
      vpnGateway: string, Name of the VPN gateway to delete. (required)
      requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

    Returns:
      An object of the form:

        { # Represents an Operation resource.
          #
          # Google Compute Engine has three Operation resources:
          #
          # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
          #
          # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
          #
          # Operations can be global, regional or zonal.
          # - For global operations, use the `globalOperations` resource.
          # - For regional operations, use the `regionOperations` resource.
          # - For zonal operations, use the `zonalOperations` resource.
          #
          # For more information, read  Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
        "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
        "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
        "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
        "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
        "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
          "errors": [ # [Output Only] The array of errors encountered while processing this operation.
            {
              "code": "A String", # [Output Only] The error type identifier for this error.
              "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
              "message": "A String", # [Output Only] An optional, human-readable error message.
            },
          ],
        },
        "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
        "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.
        "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
        "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
        "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
        "name": "A String", # [Output Only] Name of the operation.
        "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
        "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.
        "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
        "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
        "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
        "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
        "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
        "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
        "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.
        "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
        "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
          {
            "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.
            "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
                # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
              {
                "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).
                "value": "A String", # [Output Only] A warning data value corresponding to the key.
              },
            ],
            "message": "A String", # [Output Only] A human-readable description of the warning code.
          },
        ],
        "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
      }

`get(project, region, vpnGateway)`

    Returns the specified VPN gateway. Gets a list of available VPN gateways by making a list() request.

    Args:
      project: string, Project ID for this request. (required)
      region: string, Name of the region for this request. (required)
      vpnGateway: string, Name of the VPN gateway to return. (required)

    Returns:
      An object of the form:

        { # Represents a HA VPN gateway.
          #
          # HA VPN is a high-availability (HA) Cloud VPN solution that lets you securely connect your on-premises network to your Google Cloud Virtual Private Cloud network through an IPsec VPN connection in a single region. For more information about Cloud HA VPN solutions, see  Cloud VPN topologies . (== resource_for {$api_version}.vpnGateways ==)
        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
        "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
        "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        "kind": "compute#vpnGateway", # [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.
        "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.
            #
            # To see the latest fingerprint, make a get() request to retrieve an VpnGateway.
        "labels": { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
          "a_key": "A String",
        },
        "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.
        "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
        "region": "A String", # [Output Only] URL of the region where the VPN gateway resides.
        "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
        "vpnInterfaces": [ # A list of interfaces on this VPN gateway.
          { # A VPN gateway interface.
            "id": 42, # The numeric ID of this VPN gateway interface.
            "ipAddress": "A String", # [Output Only] The external IP address for this VPN gateway interface.
          },
        ],
      }

`getStatus(project, region, vpnGateway)`

    Returns the status for the specified VPN gateway.

    Args:
      project: string, Project ID for this request. (required)
      region: string, Name of the region for this request. (required)
      vpnGateway: string, Name of the VPN gateway to return. (required)

    Returns:
      An object of the form:

        {
        "result": {
          "vpnConnections": [ # List of VPN connection for this VpnGateway.
            { # 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.
              "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.
              "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.
              "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.
                "state": "A String", # Indicates the high availability requirement state for the VPN connection. Valid values are CONNECTION_REDUNDANCY_MET, CONNECTION_REDUNDANCY_NOT_MET.
                "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.
              },
              "tunnels": [ # List of VPN tunnels that are in this VPN connection.
                { # Contains some information about a VPN tunnel.
                  "localGatewayInterface": 42, # The VPN gateway interface this VPN tunnel is associated with.
                  "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.
                  "tunnelUrl": "A String", # URL reference to the VPN tunnel.
                },
              ],
            },
          ],
        },
      }

`insert(project, region, body=None, requestId=None)`

    Creates a VPN gateway in the specified project and region using the data included in the request.

    Args:
      project: string, Project ID for this request. (required)
      region: string, Name of the region for this request. (required)
      body: object, The request body.
        The object takes the form of:

    { # Represents a HA VPN gateway.
        #
        # HA VPN is a high-availability (HA) Cloud VPN solution that lets you securely connect your on-premises network to your Google Cloud Virtual Private Cloud network through an IPsec VPN connection in a single region. For more information about Cloud HA VPN solutions, see  Cloud VPN topologies . (== resource_for {$api_version}.vpnGateways ==)
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "kind": "compute#vpnGateway", # [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.
      "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.
          #
          # To see the latest fingerprint, make a get() request to retrieve an VpnGateway.
      "labels": { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
        "a_key": "A String",
      },
      "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.
      "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
      "region": "A String", # [Output Only] URL of the region where the VPN gateway resides.
      "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
      "vpnInterfaces": [ # A list of interfaces on this VPN gateway.
        { # A VPN gateway interface.
          "id": 42, # The numeric ID of this VPN gateway interface.
          "ipAddress": "A String", # [Output Only] The external IP address for this VPN gateway interface.
        },
      ],
    }

      requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

    Returns:
      An object of the form:

        { # Represents an Operation resource.
          #
          # Google Compute Engine has three Operation resources:
          #
          # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
          #
          # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
          #
          # Operations can be global, regional or zonal.
          # - For global operations, use the `globalOperations` resource.
          # - For regional operations, use the `regionOperations` resource.
          # - For zonal operations, use the `zonalOperations` resource.
          #
          # For more information, read  Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
        "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
        "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
        "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
        "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
        "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
          "errors": [ # [Output Only] The array of errors encountered while processing this operation.
            {
              "code": "A String", # [Output Only] The error type identifier for this error.
              "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
              "message": "A String", # [Output Only] An optional, human-readable error message.
            },
          ],
        },
        "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
        "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.
        "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
        "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
        "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
        "name": "A String", # [Output Only] Name of the operation.
        "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
        "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.
        "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
        "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
        "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
        "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
        "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
        "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
        "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.
        "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
        "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
          {
            "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.
            "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
                # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
              {
                "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).
                "value": "A String", # [Output Only] A warning data value corresponding to the key.
              },
            ],
            "message": "A String", # [Output Only] A human-readable description of the warning code.
          },
        ],
        "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
      }

`list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None)`

    Retrieves a list of VPN gateways available to the specified project and region.

    Args:
      project: string, Project ID for this request. (required)
      region: string, Name of the region for this request. (required)
      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 `<`.

    For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.

    You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

    To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```
      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`)
      orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

    You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

    Currently, only sorting by `name` or `creationTimestamp desc` is supported.
      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.

    Returns:
      An object of the form:

        { # Contains a list of VpnGateway resources.
        "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
        "items": [ # A list of VpnGateway resources.
          { # Represents a HA VPN gateway.
              #
              # HA VPN is a high-availability (HA) Cloud VPN solution that lets you securely connect your on-premises network to your Google Cloud Virtual Private Cloud network through an IPsec VPN connection in a single region. For more information about Cloud HA VPN solutions, see  Cloud VPN topologies . (== resource_for {$api_version}.vpnGateways ==)
            "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
            "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
            "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
            "kind": "compute#vpnGateway", # [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.
            "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.
                #
                # To see the latest fingerprint, make a get() request to retrieve an VpnGateway.
            "labels": { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
              "a_key": "A String",
            },
            "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.
            "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
            "region": "A String", # [Output Only] URL of the region where the VPN gateway resides.
            "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
            "vpnInterfaces": [ # A list of interfaces on this VPN gateway.
              { # A VPN gateway interface.
                "id": 42, # The numeric ID of this VPN gateway interface.
                "ipAddress": "A String", # [Output Only] The external IP address for this VPN gateway interface.
              },
            ],
          },
        ],
        "kind": "compute#vpnGatewayList", # [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.
        "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.
        "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
        "warning": { # [Output Only] Informational warning message.
          "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.
          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
            {
              "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).
              "value": "A String", # [Output Only] A warning data value corresponding to the key.
            },
          ],
          "message": "A String", # [Output Only] A human-readable description of the warning code.
        },
      }

`list_next(previous_request, previous_response)`

    Retrieves the next page of results.

    Args:
      previous_request: The request for the previous page. (required)
      previous_response: The response from the request for the previous page. (required)

    Returns:
      A request object that you can call 'execute()' on to request the next
      page. Returns None if there are no more items in the collection.

`setLabels(project, region, resource, body=None, requestId=None)`

    Sets the labels on a VpnGateway. To learn more about labels, read the Labeling Resources documentation.

    Args:
      project: string, Project ID for this request. (required)
      region: string, The region for this request. (required)
      resource: string, Name or id of the resource for this request. (required)
      body: object, The request body.
        The object takes the form of:

    {
        "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.
        "labels": { # The labels to set for this resource.
          "a_key": "A String",
        },
      }

      requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

    Returns:
      An object of the form:

        { # Represents an Operation resource.
          #
          # Google Compute Engine has three Operation resources:
          #
          # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
          #
          # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
          #
          # Operations can be global, regional or zonal.
          # - For global operations, use the `globalOperations` resource.
          # - For regional operations, use the `regionOperations` resource.
          # - For zonal operations, use the `zonalOperations` resource.
          #
          # For more information, read  Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
        "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
        "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
        "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
        "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
        "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
          "errors": [ # [Output Only] The array of errors encountered while processing this operation.
            {
              "code": "A String", # [Output Only] The error type identifier for this error.
              "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
              "message": "A String", # [Output Only] An optional, human-readable error message.
            },
          ],
        },
        "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
        "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.
        "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
        "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
        "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
        "name": "A String", # [Output Only] Name of the operation.
        "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
        "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.
        "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
        "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
        "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
        "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
        "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
        "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
        "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.
        "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
        "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
          {
            "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.
            "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
                # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
              {
                "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).
                "value": "A String", # [Output Only] A warning data value corresponding to the key.
              },
            ],
            "message": "A String", # [Output Only] A human-readable description of the warning code.
          },
        ],
        "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
      }