uip es el desencadenador del creador de conectores & Estado

Sintaxis y opciones para conectar desencadenadores de sondeo/webhook y para acceso de lectura/escritura estructurado de bajo nivel a los archivos de un conector con el creador de conectores de Integration Service: creación de desencadenadores, consulta de estado y parche de estado.

Parte de la cadena de herramientas de creación local uip is connectors builder . Esta página cubre dos grupos de comandos no relacionados pero pequeños que comparten una página debido a su tamaño:

• builder trigger create : conecta una actividad existente como origen de eventos (sondeo o webhook), para que Studio pueda desencadenar un proceso cuando se crea, actualiza o elimina un registro de proveedor.
• builder state query/patch : una superficie de lectura/escritura genérica con dirección de puntero sobre los archivos en disco de un conector. Esta es la vía de escape para cualquier cosa que los comandos de nivel superior (init, auth, activity) no expongan como un marcador dedicado.

Para la resolución del directorio del conector, la distinción entre diseño y publicado y el flujo general de creación, consulta Conceptos en la página principal. Para las actividades a las que se adjunta un desencadenador, consulta Actividad y enlaces.

Sinopsis

uip is connectors builder trigger create --resource-name <name> --updated-date-field <field> [options...]
uip is connectors builder state query <pointer> [--connector-dir <path>]
uip is connectors builder state patch <pointer> [--value <json> | --value-file <path>] [--op upsert|remove] [--connector-dir <path>]

uip es crear desencadenador del creador de conectores

Conecte una actividad/recurso existente como origen de desencadenador: inicie el paquete de configuración de eventos (--event-kind) y, a continuación, configure los metadatos de sondeo (CREATED/UPDATED/DELETED): los metadatos de recursos estándar, la entrada de configuración del sondeador y el marcador hasEvents del conector.

trigger tiene un solo verbo. No hay trigger list/get/delete : elimina o inspecciona un desencadenador a través de state patch/state query contra la entrada element.json del recurso en su lugar.

Nota:

Utilízalo para convertir una actividad GET existente en una fuente de desencadenador de sondeo. La actividad ya debe existir: este comando falla con Code: "resourceNotFound" si aún no existe un archivo de recursos estándar para --resource-name; ejecuta activity create primero.

Opciones

Largo	Valor	Descripción
--resource-name <name>	String	Obligatorio. Actividad/recurso-estándar existente para conectar como desencadenador.
--updated-date-field <field>	String	Obligatorio. Campo de proveedor que contiene la fecha de última modificación, por ejemplo LastModifiedDate.
--event-kind <kind>	polling | webhook | all	Paquete de configuración de eventos para inicializar. Predeterminado polling. Lado del cliente validado: un valor no reconocido falla rápidamente con Code: "invalidEventKind" en lugar de retroceder silenciosamente.
--override <kv>	key=value, repetible	Anulación por entrada defaultValue para el valor preestablecido del evento propagado.
--created-date-field <field>	String	Campo de fecha de creación del proveedor. El valor predeterminado es --updated-date-field.
--id-field <field>	String	Campo de clave principal. El valor predeterminado es Id.
--date-format <mask>	String	Máscara de formato de fecha para marcas de tiempo actualizadas.
--created-date-format <mask>	String	Máscara de formato de fecha para las marcas de tiempo creadas. El valor predeterminado es --date-format.
--event-types <csv>	separados por comas	Tipos de eventos para habilitar. El valor predeterminado es CREATED,UPDATED,DELETED.
--polling-url <url>	url	URL de sondeo explícita. Se genera automáticamente a partir de la ruta GET de la actividad cuando se omite.
--date-timezone <tz>	String	Zona horaria para comparaciones de fechas. El valor predeterminado es GMT.
--polling-resource-label <label>	String	Etiqueta utilizada en elementMetadata.pollingResources.
--connector-dir <path>	Ruta	Directorio del conector. Mismo orden de resolución que Conceptos.

--event-kind pliega lo que solía ser un paso config preset --kind event independiente: siembra el paquete de configuración de eventos (las necesidades de sondeo de la entrada de configuración del sondeador) antes de conectar los metadatos de sondeo, en una llamada.

Ejemplo

uip is connectors builder trigger create --resource-name Account \
  --updated-date-field LastModifiedDate --id-field Id

Forma de datos (--json de salida)

{
  "Code": "TriggerCreated",
  "Data": {
    "ConnectorRoot": "/work/my-acme-connector",
    "ResourceName": "Account",
    "EventKind": "polling",
    "EventTypes": ["CREATED", "UPDATED", "DELETED"],
    "PollingUrl": "/accounts?where=LastModifiedDate>'<gmtDate>'",
    "PollerConfigKey": "polling.interval",
    "PollingConfig": { "...": "seeded poller config entry" }
  }
}

Se añade una matriz Warnings cuando la operación se realiza correctamente con advertencias (por ejemplo, una URL de sondeo generada automáticamente que puede necesitar revisión manual).

uip es una consulta de estado del creador de conectores

Leer el segmento de un conector direccionado por un puntero. Solo lectura: devuelve el valor analizado tal cual (un objeto, una matriz o una cadena).

Nota:

Úsalo para inspeccionar la forma actual de un conector antes de parchearlo: una sola entrada de configuración, recurso, campo de recurso estándar, archivo de enlace o clave de metadatos. Para un resumen estructural de todo el conector en lugar de una porción direccionada, utiliza inspect. Para escribir o eliminar, utilice state patch a continuación.

Argumentos

Nombre	Obligatorio	Propósito
<pointer>	Sí	Puntero en el conector: consulta Gramática de puntero a continuación.

Opciones

