SearchIndexingBufferedSender class
Classe usada para executar operações em buffer em um índice de pesquisa, incluindo adição, atualização e remoção delas.
Construtores
| Search |
Cria uma nova instância de SearchIndexingBufferedSender. |
Métodos
Detalhes do construtor
SearchIndexingBufferedSender<TModel>(IndexDocumentsClient<TModel>, (document: TModel) => string, SearchIndexingBufferedSenderOptions)
Cria uma nova instância de SearchIndexingBufferedSender.
new SearchIndexingBufferedSender(client: IndexDocumentsClient<TModel>, documentKeyRetriever: (document: TModel) => string, options?: SearchIndexingBufferedSenderOptions)Parâmetros
- client
-
IndexDocumentsClient<TModel>
Cliente de Pesquisa usado para chamar as operações indexBatch subjacentes.
- documentKeyRetriever
-
(document: TModel) => string
Opções para modificar a liberação automática.
Detalhes do método
deleteDocuments(TModel[], OperationOptions)
Exclui os documentos/Adiciona os documentos à fila de exclusão.
function deleteDocuments(documents: TModel[], options?: OperationOptions): Promise<void>Parâmetros
- documents
-
TModel[]
Documentos a serem excluídos.
- options
- OperationOptions
Opções de upload.
Retornos
Promise<void>
dispose()
Se estiver usando autoFlush: true, chame isso para limpar o temporizador de autoflush.
function dispose(): Promise<void>Retornos
Promise<void>
flush(OperationOptions)
Libera a fila manualmente.
function flush(options?: OperationOptions): Promise<void>Parâmetros
- options
- OperationOptions
Opções de liberação.
Retornos
Promise<void>
mergeDocuments(TModel[], OperationOptions)
Mescla os documentos/Adiciona os documentos à fila de mesclagem.
function mergeDocuments(documents: TModel[], options?: OperationOptions): Promise<void>Parâmetros
- documents
-
TModel[]
Documentos a serem mesclados.
- options
- OperationOptions
Opções de upload.
Retornos
Promise<void>
mergeOrUploadDocuments(TModel[], OperationOptions)
Mescla/Carrega os documentos/Adiciona os documentos à fila de mesclagem/upload.
function mergeOrUploadDocuments(documents: TModel[], options?: OperationOptions): Promise<void>Parâmetros
- documents
-
TModel[]
Documentos a serem mesclados/carregados.
- options
- OperationOptions
Opções de upload.
Retornos
Promise<void>
off("batchAdded", (e: { action: string, documents: TModel[] }) => void)
Desanexar Evento Desanexar Lote Adicionado
function off(event: "batchAdded", listener: (e: { action: string, documents: TModel[] }) => void)Parâmetros
- event
-
"batchAdded"
Evento a ser emitido
- listener
-
(e: { action: string, documents: TModel[] }) => void
Ouvinte de Evento
off("batchFailed", (e: RestError) => void)
Desanexar evento com falha no lote
function off(event: "batchFailed", listener: (e: RestError) => void)Parâmetros
- event
-
"batchFailed"
Evento a ser emitido
- listener
-
(e: RestError) => void
Ouvinte de Evento
off("batchSucceeded", (e: IndexDocumentsResult) => void)
Desanexar evento de êxito do lote
function off(event: "batchSucceeded", listener: (e: IndexDocumentsResult) => void)Parâmetros
- event
-
"batchSucceeded"
Evento a ser emitido
- listener
-
(e: IndexDocumentsResult) => void
Ouvinte de Evento
off("beforeDocumentSent", (e: IndexDocumentsAction<TModel>) => void)
Desanexar evento enviado em lote
function off(event: "beforeDocumentSent", listener: (e: IndexDocumentsAction<TModel>) => void)Parâmetros
- event
-
"beforeDocumentSent"
Evento a ser emitido
- listener
-
(e: IndexDocumentsAction<TModel>) => void
Ouvinte de Evento
on("batchAdded", (e: { action: string, documents: TModel[] }) => void)
Anexar evento de lote adicionado
function on(event: "batchAdded", listener: (e: { action: string, documents: TModel[] }) => void)Parâmetros
- event
-
"batchAdded"
Evento a ser emitido
- listener
-
(e: { action: string, documents: TModel[] }) => void
Ouvinte de Evento
on("batchFailed", (e: RestError) => void)
Anexar evento com falha em lote
function on(event: "batchFailed", listener: (e: RestError) => void)Parâmetros
- event
-
"batchFailed"
Evento a ser emitido
- listener
-
(e: RestError) => void
Ouvinte de Evento
on("batchSucceeded", (e: IndexDocumentsResult) => void)
Anexar evento de lote bem-sucedido
function on(event: "batchSucceeded", listener: (e: IndexDocumentsResult) => void)Parâmetros
- event
-
"batchSucceeded"
Evento a ser emitido
- listener
-
(e: IndexDocumentsResult) => void
Ouvinte de Evento
on("beforeDocumentSent", (e: IndexDocumentsAction<TModel>) => void)
Anexar evento enviado em lote
function on(event: "beforeDocumentSent", listener: (e: IndexDocumentsAction<TModel>) => void)Parâmetros
- event
-
"beforeDocumentSent"
Evento a ser emitido
- listener
-
(e: IndexDocumentsAction<TModel>) => void
Ouvinte de Evento
uploadDocuments(TModel[], OperationOptions)
Carrega os documentos/Adiciona os documentos à fila de upload.
function uploadDocuments(documents: TModel[], options?: OperationOptions): Promise<void>Parâmetros
- documents
-
TModel[]
Documentos a serem carregados.
- options
- OperationOptions
Opções de upload.
Retornos
Promise<void>