Política PublishMessage

Esta página se aplica a Apigee y Apigee Hybrid.

Consulta la documentación de Apigee Edge.

Información general

La política PublishMessage te permite publicar información sobre el flujo de tu proxy de API en un tema de Google Cloud Pub/Sub. Pub/Sub de Google permite que los servicios se comuniquen de forma asíncrona, con una latencia significativamente menor. Para obtener más información sobre Pub/Sub, consulta ¿Qué es Pub/Sub? La información que quieras publicar en un tema de Pub/Sub puede ser texto literal o una variable de flujo. También puedes especificar una combinación de texto literal y variables de flujo mediante una plantilla de mensaje.

Si la solicitud de publicación se realiza correctamente, Apigee asigna a la variable de flujo publishmessage.message.id el valor devuelto por el servidor Pub/Sub. Para obtener más información, consulta Variables de flujo.

Esta política es una política estándar y se puede implementar en cualquier tipo de entorno. Para obtener información sobre los tipos de políticas y la disponibilidad de cada tipo de entorno, consulta Tipos de políticas.

Autenticación e implementación de proxy

Para ejecutar la política PublishMessage, necesitas un token de autenticación. Sin embargo, no hay ningún elemento <Authentication> explícito en la definición de la política. Debes desplegar tu proxy de API para usar la autenticación de Google, que añade el token de autenticación a la solicitud de forma interna. Para obtener información sobre cómo implementar un proxy de API que utilice la autenticación de Google, consulta los pasos de implementación. Además de usar la autenticación de Google en tu proxy de API, debes desplegarlo con una cuenta de servicio que tenga un rol con el permiso pubsub.topics.publish. Para obtener más información sobre los roles de gestión de identidades y accesos (IAM) de Pub/Sub, consulta Permisos y roles.

<PublishMessage>

Especifica la política PublishMessage.

En la siguiente tabla se ofrece una descripción general de los elementos secundarios de <PublishMessage>:

El elemento <PublishMessage> utiliza la siguiente sintaxis:

<PublishMessage continueOnError="[true|false]" enabled="[true|false]" name="Publish-Message-1">
    <DisplayName>DISPLAY_NAME</DisplayName>
    <Source>SOURCE_VALUE</Source>
    <CloudPubSub>
        <Topic>TOPIC_NAME</Topic>
    </CloudPubSub>
    <IgnoreUnresolvedVariables>[true|false]</IgnoreUnresolvedVariables>
</PublishMessage>

<PublishMessage continueOnError="false" enabled="true" name="Publish-Message-1">
    <DisplayName>Publish Message-1</DisplayName>
    <Source>this is a message template {flow-variable1}</Source>
    <CloudPubSub>
        <Topic>projects/{flow-variable-project-id}/topics/{flow-variable-topic-name}</Topic>
    </CloudPubSub>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
</PublishMessage>

<PublishMessage continueOnError="false" enabled="true" name="Publish-Message-2">
    <UseMessageAsSource>request</UseMessageAsSource>
    <CloudPubSub>
        <Topic>projects/{flow-variable-project-id}/topics/{flow-variable-topic-name}</Topic>
    </CloudPubSub>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
</PublishMessage>

<PublishMessage name="Publish-Message-3">
  <Source>this is a message template {flow-variable1}</Source>
  <Attributes>
    <Attribute name='attr-name-0'>fixed-value</Attribute>
    <Attribute name='another-attribute-name'>{request.queryparam.attr1}</Attribute>
    <Attribute name='a-third-attribute-name'>{request.queryparam.attr2:default-value}</Attribute>
  </Attributes>
  <CloudPubSub>
    <Topic>projects/{flow-variable-project-id}/topics/{flow-variable-topic-name}</Topic>
  </CloudPubSub>
  <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
</PublishMessage>

Este elemento tiene los siguientes atributos, que son comunes a todas las políticas:

Referencia de elemento secundario

<Attributes>

Especifica los atributos que se adjuntarán al mensaje de Pub/Sub.

Cada atributo es un par clave-valor. El nombre asociado al atributo debe ser único. El valor de cada uno se determina de forma dinámica en el tiempo de ejecución mediante una plantilla de mensaje.