Largo	Valor	Descripción
--connector-dir <path>	Ruta	Directorio del conector. Mismo orden de resolución que Conceptos.

Ejemplos

uip is connectors builder state query element.json/configuration/base.url

# Path segments in a resource pointer are URL-encoded
uip is connectors builder state query element.json/resources/GET/%2Fcontacts

uip is connectors builder state query standard-resources/contacts/fields/email

Forma de datos (--json de salida)

{
  "Code": "StateQuery",
  "Data": {
    "pointer": "element.json/configuration/base.url",
    "value": { "key": "base.url", "type": "TEXTFIELD_128" }
  }
}

Las claves de Value se mantienen exactamente como aparecen en el disco (camelCase, no PascalCased como el resto de la salida de esta CLI): esto es deliberado, por lo que un resultado state query puede introducirse directamente en state patch --value sin ninguna remodelación. Consulta Consulta → parche de ida y vuelta a continuación. Una lectura en el nivel de matriz que devuelve stubs por elemento en lugar de objetos completos añade "Summarized": true y un campo SummaryHint al sobre: trata un resultado resumido como una lista de nombres/claves para consultar individualmente, no los registros completos.

uip es el parche de estado del creador de conectores

Escribir (upsert) o eliminar el segmento de un conector direccionado por un puntero. element.json es el origen de la verdad; los parámetros de recursos estándar vinculados se sincronizan automáticamente cuando un parche cambia algo de lo que dependen.

Nota:

Utilízalo para establecer o reemplazar una entrada de configuración, recurso, parámetro, campo de recurso estándar, enlace o clave de metadatos que ninguno de los comandos de nivel superior (init, auth, activity) exponga como un marcador dedicado — o para eliminar un único elemento abordado (--op remove). Para leer primero, utiliza state query arriba. Esto no es para andamios masivos o cableado de autenticación: utiliza los comandos de creación dedicados para ellos.

Argumentos

Nombre	Obligatorio	Propósito
<pointer>	Sí	Puntero en el conector: consulta Gramática de puntero a continuación.

Opciones

Largo	Valor	Descripción
--value <json>	JSON en línea	Valor a escribir. Mutuamente exclusivo con --value-file. Omitir para --op remove.
--value-file <path>	Ruta	Leer el valor JSON para escribir desde un archivo en lugar de en línea. Mutuamente exclusivo con --value.
--op <op>	upsert | remove	Operación. Predeterminado upsert.
--connector-dir <path>	Ruta	Directorio del conector. Mismo orden de resolución que Conceptos.

Ejemplos

uip is connectors builder state patch standard-resources/contacts/fields/email \
  --value '{"type":"string","vendorPath":"email"}'

uip is connectors builder state patch 'element.json/resources/GET/%2Fcontacts/parameters/0' --op remove

Forma de datos (--json de salida)

{
  "Code": "StatePatched",
  "Data": {
    "Pointer": "standard-resources/contacts/fields/email",
    "Op": "upsert",
    "Outcome": "Upserted field 'email' in contacts."
  }
}

Se añade una matriz Warnings cuando el parche tiene éxito con advertencias, y una matriz AutoSynced enumera cualquier archivo o campo vinculado que el parche actualizó como efecto secundario (por ejemplo, un parámetro de recurso estándar mantenido sincronizado con un cambio element.json definición de recurso). Ambos se omiten de Data cuando están vacíos.

Gramática de punteros

Tanto state query como state patch se dirigen a un conector a través de la misma gramática de punteros, que también se muestra en la propia salida --help de cada comando:

Puntero	Direcciones
element.json/configuration	Resumen de configuración. Filtrar con ?type=.
element.json/configuration/{key}	Una entrada de configuración.
element.json/resources	Resumen de recursos. Filtrar con ?method= / ?type=.
element.json/resources/{METHOD}/{path}	Un recurso ({path} está codificado en URL).
element.json/authentication	El bloque de autenticación.
element.json/hooks | element.json/parameters	Matrices de ganchos/parámetros globales.
standard-resources	Enumerar nombres de recursos estándar.
standard-resources/{name}	Un archivo completo de recursos estándar.
standard-resources/{name}/fields	Enumerar nombres de campo.
standard-resources/{name}/fields/{field}	Un objeto de campo.
standard-resources/{name}/metadata[/{key}]	Objeto de metadatos o una sola clave de metadatos.
hooks	Enumerar archivos de enlace.
hooks/{file}	Un archivo JS de enlace.
element-metadata.json	El objeto element-metadata.json.
cualquier otra ruta relativa al repositorio	Alternativa de archivo sin formato. Solo lectura; JSON está bastante impreso.

Consulta → parche de ida y vuelta

La salida de state query está diseñada para devolverse directamente a state patch --value sin modificar: lee un segmento con query, edita el JSON resultante y luego patch el mismo puntero con --value establecido en el JSON editado (o escribirlo en un archivo y utilizar --value-file). Esto solo funciona porque las claves de Value se conservan palabra por palabra (camelCase, mayúsculas y minúsculas en disco) en lugar de PascalCased como el resto de la salida JSON de esta CLI: volver a escribir las claves antes de parchear no hará el viaje de ida y vuelta correctamente.

Relacionado

• Descripción general y ciclo de vida del tenant : conceptos compartidos en todas las páginas del creador, más download/import/publish/publish-status.
• Inicialización y conector : aplica andamio a un conector y el resumen estructural inspect .
• Auth : configura el esquema de autenticación del conector.
• Actividad y enganches : las actividades a las que se adjunta un desencadenador.

Ver también

• Descripción general de la herramienta de Integration Service
• Opciones globales
• Códigos de salida