Kebijakan PublishMessage

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

Lihat dokumentasi Apigee Edge.

Kebijakan PublishMessage memungkinkan Anda memublikasikan informasi alur proxy API ke topik Google Cloud Pub/Sub. Pub/Sub Google memungkinkan layanan berkomunikasi secara asinkron, dengan latensi yang jauh lebih rendah. Untuk mengetahui informasi selengkapnya tentang Pub/Sub, lihat Apa itu Pub/Sub?. Informasi yang ingin Anda publikasikan ke topik Pub/Sub dapat berupa teks literal atau variabel alur. Anda juga dapat menentukan kombinasi teks literal dan variabel alur dengan menggunakan template pesan.

Jika permintaan publikasi berhasil, Apigee akan menetapkan variabel alur publishmessage.message.id ke nilai yang ditampilkan oleh server Pub/Sub. Untuk mengetahui informasi selengkapnya, lihat Variabel alur.

Kebijakan ini adalah Kebijakan standar dan dapat di-deploy ke jenis lingkungan apa pun. Untuk mengetahui informasi tentang jenis dan ketersediaan kebijakan dengan setiap jenis lingkungan, lihat Jenis kebijakan.

Deployment autentikasi dan proxy

Untuk menjalankan kebijakan PublishMessage, Anda memerlukan token autentikasi. Namun, tidak ada elemen <Authentication> eksplisit dalam definisi kebijakan. Anda harus men-deploy proxy API untuk menggunakan autentikasi Google, yang menambahkan token autentikasi ke permintaan di balik layar. Untuk mengetahui informasi tentang cara men-deploy proxy API yang menggunakan autentikasi Google, lihat Langkah-langkah deployment. Selain menggunakan autentikasi Google di proxy API, Anda harus men-deploy proxy API dengan akun layanan yang memiliki peran dengan izin pubsub.topics.publish. Untuk mengetahui informasi selengkapnya tentang peran Identity and Access Management (IAM) untuk Pub/Sub, lihat Izin dan peran.

`<PublishMessage>`

Menentukan kebijakan PublishMessage.

Nilai Default	T/A
Wajib?	Wajib
Jenis	Jenis kompleks
Elemen Induk	T/A
Elemen Turunan	`<Attributes>` `<CloudPubSub>` `<DisplayName>` `<IgnoreUnresolvedVariables>` `<Source>` `<UseMessageAsSource>`

Tabel berikut memberikan deskripsi umum tentang elemen turunan <PublishMessage>:

Elemen Turunan	Wajib?	Deskripsi
`<Attributes>`	Opsional	Serangkaian atribut yang akan dilampirkan ke pesan Pub/Sub.
`<CloudPubSub>`	Wajib	Elemen induk dari `<Topic>`. Elemen `<Topic>` menentukan topik Pub/Sub tempat Anda ingin memublikasikan pesan.
`<DisplayName>`	Opsional	Nama kustom untuk kebijakan.
`<IgnoreUnresolvedVariables>`	Opsional	Menentukan apakah pemrosesan berhenti jika Apigee menemukan variabel yang belum diselesaikan.
`<Source>`	Opsional	Menentukan pesan yang akan dipublikasikan ke topik Pub/Sub. Elemen ini bersifat opsional, tetapi Anda harus menggunakan `<Source>` atau `<UseMessageAsSource>`.
`<UseMessageAsSource>`	Opsional	Menentukan pesan yang akan dipublikasikan ke topik Pub/Sub. Elemen ini bersifat opsional, tetapi Anda harus menggunakan `<Source>` atau `<UseMessageAsSource>`.
Elemen turunan lainnya
`<Topic>`	Wajib	Elemen turunan dari `<CloudPubSub>`. Menentukan topik Pub/Sub tempat Anda ingin memublikasikan pesan.

Elemen <PublishMessage> menggunakan sintaksis berikut:

Sintaksis

<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>

Contoh - Sumber

Contoh berikut menunjukkan definisi kebijakan <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>

Contoh - UseMessageAsSource

Kebijakan <PublishMessage> ini menentukan elemen UseMessageAsSource:

<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>

Contoh - Atribut

Kebijakan <PublishMessage> ini menentukan elemen Attributes:

<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>

Elemen ini memiliki atribut berikut yang umum untuk semua kebijakan:

Atribut	Default	Wajib?	Deskripsi
`name`	T/A	Wajib	Nama internal kebijakan. Nilai atribut `name` dapat berisi huruf, angka, spasi, tanda hubung, garis bawah, dan titik. Nilai ini tidak boleh melebihi 255 karakter. Secara opsional, gunakan elemen `<DisplayName>` untuk memberi label pada kebijakan di editor proxy UI pengelolaan dengan nama bahasa alami yang berbeda.
`continueOnError`	false	Opsional	Tetapkan ke `false` untuk menampilkan error saat kebijakan gagal. Perilaku ini wajar terjadi untuk sebagian besar kebijakan. Tetapkan ke `true` agar eksekusi alur berlanjut meskipun setelah kebijakan gagal. Lihat juga: Aturan error HANYA dipicu dalam status error (tentang continueOnError) Menangani error dalam alur saat ini
`enabled`	benar	Opsional	Tetapkan ke `true` untuk menerapkan kebijakan. Tetapkan ke `false` untuk menonaktifkan kebijakan. Kebijakan tidak akan diterapkan meskipun tetap terlampir ke alur.
`async`	false	Tidak digunakan lagi	Atribut ini tidak digunakan lagi.