El elemento <Attributes> utiliza la siguiente sintaxis:

  <Attributes>
    <Attribute name='NAME-1'>fixed-value</Attribute>
    <Attribute name='NAME-2'>{flow-variable}</Attribute>
    ...
    <Attribute name='NAME-N'>message template here {flow-variable:default-value}</Attribute>
  </Attributes>

<PublishMessage name="PM-with-one-attribute">
  <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
  <Source>{request.queryparam.message}</Source>
  <Attributes>
    <Attribute name='my-attribute-1'>fixed-value</Attribute>
  </Attributes>
  <CloudPubSub>
    <Topic>projects/{request.queryparam.project}/topics/{request.queryparam.topic}</Topic>
  </CloudPubSub>
</PublishMessage>

<PublishMessage name="PM-with-multiple-attributes">
  <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
  <Source>{my-assembled-message}</Source>
  <Attributes>
    <Attribute name='attr-0'>fixed-value</Attribute>
    <Attribute name='attr-1'>{flow-variable1}</Attribute>
    <Attribute name='attr-2'>fixed portion {flow-variable2:default-value}</Attribute>
  </Attributes>
  <CloudPubSub>
    <Topic>projects/{propertyset.settings.project}/topics/{propertyset.settings.topic}</Topic>
  </CloudPubSub>
</PublishMessage>

<DisplayName>

Se usa junto con el atributo name para etiquetar la política en el editor de proxy de la interfaz de usuario de gestión con un nombre diferente que suene más natural.

El elemento <DisplayName> es común a todas las políticas.

El elemento <DisplayName> utiliza la siguiente sintaxis:

<PolicyElement>
  <DisplayName>POLICY_DISPLAY_NAME</DisplayName>
  ...
</PolicyElement>

<PolicyElement>
  <DisplayName>My Validation Policy</DisplayName>
</PolicyElement>

El elemento <DisplayName> no tiene atributos ni elementos secundarios.

<Source>

Especifica el mensaje que se va a publicar.

El mensaje puede ser un texto literal, una variable de flujo o una combinación de ambos en forma de plantilla de mensaje.

El elemento <Source> utiliza la siguiente sintaxis:

 <Source>SOURCE</Source>

<Source>{flow-var-1}</Source>

<PublishMessage name="PM-with-source-template">
  <Source>{
    "name": "value-1",
    "count": "{flow-variable1}",
    "action": "{flow-variable2}"
  }</Source>
  <Attributes>
    <Attribute name='content-type'>application/json</Attribute>
  </Attributes>
  <CloudPubSub>
    <Topic>projects/{propertyset.settings.project}/topics/{propertyset.settings.topic}</Topic>
  </CloudPubSub>
</PublishMessage>

<CloudPubSub>

Elemento superior de <Topic>.

Solo puedes publicar en un tema de Pub/Sub. Por lo tanto, solo puedes tener un elemento <Topic> en el elemento <CloudPubSub>.

El elemento <CloudPubSub> utiliza la siguiente sintaxis:

<CloudPubSub>
  <Topic>TOPIC_NAME</Topic>
</CloudPubSub>

<CloudPubSub>
  <Topic>projects/{my-project}/topics/{my-topic}</Topic>
</CloudPubSub>

<Topic>

Especifica el tema de Pub/Sub en el que quieres publicar el mensaje <Source>.

Debes especificar el nombre del tema en el formato projects/project-id/topics/topic-name.

El elemento <Topic> utiliza la siguiente sintaxis:

<Topic>TOPIC_NAME</Topic>

<Topic>projects/project-id-marketing/topics/topic-name-test1</Topic>

<UseMessageAsSource>

Especifica el mensaje que se va a publicar.

Úsalo como alternativa al elemento <Source>. El valor debe ser el nombre de una variable de flujo que haga referencia a un mensaje, como request, response o message. Cuando especifica este elemento, la política usa el contenido del mensaje como mensaje que se va a publicar. Deberías usar este elemento en lugar de <Source> cuando el contenido del mensaje sea un flujo de octetos que no se pueda representar como una cadena, por ejemplo, el contenido de un archivo binario.

