Connectors API (connectors:v1)

2023-07-11

10 new methods

Additions

    Methods
  • connectors.projects.locations.global.updateSettings

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

      Description : Update the global settings of a project.

      Parameter Order : name

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

      Parameters :

        updateMask

          Type : string

          Description : Required. The list of fields to update.

          Format : google-fieldmask

          Location : query

        name

          Type : string

          Required : Yes

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

          Location : path

          Description : Output only. Resource name of the Connection. Format: projects/{project}/locations/global/settings}

      Path : v1/{+name}

      HTTP Method : PATCH

  • connectors.projects.locations.providers.connectors.versions.eventtypes.get

      Parameter Order : name

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/providers/{providersId}/connectors/{connectorsId}/versions/{versionsId}/eventtypes/{eventtypesId}

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

      Path : v1/{+name}

      HTTP Method : GET

      Parameters :

        name

          Required : Yes

          Pattern : ^projects/[^/]+/locations/[^/]+/providers/[^/]+/connectors/[^/]+/versions/[^/]+/eventtypes/[^/]+$

          Type : string

          Location : path

          Description : Required. Resource name of the form: `projects/*/locations/*/providers/*/connectors/*/versions/*/eventtypes/*` Only global location is supported for EventType resource.

      Description : Gets details of a single event type.

  • connectors.projects.locations.providers.connectors.versions.eventtypes.list

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

      Parameters :

        pageSize

          Type : integer

          Description : Page size.

          Format : int32

          Location : query

        parent

          Description : Required. Parent resource of the connectors, of the form: `projects/*/locations/*/providers/*/connectors/*/versions/*` Only global location is supported for EventType resource.

          Type : string

          Location : path

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

          Required : Yes

        pageToken

          Location : query

          Type : string

          Description : Page token.

      Description : Lists Event Types in a given Connector Version.

      HTTP Method : GET

      Path : v1/{+parent}/eventtypes

      Parameter Order : parent

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/providers/{providersId}/connectors/{connectorsId}/versions/{versionsId}/eventtypes

  • connectors.projects.locations.connections.eventSubscriptions.get

      Parameter Order : name

      HTTP Method : GET

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

      Parameters :

        name

          Required : Yes

          Location : path

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

          Description : Required. Resource name of the form: `projects/*/locations/*/connections/*/eventSubscriptions/*`

          Type : string

      Path : v1/{+name}

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/eventSubscriptions/{eventSubscriptionsId}

      Description : Gets details of a single EventSubscription.

  • connectors.projects.locations.connections.eventSubscriptions.patch

      Description : Updates the parameters of a single EventSubscription.

      Path : v1/{+name}

      Parameters :

        updateMask

          Format : google-fieldmask

          Description : Required. The list of fields to update. Fields are specified relative to the Subscription. A field will be overwritten if it is in the mask. You can modify only the fields listed below. To update the EventSubscription details: * `serviceAccount`

          Location : query

          Type : string

        name

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

          Location : path

          Description : Required. Resource name of the EventSubscription. Format: projects/{project}/locations/{location}/connections/{connection}/eventSubscriptions/{event_subscription}

          Type : string

          Required : Yes

      Parameter Order : name

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

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/eventSubscriptions/{eventSubscriptionsId}

      HTTP Method : PATCH

  • connectors.projects.locations.connections.eventSubscriptions.delete

      Parameter Order : name

      HTTP Method : DELETE

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/eventSubscriptions/{eventSubscriptionsId}

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

      Description : Deletes a single EventSubscription.

      Path : v1/{+name}

      Parameters :

        name

          Required : Yes

          Type : string

          Location : path

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

          Description : Required. Resource name of the form: `projects/*/locations/*/connections/*/eventsubscriptions/*`

  • connectors.projects.locations.connections.eventSubscriptions.list

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

      HTTP Method : GET

      Path : v1/{+parent}/eventSubscriptions

      Parameters :

        orderBy

          Description : Order by parameters.

          Location : query

          Type : string

        pageToken

          Description : Page token.

          Location : query

          Type : string

        parent

          Required : Yes

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

          Type : string

          Description : Required. Parent resource of the EventSubscription, of the form: `projects/*/locations/*/connections/*`

          Location : path

        pageSize

          Location : query

          Format : int32

          Type : integer

          Description : Page size.

        filter

          Type : string

          Description : Filter. https://g3doc.corp.google.com/cloud/control2/g3doc/dev/apihosting/list_filtering.md#filtering.

          Location : query

      Parameter Order : parent

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/eventSubscriptions

      Description : List EventSubscriptions in a given project,location and connection.

  • connectors.projects.locations.connections.eventSubscriptions.retry

      Path : v1/{+name}:retry

      Parameter Order : name

      Parameters :

        name

          Type : string

          Required : Yes

          Description : Required. Resource name of the form: `projects/*/locations/*/connections/*/eventSubscriptions/*`

          Location : path

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

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/eventSubscriptions/{eventSubscriptionsId}:retry

      HTTP Method : POST

      Description : RetryEventSubscription retries the registration of Subscription.

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

  • connectors.projects.locations.connections.eventSubscriptions.create

      Description : Creates a new EventSubscription in a given project,location and connection.

      HTTP Method : POST

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/eventSubscriptions

      Parameter Order : parent

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

      Path : v1/{+parent}/eventSubscriptions

      Parameters :

        eventSubscriptionId

          Description : Required. Identifier to assign to the Event Subscription. Must be unique within scope of the parent resource.

          Type : string

          Location : query

        parent

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

          Location : path

          Required : Yes

          Type : string

          Description : Required. Parent resource of the EventSubscription, of the form: `projects/*/locations/*/connections/*`

  • connectors.projects.locations.connections.repairEventing

      HTTP Method : POST

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:repairEventing

      Path : v1/{+name}:repairEventing

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

      Description : RepaiEventing tries to repair eventing related event subscriptions.

      Parameters :

        name

          Description : Required. Resource name of the form: `projects/*/locations/*/connections/*`

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name