Referensi elemen turunan

Bagian ini menjelaskan elemen turunan <PublishMessage>.

`<Attributes>`

Menentukan atribut yang akan dilampirkan ke pesan Pub/Sub.

Setiap atribut adalah pasangan nilai kunci. Nama yang terkait dengan atribut harus unik. Nilai untuk setiap parameter ditentukan secara dinamis saat runtime melalui template pesan.

Nilai Default	T/A
Wajib?	Wajib
Jenis	String
Elemen Induk	`<PublishMessage>`
Elemen Turunan	Tidak ada

Elemen <Attributes> menggunakan sintaksis berikut:

Sintaksis

  <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>

Contoh 1

Contoh berikut menetapkan satu atribut dengan nilai tetap pada pesan saat dipublikasikan:

<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>

Contoh 2

Contoh berikut menetapkan beberapa atribut pada pesan saat dipublikasikan; nilai beberapa di antaranya ditentukan secara dinamis saat runtime:

<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>`

Gunakan selain atribut name untuk memberi label pada kebijakan di editor proxy UI pengelolaan dengan nama yang berbeda dan lebih terdengar alami.

Elemen <DisplayName> umum untuk semua kebijakan.

Nilai Default	T/A
Wajib?	Opsional. Jika Anda menghilangkan `<DisplayName>`, nilai atribut `name` kebijakan akan digunakan.
Jenis	String
Elemen Induk	<`PolicyElement`>
Elemen Turunan	Tidak ada

Elemen <DisplayName> menggunakan sintaksis berikut:

Sintaks

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

Contoh

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

Elemen <DisplayName> tidak memiliki atribut atau elemen turunan.

`<Source>`

Menentukan pesan yang akan dipublikasikan.

Pesan dapat berupa teks literal, variabel alur, atau kombinasi keduanya dalam bentuk template pesan.

Nilai Default	T/A
Wajib?	Opsional
Jenis	String
Elemen Induk	`<PublishMessage>`
Elemen Turunan	Tidak ada

Elemen <Source> menggunakan sintaksis berikut:

Sintaksis

 <Source>SOURCE</Source>

Example-1

Contoh berikut menetapkan pesan sumber ke nilai variabel alur flow-var-1:

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

Example-2

Contoh berikut menggunakan template pesan untuk memublikasikan pesan JSON dengan konten dinamis:

<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>`

Elemen induk dari <Topic>.

Anda hanya dapat memublikasikan ke satu topik Pub/Sub. Oleh karena itu, Anda hanya dapat memiliki satu elemen <Topic> dalam elemen <CloudPubSub>.

Nilai Default	T/A
Wajib?	Wajib
Jenis	Jenis kompleks
Elemen Induk	`<PublishMessage>`
Elemen Turunan	`<Topic>`

Elemen <CloudPubSub> menggunakan sintaksis berikut:

Sintaksis

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

Contoh

Contoh berikut menunjukkan deklarasi elemen <CloudPubSub>:

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

`<Topic>`

Menentukan topik Pub/Sub tempat Anda ingin memublikasikan pesan <Source>.

Anda harus menentukan nama topik dalam format projects/project-id/topics/topic-name.

Nilai Default	T/A
Wajib?	Wajib
Jenis	String
Elemen Induk	`<CloudPubSub>`
Elemen Turunan	Tidak ada

Elemen <Topic> menggunakan sintaksis berikut:

Sintaksis

<Topic>TOPIC_NAME</Topic>

Contoh

Contoh berikut menentukan topik Pub/Sub yang akan dipublikasikan:

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

Dalam contoh ini, project-id-marketing adalah Project ID Google Cloud Anda dan topic-name-test1 adalah topik tempat pesan harus dipublikasikan.

`<UseMessageAsSource>`

Menentukan pesan yang akan dipublikasikan.

Gunakan ini sebagai alternatif untuk elemen <Source>. Nilainya harus berupa nama variabel alur yang merujuk ke pesan, seperti request, response, atau message. Saat Anda menentukan elemen ini, kebijakan menggunakan konten pesan sebagai pesan yang akan dipublikasikan. Anda harus menggunakan elemen ini, bukan <Source>, saat konten pesan adalah aliran oktet yang tidak dapat direpresentasikan sebagai string, misalnya konten dari file biner.

Nilai Default	T/A
Wajib?	Opsional
Jenis	String
Elemen Induk	`<PublishMessage>`
Elemen Turunan	Tidak ada

Elemen <UseMessageAsSource> menggunakan sintaksis berikut:

Sintaksis

<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>

Example-1