El elemento <UseMessageAsSource> utiliza la siguiente sintaxis:

<PublishMessage name="PM-with-use-message-as-source">
  <UseMessageAsSource>MESSAGE_NAME</UseMessageAsSource>
  <Attributes>
    <Attribute name='attr-1'>{flowvar1}</Attribute>
  </Attributes>
  <CloudPubSub>
    <Topic>projects/{flowvar1}/topics/{flowvar-topic}</Topic>
  </CloudPubSub>
</PublishMessage>

<PublishMessage name="PM-with-use-message-as-source">
  <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
  <UseMessageAsSource>request</UseMessageAsSource>
  <Attributes>
    <Attribute name='attr-1'>{flowvar1}</Attribute>
  </Attributes>
  <CloudPubSub>
    <Topic>projects/{propertyset.settings.project}/topics/{propertyset.settings.topic}</Topic>
  </CloudPubSub>
</PublishMessage>

<IgnoreUnresolvedVariables>

Especifica si el procesamiento se detiene si Apigee encuentra una variable sin resolver.

Asigna el valor true para ignorar las variables sin resolver y continuar con el procesamiento. De lo contrario, asigna el valor false. El valor predeterminado es false.

Asignar el valor true a <IgnoreUnresolvedVariables> no es lo mismo que asignar el valor true a continueOnError de <PublishMessage>. Si asigna el valor true a continueOnError, Apigee ignora todos los errores, no solo los de las variables.

El elemento <IgnoreUnresolvedVariables> utiliza la siguiente sintaxis:

<IgnoreUnresolvedVariables>[true|false]</IgnoreUnresolvedVariables>

<IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>

Variables de flujo

Las variables de flujo son objetos que contienen datos específicos y están disponibles en el contexto de un flujo de proxy de API. Estas variables almacenan información como la carga útil, la ruta de la URL, las direcciones IP y los datos de la ejecución de la política. Para obtener más información sobre las variables de flujo, consulta Usar variables de flujo.

Si la política PublishMessage publica correctamente en el tema de Pub/Sub, Apigee asigna a la variable de flujo publishmessage.message.id el messageId devuelto por el servidor de Pub/Sub. La variable de flujo es de tipo cadena y está disponible para ti a partir del flujo de solicitud de proxy. En función de tus necesidades, puedes usar la variable de flujo en otras políticas posteriores. Sin embargo, si la publicación falla, Apigee no define la variable publishmessage.message.id, y el acceso a esta variable provocará errores.

Para obtener más información sobre los distintos tipos de variables de flujo, consulta la referencia de variables de flujo.

Códigos de error

En esta sección se describen los códigos de error y los mensajes de error que devuelve Apigee, así como las variables de error que define, cuando esta política activa un error. Es importante que conozcas esta información si vas a desarrollar reglas de errores para gestionarlos. Para obtener más información, consulta Qué debes saber sobre los errores de políticas y Cómo gestionar los fallos.

Errores de tiempo de ejecución

Estos errores pueden producirse cuando se ejecuta la política.

Variables de error

Cuando se producen errores de ejecución en una política, Apigee genera mensajes de error. Puedes ver estos mensajes de error en la respuesta de error. En muchas ocasiones, los mensajes de error generados por el sistema pueden no ser relevantes en el contexto de su producto. Puede que quieras personalizar los mensajes de error en función del tipo de error para que sean más significativos.

Para personalizar los mensajes de error, puedes usar reglas de error o la política RaiseFault. Para obtener información sobre las diferencias entre las reglas de errores y la política RaiseFault, consulta Reglas de errores frente a la política RaiseFault. Debes comprobar las condiciones mediante el elemento Condition tanto en las reglas de errores como en la política RaiseFault. Apigee proporciona variables de error únicas para cada política. Los valores de las variables de error se definen cuando una política activa errores de tiempo de ejecución. Al usar estas variables, puede comprobar si se dan condiciones de error específicas y tomar las medidas oportunas. Para obtener más información sobre la comprobación de condiciones de error, consulta Crear condiciones.