Method: projects.locations.connections.getConnectionSchemaMetadata

Gets schema metadata of a connection. SchemaMetadata is a singleton resource for each connection.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Connection name Format: projects/{project}/locations/{location}/connections/{connection}/connectionSchemaMetadata

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

  • connectors.schemametadata.get

Request body

The request body must be empty.

Response body

ConnectionSchemaMetadata is the singleton resource of each connection. It includes the entity and action names of runtime resources exposed by a connection backend.

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

JSON representation 
{
  "entities": [
    string
  ],
  "actions": [
    string
  ],
  "name": string,
  "updateTime": string,
  "refreshTime": string,
  "state": enum (State),
  "errorMessage": string
}
Fields
entities[]

string

Output only. List of entity names.
actions[]

string

Output only. List of actions.
name

string

Output only. Resource name. Format: projects/{project}/locations/{location}/connections/{connection}/connectionSchemaMetadata
updateTime

string (Timestamp format)

Output only. Timestamp when the connection runtime schema was updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
refreshTime

string (Timestamp format)

Output only. Timestamp when the connection runtime schema refresh was triggered.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
state

enum (State)

Output only. The current state of runtime schema.
errorMessage

string

Error message for users.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

State

LINT.IfChange State of connection runtime schema.

Enums
STATE_UNSPECIFIED Default state.
REFRESHING Schema refresh is in progress.
UPDATED Schema has been updated.
REFRESHING_SCHEMA_METADATA Schema refresh for metadata is in progress.
UPDATED_SCHEMA_METADATA Schema metadata has been updated.
REFRESH_SCHEMA_METADATA_FAILED Failed to refresh schema metadata
REFRESHING_FULL_SCHEMA Triggered full schema refresh
UPDATED_FULL_SCHEMA Updated full schema