GCP.Connectors reference

ConnectionsEntityTypesEntity

Source: src/GCP/Connectors/ConnectionsEntityTypesEntity.ts

A row in a connected system, reached through Integration Connectors.

Entities live under a Connection entity type. The entity id is assigned by the external system. Parent and entity id are identity — changing either replaces the row. fields update in place via patch. Entities have no labels, so nothing is written into the external row to mark ownership: Alchemy tracks the row by its server-assigned name.

Creating an entity requires an ACTIVE Integration Connectors connection whose entity type accepts the supplied fields.

ConnectionsEntityTypesEntity: Creating an Entity

const account = yield* GCP.Connectors.ConnectionsEntityTypesEntity(
  "Account",
  {
    parent:
      "projects/my-project/locations/us-central1/connections/salesforce/entityTypes/Account",
    fields: { Name: "Acme" },
  },
);

ConnectionsEntityTypesEntity: Updating an Entity

// Same logical id, changed fields: the engine keeps the row and patches it.
const account = yield* GCP.Connectors.ConnectionsEntityTypesEntity(
  "Account",
  {
    parent:
      "projects/my-project/locations/us-central1/connections/salesforce/entityTypes/Account",
    fields: { Name: "Acme Corp" },
  },
);

GetEntity

Source: src/GCP/Connectors/GetEntity.ts

Runtime binding for Integration Connectors entities.get.

Bind this operation to a ConnectionsEntityTypesEntity in a Function/Action init phase. Provide GetEntityHttp.

GetEntity: Reading an Entity

const getEntity = yield* GCP.Connectors.GetEntity(account);
const live = yield* getEntity();

GetEntityHttp

Source: src/GCP/Connectors/GetEntityHttp.ts Kind: Layer · Provides: GCP.Connectors.GetEntity

HTTP implementation of GetEntity.