Connectors API (connectors:v2)

2023-12-10

4 new methods

Additions

    Methods
  • connectors.projects.locations.connections.checkStatus

      Path : v2/{+name}:checkStatus

      Flat Path : v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:checkStatus

      HTTP Method : GET

      Parameters :

        name

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Reports the status of the connection. Note that when the connection is in a state that is not ACTIVE, the implementation of this RPC method must return a Status with the corresponding State instead of returning a gRPC status code that is not "OK", which indicates that ConnectionStatus itself, not the connection, failed.

  • connectors.projects.locations.connections.checkReadiness

      Path : v2/{+name}:checkReadiness

      Flat Path : v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:checkReadiness

      HTTP Method : GET

      Parameters :

        name

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Reports readiness status of the connector. Similar logic to GetStatus but modified for kubernetes health check to understand.

  • connectors.projects.locations.connections.exchangeAuthCode

      Path : v2/{+name}:exchangeAuthCode

      Flat Path : v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:exchangeAuthCode

      HTTP Method : POST

      Parameters :

        name

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : ExchangeAuthCode exchanges the OAuth authorization code (and other necessary data) for an access token (and associated credentials).

  • connectors.projects.locations.connections.refreshAccessToken

      Path : v2/{+name}:refreshAccessToken

      Flat Path : v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:refreshAccessToken

      HTTP Method : POST

      Parameters :

        name

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : RefreshAccessToken exchanges the OAuth refresh token (and other necessary data) for a new access token (and new associated credentials).