Method: projects.locations.connections.connectionSchemaMetadata.listEntityTypes

List entity types.

HTTP request

GET https://connectors.googleapis.com/v1/{name=projects/*/locations/*/connections/*/connectionSchemaMetadata}:listEntityTypes

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Resource name format: projects/{project}/locations/{location}/connections/{connection}/connectionSchemaMetadata

Authorization requires the following IAM permission on the specified resource name:

  • connectors.connections.getConnectionSchemaMetadata

Query parameters

Parameters
pageSize

integer

Page size. If unspecified, at most 50 entity types will be returned.
pageToken

string

Page token.
filter

string

Required. Filter Wildcards are not supported in the filter currently.
view

enum (View)

Specifies which fields are returned in response. Defaults to BASIC view.

Request body

The request body must be empty.

Response body

Response message for connectionSchemaMetadata.listEntityTypes API

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

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

object (RuntimeEntitySchema)

list of entity types
nextPageToken

string

token for next page

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

View

View: Basic is the only supported view for now

Enums
VIEW_UNSPECIFIED
BASIC