2022-08-14
▼ ▲ connectors.projects.locations.connections.executeSqlQuery
Path: v2/{+connection}: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'.
Parameter Order: connection
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:executeSqlQuery
Parameters:
connection
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/connections/[^/]+$
Required: Yes
Description: Required. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection}
Type: string
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
▼ ▲ connectors.projects.locations.connections.entityTypes.entities.create
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.
Parameters:
parent
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/connections/[^/]+/entityTypes/[^/]+$
Type: string
Description: Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}
Required: Yes
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/entityTypes/{entityTypesId}/entities
Parameter Order: parent
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v2/{+parent}/entities
▼ ▲ connectors.projects.locations.connections.entityTypes.entities.deleteEntitiesWithConditions
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/entityTypes/{entityTypesId}/entities:deleteEntitiesWithConditions
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v2/{+entityType}/entities:deleteEntitiesWithConditions
HTTP Method: POST
Parameter Order: entityType
Description: Deletes entities based on conditions specified in the request and not on entity id.
Parameters:
entityType
Description: Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}
Pattern: ^projects/[^/]+/locations/[^/]+/connections/[^/]+/entityTypes/[^/]+$
Location: path
Type: string
Required: Yes
conditions
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.
Location: query
▼ ▲ connectors.projects.locations.connections.entityTypes.entities.patch
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/entityTypes/{entityTypesId}/entities/{entitiesId}
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.
Parameter Order: name
Parameters:
name
Description: Output only. Resource name of the Entity. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id}
Location: path
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/connections/[^/]+/entityTypes/[^/]+/entities/[^/]+$
Path: v2/{+name}
HTTP Method: PATCH
▼ ▲ 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.
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
Parameters:
pageSize
Format: int32
Type: integer
Location: query
Description: Number of entity rows to return. Defaults page size = 25. Max page size = 200.
parent
Location: path
Description: Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/connections/[^/]+/entityTypes/[^/]+$
sortBy
Location: query
Description: List of 'sort_by' columns to use when returning the results.
Type: string
Repeated: Yes
pageToken
Location: query
Type: string
Description: Page token value if available from a previous request.
conditions
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.
Location: query
Type: string
Path: v2/{+parent}/entities
▼ ▲ connectors.projects.locations.connections.entityTypes.entities.get
Path: v2/{+name}
HTTP Method: GET
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/entityTypes/{entityTypesId}/entities/{entitiesId}
Parameter Order: name
Parameters:
name
Type: string
Description: Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id}
Pattern: ^projects/[^/]+/locations/[^/]+/connections/[^/]+/entityTypes/[^/]+/entities/[^/]+$
Location: path
Required: Yes
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets a single entity row matching the entity type and entity id specified in the request.
▼ ▲ connectors.projects.locations.connections.entityTypes.entities.delete
Parameter Order: name
Description: Deletes an existing entity row matching the entity type and entity id specified in the request.
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/entityTypes/{entityTypesId}/entities/{entitiesId}
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/connections/[^/]+/entityTypes/[^/]+/entities/[^/]+$
Location: path
Type: string
Description: Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id}
Required: Yes
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v2/{+name}
HTTP Method: DELETE
▼ ▲ connectors.projects.locations.connections.entityTypes.entities.updateEntitiesWithConditions
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/entityTypes/{entityTypesId}/entities:updateEntitiesWithConditions
Parameters:
conditions
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
Type: string
entityType
Description: Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/connections/[^/]+/entityTypes/[^/]+$
Required: Yes
Type: string
Description: Updates entities based on conditions specified in the request and not on entity id.
Path: v2/{+entityType}/entities:updateEntitiesWithConditions
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: entityType
HTTP Method: POST
▼ ▲ connectors.projects.locations.connections.entityTypes.list
HTTP Method: GET
Parameter Order: parent
Description: Lists metadata related to all entity types present in the external system.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v2/{+parent}/entityTypes
Parameters:
pageToken
Type: string
Location: query
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.
pageSize
Location: query
Format: int32
Type: integer
Description: Number of entity types to return. Defaults to 25.
parent
Type: string
Description: Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/connections/[^/]+$
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/entityTypes
▼ ▲ connectors.projects.locations.connections.actions.list
Parameters:
pageSize
Format: int32
Type: integer
Description: Number of Actions to return. Defaults to 25.
Location: query
parent
Location: path
Description: Required. Parent resource name of the Action. Format: projects/{project}/locations/{location}/connections/{connection}
Pattern: ^projects/[^/]+/locations/[^/]+/connections/[^/]+$
Required: Yes
Type: string
pageToken
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.
Type: string
Location: query
Path: v2/{+parent}/actions
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Parameter Order: parent
Description: Gets the schema of all the actions supported by the connector.
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/actions
▼ ▲ connectors.projects.locations.connections.actions.execute
Parameters:
name
Location: path
Description: Required. Resource name of the Action. Format: projects/{project}/locations/{location}/connections/{connection}/actions/{action}
Pattern: ^projects/[^/]+/locations/[^/]+/connections/[^/]+/actions/[^/]+$
Required: Yes
Type: string
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/actions/{actionsId}:execute
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
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.
Path: v2/{+name}:execute