Serverless VPC Access API (vpcaccess:v1beta1)

2023-02-23

8 new methods | New API

Additions

    Methods
  • vpcaccess.projects.locations.list

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

      Parameters:

        pageToken

          Location: query

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

          Type: string

        name

          Pattern: ^projects/[^/]+$

          Location: path

          Type: string

          Required: Yes

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

        pageSize

          Type: integer

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

          Location: query

          Format: int32

        filter

          Type: string

          Location: query

          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).

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

      Path: v1beta1/{+name}/locations

      Parameter Order: name

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

      HTTP Method: GET

  • vpcaccess.projects.locations.operations.list

      Path: v1beta1/{+name}/operations

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

      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.

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

      Parameter Order: name

      Parameters:

        name

          Location: path

          Required: Yes

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

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

          Type: string

        pageSize

          Description: The standard list page size.

          Format: int32

          Type: integer

          Location: query

        pageToken

          Description: The standard list page token.

          Type: string

          Location: query

        filter

          Description: The standard list filter.

          Location: query

          Type: string

      HTTP Method: GET

  • vpcaccess.projects.locations.operations.get

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

      Path: v1beta1/{+name}

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

      Parameters:

        name

          Description: The name of the operation resource.

          Type: string

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

          Location: path

          Required: Yes

      HTTP Method: GET

      Parameter Order: name

      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.

  • vpcaccess.projects.locations.connectors.list

      Parameters:

        parent

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

          Required: Yes

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

          Type: string

          Location: path

        pageToken

          Type: string

          Location: query

          Description: Continuation token.

        pageSize

          Location: query

          Description: Maximum number of functions to return per call.

          Type: integer

          Format: int32

      HTTP Method: GET

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

      Parameter Order: parent

      Description: Lists Serverless VPC Access connectors.

      Path: v1beta1/{+parent}/connectors

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

  • vpcaccess.projects.locations.connectors.create

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

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

      HTTP Method: POST

      Parameters:

        connectorId

          Type: string

          Location: query

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

        parent

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

          Type: string

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

          Location: path

          Required: Yes

      Parameter Order: parent

      Path: v1beta1/{+parent}/connectors

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

  • vpcaccess.projects.locations.connectors.get

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

      Parameter Order: name

      Path: v1beta1/{+name}

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

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

      Parameters:

        name

          Location: path

          Required: Yes

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

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

          Type: string

      HTTP Method: GET

  • vpcaccess.projects.locations.connectors.patch

      HTTP Method: PATCH

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

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

      Parameters:

        name

          Description: The resource name in the format `projects/*/locations/*/connectors/*`.

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

          Location: path

          Type: string

          Required: Yes

        updateMask

          Location: query

          Type: string

          Format: google-fieldmask

          Description: The fields to update on the entry group. If absent or empty, all modifiable fields are updated.

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

      Parameter Order: name

      Path: v1beta1/{+name}

  • vpcaccess.projects.locations.connectors.delete

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

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

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

      Parameter Order: name

      Path: v1beta1/{+name}

      Parameters:

        name

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

          Required: Yes

          Type: string

          Location: path

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

      HTTP Method: DELETE