Elasticsearch

El conector de Elasticsearch te permite conectarte a un motor de búsqueda de Elasticsearch y realizar las operaciones de motor de búsqueda compatibles.

Antes de comenzar

Antes de usar el conector de Elasticsearch, realiza las siguientes tareas:

En tu proyecto de Google Cloud, haz lo siguiente:
- Otorga el rol de IAM roles/connectors.admin al usuario que configura el conector.
- Otorga los siguientes roles de IAM a la cuenta de servicio que deseas usar para el conector:
  - roles/secretmanager.viewer
  - roles/secretmanager.secretAccessor
  Una cuenta de servicio es un tipo de Cuenta de Google especial que representa a un usuario no humano que debe autenticarse y tener autorización para acceder a los datos de las APIs de Google. Si no tienes una cuenta de servicio, debes crear una. Para obtener más información, consulta Crea una cuenta de servicio.
- Habilita los siguientes servicios:
  - secretmanager.googleapis.com (API de Secret Manager)
  - connectors.googleapis.com (API de conectores)
  Para comprender cómo habilitar servicios, consulta Habilita servicios.
Si estos servicios o permisos no se habilitaron antes para tu proyecto, se te solicitará que los habilites cuando configures el conector.

Configura el conector

Para configurar el conector, debes crear una conexión a tu fuente de datos (sistema de backend). Una conexión es específica de una fuente de datos. Significa que, si tienes muchas fuentes de datos, debes crear una conexión independiente para cada fuente. Para crear una conexión, sigue estos pasos:

En la consola de Cloud, ve a la página Conectores de Integration > Conexiones y, luego, selecciona o crea un proyecto de Google Cloud.
Ir a la página Conexiones
Haz clic en + CREAR NUEVO para abrir la página Crear conexión.
En la sección Ubicación, elige la ubicación para la conexión.
1. Región: selecciona una ubicación de la lista desplegable.
  Para obtener la lista de todas las regiones compatibles, consulta Ubicaciones.
2. Haga clic en SIGUIENTE.
En la sección Detalles de la conexión, completa lo siguiente:
1. Conector: Selecciona Elasticsearch en la lista desplegable de conectores disponibles.
2. Versión del conector: selecciona la versión del conector de la lista desplegable de versiones disponibles.
3. En el campo Nombre de la conexión, ingresa un nombre para la instancia de conexión.
  Los nombres de las conexiones deben cumplir con los siguientes criterios:
  - Los nombres de las conexiones pueden usar letras, números o guiones.
  - Las letras deben estar en minúsculas.
  - Los nombres de las conexiones deben comenzar con una letra y terminar con una letra o un número.
  - Los nombres de las conexiones no pueden superar los 63 caracteres.
4. De manera opcional, ingresa una Descripción para la instancia de conexión.
5. Cuenta de servicio: Selecciona una cuenta de servicio que tenga los roles necesarios.
6. De manera opcional, configura los parámetros de nodo de conexión:
  - Cantidad mínima de nodos: Ingresa la cantidad mínima de nodos de conexión.
  - Cantidad máxima de nodos: Ingresa la cantidad máxima de nodos de conexión.
  Un nodo es una unidad (o réplica) de una conexión que procesa transacciones. Se requieren más nodos para procesar más transacciones para una conexión y, del mismo modo, se requieren menos para procesar menos transacciones. Para comprender cómo los nodos afectan el precio del conector, consulta Precios de nodos de conexión. Si no ingresas ningún valor, se establecen de forma predeterminada los nodos mínimos en 2 (para una mejor disponibilidad) y los nodos máximos se establecen en 50.
7. Evaluación del cliente: Configura ClientSideEvaluation como verdadero para realizar la evaluación del cliente en objetos anidados.
8. Modelo de datos: Especifica el modelo de datos que se usará cuando se analicen documentos de Elasticsearch y se generen los metadatos de la base de datos.
9. Cantidad máxima de resultados: La cantidad máxima de resultados que se mostrarán desde Elasticsearch cuando se use la API de búsqueda predeterminada.
10. Usar proxy: selecciona esta casilla de verificación a fin de configurar un servidor proxy para la conexión y configurar los siguientes valores:
11. De forma opcional, haz clic en + AGREGAR ETIQUETA para agregar una etiqueta a la conexión en forma de un par clave-valor.
12. Haga clic en SIGUIENTE.
En la sección Destinos, ingresa los detalles del host remoto (sistema de backend) al que deseas conectarte.
1. Tipo de destino: Selecciona un Tipo de destino.
  1. En el campo Dirección de host, especifica el nombre de host o la dirección IP del destino.
    1. Si deseas establecer una conexión privada a tus sistemas de backend, sigue estos pasos:
      1. Crea un adjunto de servicio de PSC.
      2. Crea un adjunto de extremo y, luego, ingresa los detalles del adjunto del extremo en el campo Dirección del host.
    2. Si deseas establecer una conexión pública a tus sistemas de backend con seguridad adicional, puedes considerar configurar direcciones IP salientes estáticas para tus conexiones y, luego, configurar tus reglas de firewall para incluir solo las direcciones IP estáticas específicas.
  Para ingresar destinos adicionales, haz clic en +AGREGAR DESTINO.
