Method: projects.locations.connections.runtimeEntitySchemas.list

List schema of a runtime entities filtered by entity name.

HTTP request

GET https://connectors.googleapis.com/v1/{parent=projects/*/locations/*/connections/*}/runtimeEntitySchemas

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Parent resource of RuntimeEntitySchema Format: projects/{project}/locations/{location}/connections/{connection}

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

  • connectors.connections.getRuntimeEntitySchema

Query parameters

Parameters
pageSize

integer

Page size.
pageToken

string

Page token.
filter

string

Required. Filter Format: entity="{entityId}" Only entity field is supported with literal equality operator. Accepted filter example: entity="Order" Wildcards are not supported in the filter currently.

Request body

The request body must be empty.

Response body

Response message for ConnectorsService.ListRuntimeEntitySchemas.

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

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

object (RuntimeEntitySchema)

Runtime entity schemas.
nextPageToken

string

Next page token.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.