REST Resource: projects.locations.services.connectors

Resource: Connector

Connector consists of a set of operations, i.e. queries and mutations.

JSON representation 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "annotations": {
    string: string,
    ...
  },
  "source": {
    object (Source)
  },
  "uid": string,
  "reconciling": boolean,
  "displayName": string,
  "clientCache": {
    object (ClientCache)
  },
  "etag": string
}
Fields
name

string

Identifier. The relative resource name of the connector, in the format:

projects/{project}/locations/{location}/services/{service}/connectors/{connector}
createTime

string (Timestamp format)

Output only. [Output only] Create time stamp.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. [Output only] Update time stamp.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
labels

map (key: string, value: string)

Optional. Labels as key value pairs.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
annotations

map (key: string, value: string)

Optional. Stores small amounts of arbitrary data.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
source

object (Source)

Required. The source files that comprise the connector.
uid

string

Output only. System-assigned, unique identifier.
reconciling

boolean

Output only. A field that if true, indicates that the system is working to compile and deploy the connector.
displayName

string

Optional. Mutable human-readable name. 63 character limit.
clientCache

object (ClientCache)

Optional. The client cache settings of the connector.
etag

string

Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. AIP-154

ClientCache

Client caching settings of a connector.

JSON representation 
{
  "strictValidationEnabled": boolean,
  "entityIdIncluded": boolean
}
Fields
strictValidationEnabled

boolean

Optional. A field that, if true, enables stricter validation on the connector source code to make sure the operation response shapes are suitable for client-side caching. This can include additional errors and warnings. For example, using the same alias for different fields is disallowed, as it may cause conflicts or confusion with normalized caching. (This field is off by default for compatibility, but enabling it is highly recommended to catch common caching pitfalls.)
entityIdIncluded

boolean

Optional. A field that, if true, means that responses served by this connector will include entityIds in GraphQL response extensions. This helps the client SDK cache responses in an improved way, known as "normalized caching", if caching is enabled on the client. Each entityId is a stable key based on primary key values. Therefore, this field should only be set to true if the primary keys of accessed tables do not contain sensitive information.

Methods

create

 Creates a new Connector in a given project and location.

delete

 Deletes a single Connector.

executeMutation

 Execute a predefined mutation in a Connector.

executeQuery

 Execute a predefined query in a Connector.

get

 Gets details of a single Connector.

impersonateMutation

 Impersonate a mutation defined on a Firebase SQL Connect connector.

impersonateQuery

 Impersonate a query defined on a Firebase SQL Connect connector.

list

 Lists Connectors in a given project and location.

patch

 Updates the parameters of a single Connector, and creates a new ConnectorRevision with the updated Connector.