2. Haga clic en SIGUIENTE.
En la sección Autenticación, ingresa los detalles de autenticación.
1. Selecciona un Tipo de autenticación y, luego, ingresa los detalles relevantes.
  La conexión de Elasticsearch admite los siguientes tipos de autenticación:
  - Anónimo
  - Nombre de usuario y contraseña
2. Haga clic en SIGUIENTE.
Revisa: Revisa tus detalles de conexión y autenticación.
Haz clic en Crear.

Configura la autenticación

Ingresa los detalles según la autenticación que desees usar.

Anónimo
Si deseas usar un acceso anónimo, selecciona No disponible.

Nombre de usuario y contraseña
- Username: Nombre de usuario para el conector
- Password: El Secret de Secret Manager que contiene la contraseña asociada con el conector.

Entidades, operaciones y acciones

Todos los Integration Connectors proporcionan una capa de abstracción para los objetos de la aplicación conectada. Solo puedes acceder a los objetos de una aplicación a través de esta abstracción. La abstracción se expone como entidades, operaciones y acciones.

Entidades: Una entidad puede considerarse como un objeto o una colección de propiedades en la aplicación o servicio conectados. La definición de una entidad difiere de conector a conector. Por ejemplo, en un conector de bases de datos, las tablas son las entidades; en un conector de servidor de archivos, las carpetas son las entidades; en un conector de sistema de mensajería, las colas son las entidades.
Sin embargo, es posible que un conector no admita o tenga ninguna entidad, en cuyo caso la lista Entities estará vacía.
Operaciones: Una operación es la actividad que puedes realizar en una entidad. Puedes realizar cualquiera de las siguientes operaciones en una entidad:
- Lista
- Obtén
- Crear
- Actualizar
- Borrar
Cuando se selecciona una entidad de la lista disponible, se genera una lista de operaciones disponibles para esa entidad. Para obtener una descripción detallada de las operaciones, consulta las operaciones de entidades de la tarea de conectores. Sin embargo, si un conector no admite ninguna de las operaciones de entidad, tales operaciones no compatibles no aparecerán en la lista Operations.
Acción: Una acción es una función de primera clase que está disponible para la integración mediante la interfaz de Conectores. Una acción te permite realizar cambios en una entidad o entidades y variar de un conector a otro. Sin embargo, es posible que un conector no admita ninguna acción, en cuyo caso la lista Actions estará vacía.

Limitaciones del sistema

El conector de Elasticsearch puede procesar 10 transacciones por segundo por nodo y regula cualquier transacción que supere este límite. De forma predeterminada, Integration Connectors asigna 2 nodos (para una mejor disponibilidad) a una conexión.

Para obtener más información sobre los límites aplicables a Integration Connectors, consulta Límites.

Nota: La cantidad de nodos de Integration Connectors ajustará la escala de forma automática de forma dinámica según tu uso. Sin embargo, si deseas reservar capacidad para grandes volúmenes sin esperar al ajuste de escala automático, puedes ajustar el valor mínimo de nodo para una conexión. Se necesitan más nodos para procesar más transacciones de una conexión. Por el contrario, se requieren menos nodos si una conexión procesa menos transacciones. Para configurar los valores del nodo, haz lo siguiente:

Si eres un cliente de pago por uso, configura el valor mínimo y máximo de nodos en la página de edición de la conexión.
Si eres un cliente que usa una suscripción, comunícate con el equipo de asistencia.

La cantidad máxima de transacciones que un nodo puede controlar depende de varios factores. Por lo tanto, antes de ajustar los nodos mínimos para lograr una mejor capacidad de procesamiento, te recomendamos que verifiques si los sistemas de backend están configurados de forma óptima para manejar el tráfico requerido.

