Connectors API (connectors:v1)

2023-07-07

10 new methods

Additions

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

      Parameters:

        parent

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

          Location: path

          Required: Yes

          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

        pageSize

          Description: Page size.

          Format: int32

          Location: query

          Type: integer

        pageToken

          Description: Page token.

          Location: query

          Type: string

      HTTP Method: GET

      Path: v1/{+parent}/eventtypes

      Description: Lists Event Types in a given Connector Version.

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

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

      Parameter Order: parent

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

      HTTP Method: GET

      Parameters:

        name

          Type: string

          Location: path

          Required: Yes

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

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

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

      Path: v1/{+name}

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

      Description: Gets details of a single event type.

      Parameter Order: name

  • connectors.projects.locations.connections.repairEventing

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

      Parameters:

        name

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

          Type: string

          Required: Yes

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

          Location: path

      Parameter Order: name

      Path: v1/{+name}:repairEventing

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

      Description: RepaiEventing tries to repair eventing related event subscriptions.

      HTTP Method: POST

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

      Parameters:

        updateMask

          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`

          Type: string

          Format: google-fieldmask

          Location: query

        name

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

          Location: path

          Type: string

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

          Required: Yes

      HTTP Method: PATCH

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

      Path: v1/{+name}

      Description: Updates the parameters of a single EventSubscription.

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

      Parameter Order: name

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

      HTTP Method: DELETE

      Path: v1/{+name}

      Parameter Order: name

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

      Description: Deletes a single EventSubscription.

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

      Parameters:

        name

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

          Required: Yes

          Type: string

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

          Location: path

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

      HTTP Method: POST

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

      Parameter Order: parent

      Parameters:

        eventSubscriptionId

          Type: string

          Location: query

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

        parent

          Required: Yes

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

          Type: string

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

          Location: path

      Path: v1/{+parent}/eventSubscriptions

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

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

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

      Description: RetryEventSubscription retries the registration of Subscription.

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

      Parameters:

        name

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

          Type: string

          Location: path

          Required: Yes

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

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

      Path: v1/{+name}:retry

      Parameter Order: name

      HTTP Method: POST

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

      Parameter Order: name

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

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

      Parameters:

        name

          Location: path

          Required: Yes

          Type: string

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

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

      HTTP Method: GET

      Description: Gets details of a single EventSubscription.

      Path: v1/{+name}

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

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

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

      Parameters:

        pageSize

          Format: int32

          Type: integer

          Description: Page size.

          Location: query

        pageToken

          Type: string

          Description: Page token.

          Location: query

        parent

          Type: string

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

          Required: Yes

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

          Location: path

        filter

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

          Location: query

          Type: string

        orderBy

          Type: string

          Location: query

          Description: Order by parameters.

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

      HTTP Method: GET

      Parameter Order: parent

      Path: v1/{+parent}/eventSubscriptions

  • connectors.projects.locations.global.updateSettings

      HTTP Method: PATCH

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

      Parameters:

        name

          Required: Yes

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

          Type: string

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

          Location: path

        updateMask

          Format: google-fieldmask

          Location: query

          Description: Required. The list of fields to update.

          Type: string

      Description: Update the global settings of a project.

      Path: v1/{+name}

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

      Parameter Order: name