Contoh berikut memberi tahu kebijakan untuk menggunakan konten pesan permintaan sebagai payload untuk pesan Pub/Sub:

<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>`

Menentukan apakah pemrosesan berhenti jika Apigee menemukan variabel yang belum terselesaikan.

Nilai Default	Salah
Wajib?	Opsional
Jenis	Boolean
Elemen Induk	`<PublishMessage>`
Elemen Turunan	Tidak ada

Tetapkan nilai ke true untuk mengabaikan variabel yang belum diselesaikan dan melanjutkan pemrosesan; jika tidak, tetapkan ke false. Nilai defaultnya adalah false.

Menetapkan <IgnoreUnresolvedVariables> ke true berbeda dengan menetapkan continueOnError <PublishMessage> ke true. Jika Anda menetapkan continueOnError ke true, Apigee akan mengabaikan semua error, bukan hanya error dalam variabel.

Elemen <IgnoreUnresolvedVariables> menggunakan sintaksis berikut:

Sintaksis

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

Contoh

Contoh berikut menetapkan <IgnoreUnresolvedVariables> ke true:

<IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>

Variabel alur

Variabel alur adalah objek yang menyimpan data tertentu dan tersedia untuk Anda dalam konteks alur proxy API. Variabel ini menyimpan informasi seperti informasi payload, jalur URL, alamat IP, dan data dari eksekusi kebijakan. Untuk mengetahui informasi selengkapnya tentang variabel alur, lihat Menggunakan variabel alur.

Jika kebijakan PublishMessage berhasil memublikasikan ke topik Pub/Sub, Apigee menetapkan variabel alur publishmessage.message.id ke messageId yang ditampilkan oleh server Pub/Sub. Variabel alur berjenis string, dan variabel tersedia untuk Anda dari alur permintaan Proxy dan seterusnya. Berdasarkan persyaratan Anda, Anda dapat menggunakan variabel alur di kebijakan hilir lainnya. Namun, jika publikasi gagal, Apigee tidak menetapkan variabel publishmessage.message.id, dan mengakses variabel ini akan menyebabkan error.

Untuk mengetahui informasi selengkapnya tentang berbagai jenis variabel alur, lihat Referensi variabel alur.

Kode error

This section describes the fault codes and error messages that are returned and fault variables that are set by Apigee when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults.

Runtime errors

These errors can occur when the policy executes.

Fault code	HTTP status	Cause
`steps.publishmessage.PermissionDeniedError`	`500`	This error occurs when the runtime service account cannot impersonate the proxy service account or the proxy service account does not have the permission to publish to the topic.
`steps.publishmessage.ExecutionError`	`500`	This error occurs if there was an unexpected error while publishing the message to Pub/Sub. You can view the details of the error in the error message.
`steps.publishmessage.MessageVariableNotMessageType`	`500`	This error occurs if the variable name you specified in `UseMessageAsSource` cannot be resolved, or is not a message type.

Fault variables

Whenever there are execution errors in a policy, Apigee generates error messages. You can view these error messages in the error response. Many a time, system generated error messages might not be relevant in the context of your product. You might want to customize the error messages based on the type of error to make the messages more meaningful.

To customize the error messages, you can use either fault rules or the RaiseFault policy. For information about differences between fault rules and the RaiseFault policy, see FaultRules vs. the RaiseFault policy. You must check for conditions using the Condition element in both the fault rules and the RaiseFault policy. Apigee provides fault variables unique to each policy and the values of the fault variables are set when a policy triggers runtime errors. By using these variables, you can check for specific error conditions and take appropriate actions. For more information about checking error conditions, see Building conditions.

Variables	Where	Example
`fault.name`	The `fault.name` can match to any of the faults listed in the Runtime errors table. The fault name is the last part of the fault code.	`fault.name Matches "UnresolvedVariable"`
`publishmessage.POLICY_NAME.failed`	`POLICY_NAME` is the user-specified name of the policy that threw the fault.	`publishmessage.publish-message-1.failed = true`

For more information about policy errors, see What you need to know about policy errors

Kebijakan PublishMessage Tetap teratur dengan koleksi Simpan dan kategorikan konten berdasarkan preferensi Anda.

Deployment autentikasi dan proxy

<PublishMessage>

Sintaksis

Contoh - Sumber

Contoh - UseMessageAsSource

Contoh - Atribut

Referensi elemen turunan

<Attributes>

Sintaksis

Contoh 1

Contoh 2

<DisplayName>

Sintaks

Contoh

<Source>

Sintaksis

Example-1

Example-2

<CloudPubSub>

Sintaksis

Contoh

<Topic>

Sintaksis

Contoh

<UseMessageAsSource>

Sintaksis

Example-1

<IgnoreUnresolvedVariables>

Sintaksis

Contoh

Variabel alur

Kode error

Runtime errors

Fault variables

Kebijakan PublishMessage

`<PublishMessage>`

`<Attributes>`

`<DisplayName>`

`<Source>`

`<CloudPubSub>`

`<Topic>`

`<UseMessageAsSource>`

`<IgnoreUnresolvedVariables>`