Acciones

En esta sección, se enumeran las acciones que admite el conector. Para comprender cómo configurar las acciones, consulta Ejemplos de acciones.

Nota: Los resultados de todas las acciones estarán disponibles como una respuesta JSON en el parámetro de respuesta connectorOutputPayload de la tarea Connectors después de que ejecutes la integración.

Acción CreateIndex

Esta acción crea un índice.

Parámetros de entrada de la acción CreateIndex

Nombre del parámetro	Tipo de datos	Requeridos	Descripción
AliasFilter	String	No.	Es un objeto DSL de consulta que se usa para limitar los documentos a los que puede acceder el alias.
NumberOfShards	String	No.	Cantidad de fragmentos principales que debe tener el índice creado.
AliasIsWriteIndex	Booleano	No.	Especifica si el índice de alias es de escritura.
Alias	String	No.	Es un alias para el índice.
AliasIndexRouting	String	No.	Valor que se usa en el alias para enrutar las operaciones de indexación a un fragmento específico. Si se especifica, esta opción reemplaza el valor de enrutamiento para las operaciones de indexación.
Índice	String	Sí	Es el nombre del índice.
NumberOfRoutingShards	String	No.	Número que Elasticsearch usa internamente con el valor de NumberOfShards para enrutar los documentos a un fragmento principal.
OtherSettings	String	No.	Un objeto de configuración JSON. Esta configuración no se puede usar junto con NumberOfRouteShards o NumberOfShards.
Asignaciones	String	No.	Un objeto JSON que especifica la asignación del índice.
AliasIsHidden	Booleano	No.	Especifica si el alias está oculto. Todos los índices del alias deben tener el mismo valor de `is_hidden`.
AliasRouting	String	No.	Valor que se usa en el alias para enrutar las operaciones de indexación y búsqueda a un fragmento específico. Puede reemplazarse por AliasIndexRouting o AliasSearchRouting para determinadas operaciones.

Parámetros de salida de la acción CreateIndex

Esta acción devuelve el estado 200 (OK) si la acción se realizó correctamente.

Para comprender cómo configurar la acción CreateIndex, consulta Ejemplos de acciones.

Acción ModifyIndexAliases

Esta acción modifica un alias de índice.

Parámetros de entrada de la acción ModifyIndexAliases

Nombre del parámetro	Tipo de datos	Requeridos	Descripción
Alias	String	No.	El nombre del alias. Si se incluyen varios alias, están separados por punto y coma.
Filtro	String	No.	Un filtro para usar cuando se crea el alias. Esto toma el filtro JSON sin procesar con Consultar DSL. Si hay varios filtros, están separados por punto y coma.
Enrutamiento	String	No.	El valor de enrutamiento para asociar con el alias. Si hay varios valores de enrutamiento, están separados por punto y coma.
SearchRouting	String	No.	El valor de enrutamiento para asociar con el alias para operaciones de búsqueda. Si hay varios valores de enrutamiento de búsqueda, estos están separados por punto y coma.
IndexRouting	String	No.	El valor de enrutamiento para asociar con el alias para las operaciones de indexación. Si hay varios valores de enrutamiento de índice, estos se separan con punto y coma.
Acción	String	Sí	La acción que se realizará, como `add`, `remove` o `remove_index`. En caso de que las acciones estén separadas por punto y coma,
Índice	String	Sí	Es el nombre del índice. Si hay varios índices, están separados por punto y coma.

Parámetros de resultado de la acción ModifyIndexAliases

Esta acción devuelve el estado 200 (OK) si la acción se realizó correctamente.

Para comprender cómo configurar la acción ModifyIndexAliases, consulta Ejemplos de acciones.

Acción EjecutarCustomQuery

Esta acción te permite ejecutar una consulta personalizada.

Para crear una consulta personalizada, sigue estos pasos:

Sigue las instrucciones detalladas para agregar una tarea de conectores.
Cuando configures la tarea del conector, selecciona Acciones en el tipo de acción que desees realizar.
En la lista Acción, selecciona Ejecutar consulta personalizada y, luego, haz clic en Listo.
Expande la sección Entrada de tarea y, luego, haz lo siguiente:
1. En el campo Tiempo de espera después, ingresa el número de segundos que se debe esperar hasta que se ejecute la consulta.
  Valor predeterminado: 180 segundos.
