Connectors API (connectors:v2)

2022-08-13

11 removed methods | Removed API

Deletions

    Methods
  • connectors.projects.locations.connections.executeSqlQuery

      Description: Executes a SQL statement specified in the body of the request. An example of this SQL statement in the case of Salesforce connector would be 'select * from Account a, Order o where a.Id = o.AccountId'.

      Parameters:

        connection

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

          Location: path

          Required: Yes

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

          Type: string

      Parameter Order: connection

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

      HTTP Method: POST

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

      Path: v2/{+connection}:executeSqlQuery

  • connectors.projects.locations.connections.actions.execute

      HTTP Method: POST

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

      Flat Path: v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/actions/{actionsId}:execute

      Parameters:

        name

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

          Location: path

          Type: string

          Description: Required. Resource name of the Action. Format: projects/{project}/locations/{location}/connections/{connection}/actions/{action}

          Required: Yes

      Parameter Order: name

      Path: v2/{+name}:execute

      Description: Executes an action with the name specified in the request. The input parameters for executing the action are passed through the body of the ExecuteAction request.

  • connectors.projects.locations.connections.actions.list

      HTTP Method: GET

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

      Path: v2/{+parent}/actions

      Parameters:

        parent

          Location: path

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

          Description: Required. Parent resource name of the Action. Format: projects/{project}/locations/{location}/connections/{connection}

          Required: Yes

          Type: string

        pageSize

          Description: Number of Actions to return. Defaults to 25.

          Location: query

          Type: integer

          Format: int32

        pageToken

          Type: string

          Description: Page token, return from a previous ListActions call, that can be used retrieve the next page of content. If unspecified, the request returns the first page of actions.

          Location: query

      Description: Gets the schema of all the actions supported by the connector.

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

      Parameter Order: parent

  • connectors.projects.locations.connections.entityTypes.entities.deleteEntitiesWithConditions

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

      Parameter Order: entityType

      Path: v2/{+entityType}/entities:deleteEntitiesWithConditions

      Parameters:

        entityType

          Description: Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}

          Type: string

          Required: Yes

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

          Location: path

        conditions

          Location: query

          Type: string

          Description: Required. Conditions to be used when deleting entities. From a proto standpoint, There are no restrictions on what can be passed using this field. The connector documentation should have information about what format of filters/conditions are supported. Note: If this conditions field is left empty, an exception is thrown. We don't want to consider 'empty conditions' to be a match-all case. Connector developers can determine and document what a match-all case constraint would be.

      HTTP Method: POST

      Description: Deletes entities based on conditions specified in the request and not on entity id.

      Flat Path: v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/entityTypes/{entityTypesId}/entities:deleteEntitiesWithConditions

  • connectors.projects.locations.connections.entityTypes.entities.delete

      HTTP Method: DELETE

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

      Path: v2/{+name}

      Flat Path: v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/entityTypes/{entityTypesId}/entities/{entitiesId}

      Parameters:

        name

          Description: Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id}

          Type: string

          Required: Yes

          Location: path

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

      Parameter Order: name

      Description: Deletes an existing entity row matching the entity type and entity id specified in the request.

  • connectors.projects.locations.connections.entityTypes.entities.get

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

      Parameter Order: name

      Flat Path: v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/entityTypes/{entityTypesId}/entities/{entitiesId}

      Description: Gets a single entity row matching the entity type and entity id specified in the request.

      Path: v2/{+name}

      HTTP Method: GET

      Parameters:

        name

          Type: string

          Description: Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id}

          Location: path

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

          Required: Yes

  • connectors.projects.locations.connections.entityTypes.entities.updateEntitiesWithConditions

      Description: Updates entities based on conditions specified in the request and not on entity id.

      Parameter Order: entityType

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

      HTTP Method: POST

      Parameters:

        entityType

          Type: string

          Location: path

          Description: Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}

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

          Required: Yes

        conditions

          Type: string

          Description: Required. Conditions to be used when updating entities. From a proto standpoint, There are no restrictions on what can be passed using this field. The connector documentation should have information about what format of filters/conditions are supported. Note: If this conditions field is left empty, an exception is thrown. We don't want to consider 'empty conditions' to be a match-all case. Connector developers can determine and document what a match-all case constraint would be.

          Location: query

      Flat Path: v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/entityTypes/{entityTypesId}/entities:updateEntitiesWithConditions

      Path: v2/{+entityType}/entities:updateEntitiesWithConditions

  • connectors.projects.locations.connections.entityTypes.entities.patch

      HTTP Method: PATCH

      Description: Updates an existing entity row matching the entity type and entity id specified in the request. The fields in the entity row that need to be modified are contained in the body of the request. All unspecified fields are left unchanged. The response message contains a `Entity` message object returned as a response by the external system.

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

      Parameter Order: name

      Flat Path: v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/entityTypes/{entityTypesId}/entities/{entitiesId}

      Path: v2/{+name}

      Parameters:

        name

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

          Required: Yes

          Description: Output only. Resource name of the Entity. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id}

          Location: path

          Type: string

  • connectors.projects.locations.connections.entityTypes.entities.list

      Flat Path: v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/entityTypes/{entityTypesId}/entities

      Description: Lists entity rows of a particular entity type contained in the request. Note: 1. Currently, only max of one 'sort_by' column is supported. 2. If no 'sort_by' column is provided, the primary key of the table is used. If zero or more than one primary key is available, we default to the unpaginated list entities logic which only returns the first page. 3. The values of the 'sort_by' columns must uniquely identify an entity row, otherwise undefined behaviors may be observed during pagination. 4. Since transactions are not supported, any updates, inserts or deletes during pagination can lead to stale data being returned or other unexpected behaviors.

      Parameters:

        pageSize

          Format: int32

          Type: integer

          Description: Number of entity rows to return. Defaults page size = 25. Max page size = 200.

          Location: query

        parent

          Type: string

          Required: Yes

          Description: Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}

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

          Location: path

        pageToken

          Location: query

          Type: string

          Description: Page token value if available from a previous request.

        sortBy

          Type: string

          Location: query

          Repeated: Yes

          Description: List of 'sort_by' columns to use when returning the results.

        conditions

          Location: query

          Description: Conditions to be used when listing entities. From a proto standpoint, There are no restrictions on what can be passed using this field. The connector documentation should have information about what format of filters/conditions are supported.

          Type: string

      Path: v2/{+parent}/entities

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

      Parameter Order: parent

      HTTP Method: GET

  • connectors.projects.locations.connections.entityTypes.entities.create

      Path: v2/{+parent}/entities

      Parameter Order: parent

      Parameters:

        parent

          Type: string

          Required: Yes

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

          Description: Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}

          Location: path

      Flat Path: v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/entityTypes/{entityTypesId}/entities

      HTTP Method: POST

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

      Description: Creates a new entity row of the specified entity type in the external system. The field values for creating the row are contained in the body of the request. The response message contains a `Entity` message object returned as a response by the external system.

  • connectors.projects.locations.connections.entityTypes.list

      Path: v2/{+parent}/entityTypes

      Parameter Order: parent

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

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

      Description: Lists metadata related to all entity types present in the external system.

      HTTP Method: GET

      Parameters:

        pageToken

          Location: query

          Type: string

          Description: Page token, return from a previous ListEntityTypes call, that can be used retrieve the next page of content. If unspecified, the request returns the first page of entity types.

        parent

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

          Location: path

          Type: string

          Description: Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}

          Required: Yes

        pageSize

          Type: integer

          Format: int32

          Description: Number of entity types to return. Defaults to 25.

          Location: query