- Solicitud HTTP
- Parámetros de ruta de acceso
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Alcances de la autorización
- PushItem
- PushItem.Type
- Pruébala
Envía un elemento a una cola para sondearlo y actualizarlo más tarde.
Esta API requiere una cuenta de administrador o de servicio para ejecutarse. La cuenta de servicio utilizada es la que está incluida en la lista blanca de la fuente de datos correspondiente.
Solicitud HTTP
POST https://cloudsearch.googleapis.com/v1/indexing/{item.name=datasources/*/items/*}:push
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de ruta de acceso
Parámetros | |
---|---|
item.name |
Es el nombre de la Formato: fuentes de datos/{sourceId}/items/{ID} Éste es un campo obligatorio. La longitud máxima es de 1,536 caracteres. |
Cuerpo de la solicitud
El cuerpo de la solicitud contiene datos con la siguiente estructura:
Representación JSON |
---|
{ "item": { "name": string, "type": enum ( |
Campos | |
---|---|
item.type |
El tipo de operación de envío que define el comportamiento de envío. |
item.metadataHash |
El hash de metadatos del elemento según el repositorio. Si se especifica, se usa para determinar cómo modificar el estado de este elemento. Si configuras este campo y el campo |
item.structuredDataHash |
Hash de datos estructurados del elemento según el repositorio Si se especifica, se usa para determinar cómo modificar el estado de este elemento. Si configuras este campo y el campo |
item.contentHash |
Hash de contenido del elemento según el repositorio. Si se especifica, se usa para determinar cómo modificar el estado de este elemento. Si configuras este campo y el campo |
item.payload |
Proporciona información adicional sobre el estado del documento para el conector, como un ID de repositorio alternativo y otros metadatos. La longitud máxima es de 8,192 bytes. String codificada en base64. |
item.queue |
Fila a la que pertenece este elemento. Si no se especifica este campo, se elige la cola |
item.repositoryError |
Propaga este campo para almacenar los detalles del error del conector o del repositorio. Esta información se muestra en la Consola del administrador. Este campo solo se puede propagar cuando el valor de |
connectorName |
El nombre del conector que realiza esta llamada. Formato: fuentes de datos/{sourceId}/conectores/{ID} |
debugOptions |
Opciones de depuración comunes. |
Cuerpo de la respuesta
Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de Item
.
Alcances de la autorización
Se necesita uno de los siguientes alcances de OAuth:
https://www.googleapis.com/auth/cloud_search.indexing
https://www.googleapis.com/auth/cloud_search
Para obtener más información, consulta la guía de autorización.
PushItem
Representa un elemento que se enviará a la cola de indexación.
Representación JSON |
---|
{ "name": string, "type": enum ( |
Campos | |
---|---|
name |
Es el nombre de la Formato: fuentes de datos/{sourceId}/items/{ID} Éste es un campo obligatorio. La longitud máxima es de 1,536 caracteres. |
type |
El tipo de operación de envío que define el comportamiento de envío. |
metadataHash |
El hash de metadatos del elemento según el repositorio. Si se especifica, se usa para determinar cómo modificar el estado de este elemento. Si configuras este campo y el campo |
structuredDataHash |
Hash de datos estructurados del elemento según el repositorio Si se especifica, se usa para determinar cómo modificar el estado de este elemento. Si configuras este campo y el campo |
contentHash |
Hash de contenido del elemento según el repositorio. Si se especifica, se usa para determinar cómo modificar el estado de este elemento. Si configuras este campo y el campo |
payload |
Proporciona información adicional sobre el estado del documento para el conector, como un ID de repositorio alternativo y otros metadatos. La longitud máxima es de 8,192 bytes. String codificada en base64. |
queue |
Fila a la que pertenece este elemento. Si no se especifica este campo, se elige la cola |
repositoryError |
Propaga este campo para almacenar los detalles del error del conector o del repositorio. Esta información se muestra en la Consola del administrador. Este campo solo se puede propagar cuando el valor de |
PushItem.Type
El tipo de operación de envío que define el comportamiento de envío.
Enumeradores | |
---|---|
UNSPECIFIED |
El valor predeterminado es UNSPECIFIED. Especifica que la operación de envío no debe modificar ItemStatus . |
MODIFIED |
Indica que el documento del repositorio se modificó o actualizó desde la llamada update anterior. Esto cambia el estado de un elemento existente a MODIFIED . Si se llama en un elemento que no existe, el estado cambia a NEW_ITEM . |
NOT_MODIFIED |
El elemento del repositorio no se modificó desde la última llamada de actualización. Esta operación de envío establecerá el estado en ACCEPTED . |
REPOSITORY_ERROR |
El conector tiene un error de repositorio relacionado con este elemento. Cambia el estado a REPOSITORY_ERROR . El elemento se reserva y se reprograma en un momento futuro determinado por una retirada exponencial. |
REQUEUE |
El envío de llamada con REQUEUE solo está disponible para los elementos reservados. Esta acción anula la reserva del elemento y restablece su hora disponible a la hora del reloj. |