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