uip é gatilho de construtor de conectores e amp; estado

Sintaxe e opções para conectar gatilhos de pesquisa/webhook e para acesso de leitura/gravação estruturado de baixo nível aos arquivos de um conector com o construtor de conector do Integration Service — criação de gatilho, consulta de estado e patch de estado.

Parte da cadeia de ferramentas de criação local uip is connectors builder . Esta página abrange dois grupos de comando não relacionados, mas pequenos, que compartilham uma página devido ao seu tamanho:

• builder trigger create conecte uma atividade existente como uma origem de evento (pesquisa ou webhook), para que o Studio possa disparar um processo quando um registro de fornecedor for criado, atualizado ou excluído.
• builder state query/patch — uma superfície de leitura/gravação genérica endereçada ao ponteiro sobre os arquivos no disco de um conector. Essa é a janela de escape para qualquer coisa que os comandos de nível superior (init, auth, activity) não exponham como um sinalizador dedicado.

Para obter a resolução do diretório do conector, a distinção design versus publicação e o fluxo de criação geral, consulte Conceitos na página principal. Para as atividades às quais um gatilho se conecta, consulte Atividade e ganchos.

Resumo

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 é criação de gatilho do construtor de conectores

Conecte uma atividade/recurso existente como uma origem de gatilho: semeie o pacote de configuração do evento (--event-kind), em seguida, configure os metadados de pesquisa (CREATED/UPDATED/DELETED) — os metadados do recurso padrão, a entrada de configuração do pesquisador , e o sinalizador hasEvents do conector.

trigger tem um único verbo. Não há trigger list/get/delete — em vez disso, remova ou inspecione um gatilho por meio de state patch/state query contra a entrada element.json do recurso.

Observação:

Use isso para transformar uma atividade GET existente em uma origem de gatilho de pesquisa. A atividade já deve existir — esse comando falha com Code: "resourceNotFound" se nenhum arquivo de recurso padrão existir ainda para --resource-name; execute activity create primeiro.

Opções

Long	Valor	Description
--resource-name <name>	String	Obrigatório. Atividade/recurso padrão existente a ser conectado como um gatilho.
--updated-date-field <field>	String	Obrigatório. O campo do fornecedor que carrega a data da última modificação, por LastModifiedDate exemplo.
--event-kind <kind>	polling | webhook | all	Pacote de configuração de evento para gerar. pollingPadrão. Validado do lado do cliente — um valor não reconhecido falha rapidamente com Code: "invalidEventKind" em vez de recair silenciosamente.
--override <kv>	key=value, repetível	Substituição defaultValue por entrada para a predefinição do evento semeado.
--created-date-field <field>	String	Campo de data de criação do fornecedor. O padrão é --updated-date-field.
--id-field <field>	String	Campo de chave primária. O padrão é Id.
--date-format <mask>	String	Máscara de formato de data para carimbos de data/hora atualizados.
--created-date-format <mask>	String	Máscara de formato de data para carimbos de data/hora criados. O padrão é --date-format.
--event-types <csv>	separados por vírgula	Tipos de eventos a serem habilitados. O padrão é CREATED,UPDATED,DELETED.
--polling-url <url>	url	URL de pesquisa explícita. Gerado automaticamente a partir do caminho GET da atividade quando omitido.
--date-timezone <tz>	String	Fuso horário para comparações de datas. O padrão é GMT.
--polling-resource-label <label>	String	Rótulo usado em elementMetadata.pollingResources.
--connector-dir <path>	Path	Diretório do conector. Mesma ordem de resolução que Conceitos.

--event-kind dobra o que costumava ser uma etapa config preset --kind event separada: propaga o pacote de configuração de evento (as necessidades de pesquisa de entrada de configuração do pesquisador) antes de conectar os metadados de pesquisa em uma chamada.

Exemplo

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

Formato dos dados (--output json)

{
  "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" }
  }
}

Uma matriz Warnings é adicionada quando a operação é bem-sucedida com ressalvas (por exemplo, um URL de pesquisa gerado automaticamente que pode precisar de revisão manual).

uip é consulta de estado do construtor de conectores

Leia a fatia de um conector endereçado por um ponteiro. Somente leitura — retorna o valor analisado como está (um objeto, array ou string).

Observação:

Use isso para inspecionar o formato atual de um conector antes de corrigi-lo — uma única entrada de configuração, recurso, campo de recurso padrão, arquivo de hook ou chave de metadados. Para um conjunto estrutural de conector inteiro em vez de uma fatia endereçada, use inspect. Para escrever ou remover, use state patch abaixo.

Argumentos

Name	Required	Finalidade
<pointer>	sim	Pontuador para o conector — consulte gramática do ponteiro abaixo.

Opções

