Method: projects.locations.collections.dataConnector.fetchEntitiesTypes

Fetch the entities types for a DataConnector.

HTTP request

GET https://discoveryengine.googleapis.com/v1alpha/{name=projects/*/locations/*/collections/*/dataConnector}:FetchEntitiesTypes

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Full resource name of DataConnector, such as projects/{project}/locations/{location}/collections/{collectionId}/dataConnector.

If the caller does not have permission to access the DataConnector, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the requested DataConnector does not exist, a NOT_FOUND error is returned.

Query parameters

Parameters
pageSize

integer

Optional. Requested page size for number of entities to return.
pageToken

string

Optional. A page token, provided by a previous call to dataConnector.fetchEntities. Used to fetch the next page in a paginated response.

Request body

The request body must be empty.

Response body

Response message for DataConnectorService.FetchEntitiesTypes method.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "entityTypes": [
    {
      object (EntityType)
    }
  ],
  "nextPageToken": string
}
Fields
entityTypes[]

object (EntityType)

List of entity types
nextPageToken

string

A token that can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

EntityType

The type of an entity and its supported operations.

JSON representation 
{
  "name": string,
  "operations": [
    enum (EntityTypeOperation)
  ]
}
Fields
name

string

The name of this entity type.
operations[]

enum (EntityTypeOperation)

The operation supported by this entity.

EntityTypeOperation

Operation enum contains the list of operations supported by the entity type.

Enums
ENTITY_TYPE_OPERATION_UNSPECIFIED Operation unspecified.
LIST This operation means entity type supports LIST method.
GET This operation means entity type supports GET method.
CREATE This operation means entity type supports CREATE method.
UPDATE This operation means entity type supports UPDATE method.
DELETE This operation means entity type supports DELETE method.