Serverless VPC Access API (vpcaccess:v1)

2023-02-23

7 new methods | New API

Additions

    Methods
  • vpcaccess.projects.locations.list

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Lists information about the supported locations for this service.

      HTTP Method: GET

      Flat Path: v1/projects/{projectsId}/locations

      Parameters:

        pageToken

          Description: A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.

          Location: query

          Type: string

        pageSize

          Type: integer

          Description: The maximum number of results to return. If not set, the service selects a default.

          Location: query

          Format: int32

        name

          Description: The resource that owns the locations collection, if applicable.

          Location: path

          Pattern: ^projects/[^/]+$

          Type: string

          Required: Yes

        filter

          Location: query

          Type: string

          Description: A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).

      Path: v1/{+name}/locations

  • vpcaccess.projects.locations.operations.get

      Description: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameters:

        name

          Description: The name of the operation resource.

          Type: string

          Location: path

          Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$

          Required: Yes

      Parameter Order: name

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}

      HTTP Method: GET

      Path: v1/{+name}

  • vpcaccess.projects.locations.operations.list

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations

      Scopes: https://www.googleapis.com/auth/cloud-platform

      HTTP Method: GET

      Parameters:

        pageToken

          Location: query

          Description: The standard list page token.

          Type: string

        pageSize

          Description: The standard list page size.

          Type: integer

          Location: query

          Format: int32

        filter

          Location: query

          Type: string

          Description: The standard list filter.

        name

          Type: string

          Location: path

          Required: Yes

          Description: The name of the operation's parent resource.

          Pattern: ^projects/[^/]+/locations/[^/]+$

      Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

      Parameter Order: name

      Path: v1/{+name}/operations

  • vpcaccess.projects.locations.connectors.delete

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Path: v1/{+name}

      Description: Deletes a Serverless VPC Access connector. Returns NOT_FOUND if the resource does not exist.

      Parameter Order: name

      Parameters:

        name

          Location: path

          Pattern: ^projects/[^/]+/locations/[^/]+/connectors/[^/]+$

          Description: Required. Name of a Serverless VPC Access connector to delete.

          Type: string

          Required: Yes

      HTTP Method: DELETE

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/connectors/{connectorsId}

  • vpcaccess.projects.locations.connectors.create

      Description: Creates a Serverless VPC Access connector, returns an operation.

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/connectors

      Parameters:

        parent

          Description: Required. The project and location in which the configuration should be created, specified in the format `projects/*/locations/*`.

          Location: path

          Required: Yes

          Pattern: ^projects/[^/]+/locations/[^/]+$

          Type: string

        connectorId

          Type: string

          Location: query

          Description: Required. The ID to use for this connector.

      Parameter Order: parent

      Path: v1/{+parent}/connectors

      HTTP Method: POST

  • vpcaccess.projects.locations.connectors.get

      HTTP Method: GET

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Gets a Serverless VPC Access connector. Returns NOT_FOUND if the resource does not exist.

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/connectors/{connectorsId}

      Parameter Order: name

      Path: v1/{+name}

      Parameters:

        name

          Required: Yes

          Location: path

          Type: string

          Pattern: ^projects/[^/]+/locations/[^/]+/connectors/[^/]+$

          Description: Required. Name of a Serverless VPC Access connector to get.

  • vpcaccess.projects.locations.connectors.list

      Parameter Order: parent

      Description: Lists Serverless VPC Access connectors.

      Parameters:

        parent

          Type: string

          Description: Required. The project and location from which the routes should be listed.

          Pattern: ^projects/[^/]+/locations/[^/]+$

          Required: Yes

          Location: path

        pageToken

          Description: Continuation token.

          Type: string

          Location: query

        pageSize

          Format: int32

          Description: Maximum number of functions to return per call.

          Type: integer

          Location: query

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/connectors

      HTTP Method: GET

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Path: v1/{+parent}/connectors