Long	Valor	Description
--connector-dir <path>	Path	Diretório do conector. Mesma ordem de resolução que Conceitos.

Exemplos

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

Formato dos dados (--output json)

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

As chaves do Value são mantidas exatamente como aparecem no disco (camlCase, não PascalCased como o resto da saída do CLI) — isso é deliberado, então um resultado state query pode ser inserido diretamente em state patch --value sem qualquer reformulação. Consulte Consulta → viagem de ida e volta de patch abaixo. Uma leitura no nível de array que retorna recibos por item em vez de objetos completos adiciona "Summarized": true e um campo SummaryHint ao envelope — trate um resultado resumido como uma lista de nomes/chaves a serem consultados individualmente, não os registros completos.

uip é patch de estado do construtor de conectores

Grave ( fazer upsert ) ou remova a fatia de um conector endereçado por um ponteiro. element.json é a fonte da verdade; os parâmetros de recurso padrão vinculados sincronizam-se automaticamente quando um patch altera algo do qual eles dependem.

Observação:

Use isso para definir ou substituir uma entrada de configuração, recurso, parâmetro, campo de recurso padrão, hook ou chave de metadados que nenhum dos comandos de nível superior (init, auth, activity) expõe como um sinalizador dedicado. — ou para remover um único item endereçado (--op remove). Para ler primeiro, use state query acima. Isso não é para estruturação em massa ou fiação de autenticação — use os comandos de criação dedicados para eles.

Argumentos

Name	Required	Finalidade
<pointer>	sim	Pontuador para o conector — consulte gramática do ponteiro abaixo.

Opções

Long	Valor	Description
--value <json>	JSON incorporado	Valor a ser gravado. mutuamente exclusivo com --value-file. Omitir para --op remove.
--value-file <path>	Path	Leia o valor JSON para escrever a partir de um arquivo em vez de em linha. mutuamente exclusivo com --value.
--op <op>	upsert | remove	Operação. upsertPadrão.
--connector-dir <path>	Path	Diretório do conector. Mesma ordem de resolução que Conceitos.

Exemplos

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

Formato dos dados (--output json)

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

Uma matriz Warnings é adicionada quando o patch é bem-sucedido com ressalvas, e uma matriz AutoSynced lista todos os arquivos vinculados ou campos que o patch atualizou como um efeito lateral (por exemplo, um parâmetro de recurso padrão mantido em sincronização com um element.json alterado } definição do recurso). Ambos são omitidos de Data quando vazios.

gramática do ponteiro

Ambos state query e state patch abordam um conector por meio da mesma gramática de ponteiro, também mostrada na saída --help do próprio comando:

Pontuador	Endereços
element.json/configuration	Resumo da configuração. Filtrar com ?type=.
element.json/configuration/{key}	Uma entrada de configuração.
element.json/resources	Resumo do recurso. Filtrar com ?method= / ?type=.
element.json/resources/{METHOD}/{path}	Um recurso ({path} é codificado por URL).
element.json/authentication	O bloco de autenticação.
element.json/hooks | element.json/parameters	ganchos globais / matrizes de parâmetros.
standard-resources	Listar nomes de recursos padrão.
standard-resources/{name}	Um arquivo de recurso padrão inteiro.
standard-resources/{name}/fields	Listar nomes de campos.
standard-resources/{name}/fields/{field}	Um objeto de campo.
standard-resources/{name}/metadata[/{key}]	Objeto de metadados ou uma única chave de metadados.
hooks	Listar arquivos de hook.
hooks/{file}	Um arquivo JS de hook.
element-metadata.json	O objeto element-metadata.json.
qualquer outro caminho relativo ao repositório	Fallback de arquivo bruto. SomenteLeitura; JSON é bem impresso.

Consulta → viagem de ida e volta de patch

A saída de state query foi projetada para ser realimentada diretamente para state patch --value não modificada: leia uma fatia com query, edite o JSON resultante e, em seguida, patch o mesmo ponteiro com --value definido para o JSON editado (ou grave-o em um arquivo e use --value-file). Isso só funciona porque as chaves do Value são preservadas textualmente (camlCase, uso de maiúsculas e minúsculas no disco) em vez de PascalCased, como o resto da saída JSON dessa CLI — trocar a caixa das chaves antes do patch não fará a viagem de ida e volta corretamente.

Relacionado

• Visão geral e ciclo de vida do tenant — conceitos compartilhados em todas as páginas do construtor, além de download/import/publish/publish-status.
• Inicialização e conector — estruture um conector e o pacote estrutural inspect .
• Autenticação — configure o esquema de autenticação do conector.
• Atividade e ganchos — as atividades às quais um gatilho se conecta.

Veja também

• Visão geral da ferramenta do Integration Service
• Opções globais
• Códigos de saída