2. En el campo Cantidad máxima de filas, ingresa la cantidad máxima de filas que se mostrarán en la base de datos.
  Valor predeterminado: 25.
3. Para actualizar la consulta personalizada, haz clic en Editar consulta personalizada. Se abrirá el diálogo Editor de secuencias de comandos.
4. En el cuadro de diálogo Editor de secuencias de comandos, ingresa la consulta en SQL y haz clic en Guardar.
  Puedes usar un signo de interrogación (?) en una instrucción de SQL para representar un único parámetro que debe especificarse en la lista de parámetros de consulta. Por ejemplo, la siguiente consulta en SQL selecciona todas las filas de la tabla Employees que coinciden con los valores especificados para la columna LastName:
```
SELECT * FROM Employees where LastName=?
```
  Nota: Se admiten las declaraciones de lenguaje de manipulación de datos (DML) y el lenguaje de definición de datos (DDL).
5. Si usaste signos de interrogación en la consulta en SQL, debes agregar el parámetro. Para ello, haz clic en + Agregar nombre del parámetro en cada signo de interrogación. Mientras se ejecuta la integración, estos parámetros reemplazan los signos de interrogación (?) en la consulta en SQL de forma secuencial. Por ejemplo, si agregaste tres signos de interrogación (?), entonces debes agregar tres parámetros en orden de secuencia. Para agregar parámetros de consulta, haz lo siguiente:
  1. En la lista Tipo, selecciona el tipo de datos del parámetro.
  2. En el campo Valor, ingresa el valor del parámetro.
  3. Para agregar varios parámetros, haz clic en + Agregar parámetro de consulta.

Cuando se ejecuta correctamente, esta acción muestra el estado 200 (OK) con un cuerpo de respuesta que tiene los resultados de la consulta.

Ejemplos de acciones

En esta sección, se describe cómo realizar algunas de las acciones en este conector.

Ejemplo: Crea un índice

En este ejemplo, se crea un índice.

En el cuadro de diálogo Configure connector task, haz clic en Actions.
Selecciona la acción CreateIndex y haz clic en Listo.
En la sección Entrada de la tarea de la tarea Conectores, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value:
```
{
"Index": "new_index_1"
}
```

Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea CreateIndex tendrá un valor similar al siguiente:

[{
"CompletedBeforeTimeout": "true",
"ShardsAcknowledged": "true",
"IndexName": "new_index_1"
}]

Ejemplo: modifica un alias de índice

En este ejemplo, se muestra cómo modificar un alias de índice.

En el cuadro de diálogo Configure connector task, haz clic en Actions.
Selecciona la acción ModifyIndexAliases y haz clic en Listo.
En la sección Entrada de la tarea de la tarea Conectores, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value:
```
{
"Action": "remove_index",
"Index": "postmanindex"
}
```

Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea ModifyIndexAliases tendrá un valor similar al siguiente:

[{
}]

Ejemplos de operaciones de entidades

En esta sección, se muestra cómo realizar algunas de las operaciones de entidad en este conector.

Ejemplo: enumera todos los registros

En este ejemplo, se enumeran todos los registros de la entidad Demoindex.

