Google Cloud Pub/Sub Uzantısı

Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerine gidin.
bilgi

Sürüm: 1.2.0

Google Cloud Pub/Sub hizmetindeki bir konuda mesaj yayınlama

Bu içerik, uzantının yapılandırılması ve kullanılmasıyla ilgili referans bilgiler sağlar.

Ön koşullar

Bu uzantıyı bir API proxy'sinden kullanmadan önce şunları yapmanız gerekir:

  1. Hızlı başlangıç: Konsolu kullanma başlıklı makalede açıklandığı gibi bir Cloud Pub/Sub konusu oluşturun.

  2. Konuyu aldıktan sonra Cloud Pub/Sub konunuza yayınlama izni verin. Örneğin, konulara yayınlamak için roles/pubsub.publisher rolünü kullanabilirsiniz. Cloud Pub/Sub rolleri hakkında daha fazla bilgi için Erişim Denetimi başlıklı makaleyi inceleyin.

  3. Hizmet hesabı için anahtar oluşturmak üzere GCP Console'u kullanın.

  4. Yapılandırma referansını kullanarak uzantıyı eklerken ve yapılandırırken sonuçtaki anahtar JSON dosyasının içeriğini kullanın.

Cloud Pub/Sub hakkında

Cloud Pub/Sub, gönderenleri ve alıcıları birbirinden ayıran, çoka-çok eşzamansız mesajlaşma sağlar. Cloud Pub/Sub, geliştiricilerin Google Cloud Platform'da ve harici olarak barındırılan sistemleri hızlı bir şekilde entegre etmesine yardımcı olan düşük gecikmeli ve dayanıklı mesajlaşma hizmeti sunar.

Cloud Pub/Sub'ı kullanmaya yeni başlıyorsanız Cloud Pub/Sub belgelerindeki hızlı başlangıç kılavuzlarına göz atın.

Örnekler

Aşağıdaki örneklerde, ExtensionCallout politikası kullanılarak Cloud Pub/Sub uzantısı işlemleri için desteğin nasıl yapılandırılacağı gösterilmektedir.

İleti yayınlayın

Bu örnekte, publish işlemi, uzantının yapılandırmasında belirtilen bir konuda basit bir mesaj yayınlar. publish işlemi, yayınlanan iletinin yayınlandığı konudaki kimliğini döndürür.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ConnectorCallout async="false" continueOnError="true" enabled="true" name="Publish-Message">
    <DisplayName>Publish Message</DisplayName>
    <Connector>cloud-pub-sub-extension-example</Connector>
    <Action>publish</Action>
    <Input><![CDATA[
      {
          "message" : "My test message."
      }
    ]]></Input>
    <Output>topic.message.id</Output>
</ConnectorCallout>

Aşağıdaki Assign Message politikası, yanıt yükünü atamak için uzantının yanıtını depolayan değişkenin değerini kullanır.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AssignMessage async="false" continueOnError="false" enabled="true" name="Get-Topic-Message-ID">
    <DisplayName>Get Topic Message ID</DisplayName>
    <AssignTo type="response" createNew="false"/>
    <Set>
        <Payload contentType="application/json">{topic.message.id}</Payload>
    </Set>
</AssignMessage>

Bu örnekte, yanıt verileri aşağıdaki gibi JSON olarak döndürülür.

{"messageId":"165918654986954"}

İşlemler

yayınla

Bu uzantının yapılandırmasında belirtilen konuda bir mesaj yayınlar.

Söz dizimi

<Action>publish</Action>
<Input><![CDATA[{
  "message" : "message-to-publish"
}]]></Input>

Örnek

<Action>publish</Action>
<Input><![CDATA[
  {
      "message" : "My test message."
  }
]]></Input>

İstek parametreleri

Parametre Açıklama Tür Varsayılan Zorunlu
mesaj Yayınlanacak mesaj. Dize Yok. Evet.

Yanıt

Konuya yayınlanan iletinin kimliğini içeren JSON. Örneğin:

{"messageId":"165918654986954"}

Yapılandırma Referansı

Bu uzantıyı API proxy'lerinde kullanılacak şekilde yapılandırıp dağıtırken aşağıdakileri kullanın.

Sık kullanılan uzantı özellikleri

Aşağıdaki özellikler her uzantı için mevcuttur.

Mülk Açıklama Varsayılan Zorunlu
name Uzantının bu yapılandırmasını verdiğiniz ad. Yok Evet
packageName Apigee Edge'in sağladığı uzantı paketinin adı. Yok Evet
version Uzantıyı yapılandırdığınız uzantı paketinin sürüm numarası. Yok Evet
configuration Eklediğiniz uzantıya özgü yapılandırma değeri. Bu uzantı paketinin özellikleri başlıklı makaleyi inceleyin Yok Evet

Bu uzantı paketinin özellikleri

Mülk Açıklama Varsayılan Zorunlu
topic Yayınlanacak konu. Bu değeri Pub/Sub hizmetinden (ör. hizmet için GCP Console'dan) alın. Örneğin, konu adı projects/GCP-PROJECT-ID/topics/TOPIC-NAME biçiminde olabilir. Yok. Evet.
credentials Apigee Edge konsoluna girildiğinde bu, hizmet hesabı anahtar dosyanızın içeriğidir. Yönetim API'si üzerinden gönderildiğinde, hizmet hesabı anahtar dosyasından oluşturulan base64 kodlu bir değerdir. Yok. Evet.