entity_types

Creates, updates, deletes, gets or lists an entity_types resource.

Overview

Name	entity_types
Type	Resource
Id	google.connectors.entity_types

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	The name of the entity type.
defaultSortBy	string
fields	array	List containing metadata information about each field of the entity type.
jsonSchema	object	JsonSchema representation of this entity's schema (id: JsonSchema)
metadata	object	Metadata like service latency, etc.
operations	array

list

Successful response

Name	Datatype	Description
name	string	The name of the entity type.
defaultSortBy	string
fields	array	List containing metadata information about each field of the entity type.
jsonSchema	object	JsonSchema representation of this entity's schema (id: JsonSchema)
metadata	object	Metadata like service latency, etc.
operations	array

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, connectionsId, entityTypesId	view, contextMetadata	Gets metadata of given entity type
list	select	projectsId, locationsId, connectionsId	pageSize, pageToken, view	Lists metadata related to all entity types present in the external system.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
connectionsId	string
entityTypesId	string
locationsId	string
projectsId	string
contextMetadata	string
pageSize	integer (int32)
pageToken	string
view	string

SELECT examples

get

Gets metadata of given entity type

SELECT
name,
defaultSortBy,
fields,
jsonSchema,
metadata,
operations
FROM google.connectors.entity_types
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND connectionsId = '{{ connectionsId }}' -- required
AND entityTypesId = '{{ entityTypesId }}' -- required
AND view = '{{ view }}'
AND contextMetadata = '{{ contextMetadata }}';

list

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

SELECT
name,
defaultSortBy,
fields,
jsonSchema,
metadata,
operations
FROM google.connectors.entity_types
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND connectionsId = '{{ connectionsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND view = '{{ view }}';