En el cuadro de diálogo Configure connector task, haz clic en Entities.
Selecciona Demoindex de la lista Entity.
Selecciona la operación List y, luego, haz clic en Listo.
De manera opcional, en la sección Entrada de la tarea de la tarea Conectores, puedes filtrar tu conjunto de resultados especificando una cláusula de filtro. Especifica el valor de la cláusula de filtro siempre entre comillas simples (').

Ejemplo: obtén un registro de una entidad

En este ejemplo, se obtiene un registro con el ID especificado de la entidad Demoindex.

En el cuadro de diálogo Configure connector task, haz clic en Entities.
Selecciona Demoindex de la lista Entity.
Selecciona la operación Get y, luego, haz clic en Listo.
En la sección Task Input de la tarea Conectores, haz clic en EntityId y, luego, ingresa 23 en el campo Valor predeterminado.
Aquí, 23 es un ID de registro único en la entidad Demoindex.

Ejemplo: crea un registro en una entidad

En este ejemplo, se crea un registro en la entidad Demoindex.

En el cuadro de diálogo Configure connector task, haz clic en Entities.
Selecciona Demoindex de la lista Entity.
Selecciona la operación Create y haz clic en Listo.
En la sección Entrada de la tarea de la tarea Conectores, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value:
```
{
"message": "GET /search HTTP/1.1 200 1070000",
"@timestamp": "2099-11-15 13:12:00.0"
}
```
Si la integración se realiza correctamente, el campo connectorOutputPayload de la tarea del conector tendrá un valor similar al siguiente:
```
[{
"_id": "23"
}]
```

Ejemplo: actualiza un registro

En este ejemplo, se actualiza el registro con el ID especificado en la entidad Demoindex.

En el cuadro de diálogo Configure connector task, haz clic en Entities.
Selecciona Demoindex de la lista Entity.
Selecciona la operación Update y haz clic en Listo.
En la sección Entrada de la tarea de la tarea Conectores, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value:
```
{
"message": "GET /search HTTP/1.1 200 1070000",
"@timestamp": "2099-11-15 13:12:00.0",
"name": "GoogleCloud_Update_docs",
"price": 10.0}
```
Haz clic en entityId y, luego, ingresa 23 en el campo Default Value.
Si la integración se realiza correctamente, el campo connectorOutputPayload de la tarea del conector tendrá un valor similar al siguiente:
```
[{
"_id": "23"
}]
```

Ejemplo: borra un registro de una entidad

En este ejemplo, se borra el registro con el ID especificado en la entidad Demoindex.

En el cuadro de diálogo Configure connector task, haz clic en Entities.
Selecciona Demoindex de la lista Entity.
Selecciona la operación Delete y haz clic en Listo.
En la sección Entrada de tarea de la tarea Conectores, haz clic en entityId y, luego, ingresa pcqT4wB4uQNUCuamh4N en el campo Valor predeterminado.

Usa Terraform para crear conexiones

Puedes usar el recurso de Terraform para crear una conexión nueva.

Si deseas obtener más información para aplicar o quitar una configuración de Terraform, consulta los comandos básicos de Terraform.

Si quieres ver una plantilla de muestra de Terraform para crear conexiones, consulta la plantilla de muestra.

Cuando creas esta conexión en Terraform, debes establecer las siguientes variables en tu archivo de configuración de Terraform:

Nombre del parámetro	Tipo de datos	Requeridos	Descripción
client_side_evaluation	BOOLEAN	Falso	Configura ClientSideEvaluation como verdadero para realizar la evaluación del lado del cliente en objetos anidados.
data_model	ENUM	Falso	Especifica el modelo de datos que se usará cuando se analicen documentos de Elasticsearch y se generen los metadatos de la base de datos. Los valores admitidos son Document, FlattenedDocuments y Relational.
max_results	STRING	Falso	Cantidad máxima de resultados que Elasticsearch muestra cuando se usa la API de búsqueda predeterminada.
verbosidad	STRING	Falso	El nivel de verbosidad para la conexión varía de 1 a 5. Un nivel de verbosidad más alto registrará todos los detalles de comunicación (solicitud,respuesta y certificados SSL).
proxy_enabled	BOOLEAN	Falso	Selecciona esta casilla de verificación para configurar un servidor proxy para la conexión.
proxy_auth_scheme	ENUM	Falso	El tipo de autenticación que se usará para autenticar en el proxy de ProxyServer. Los valores admitidos son BASIC, DIGEST y NONE.
proxy_user	STRING	Falso	Un nombre de usuario que se usará para autenticarse en el proxy de ProxyServer.
proxy_password	SECRET	Falso	Una contraseña que se utilizará para autenticarse en el proxy de ProxyServer.
proxy_ssltype	ENUM	Falso	El tipo de SSL que se usará cuando se establezca la conexión con el proxy de ProxyServer. Los valores admitidos son AUTO, ALWAYS, NEVER, TUNNEL.

Usa la conexión de Elasticsearch en una integración

Después de crear la conexión, estará disponible en Apigee Integration y en Application Integration. Puedes usar la conexión en una integración mediante la tarea Conectores.

Para comprender cómo crear y usar la tarea Conectores en la integración de Apigee, consulta la Tarea Conectores.
Para comprender cómo crear y usar la tarea Conectores en Application Integration, consulta la tarea Conectores.

Obtén ayuda de la Comunidad de Google Cloud

Puedes publicar tus preguntas y debatir sobre este conector en la comunidad de Google Cloud en Cloud Forums.

¿Qué sigue?

Comprende cómo suspender y reanudar una conexión.
Descubre cómo supervisar el uso de los conectores.
Descubre cómo ver los registros del conector.