ส่วนขยาย Google Cloud Pub/Sub

คุณกำลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ Apigee X info

เวอร์ชัน: 2.0.2

เผยแพร่ข้อความไปยังหัวข้อในบริการ Google Cloud Pub/Sub

เนื้อหานี้เป็นข้อมูลอ้างอิงสำหรับการกำหนดค่าและการใช้ส่วนขยายนี้

ข้อกำหนดเบื้องต้น

ก่อนใช้ส่วนขยายจากพร็อกซี API โดยใช้นโยบาย ExtensionCallout คุณต้องทำดังนี้

สร้างหัวข้อ Cloud Pub/Sub ตามที่อธิบายไว้ในการเริ่มต้นอย่างรวดเร็ว: การใช้คอนโซล
เมื่อมีหัวข้อแล้ว ให้ให้สิทธิ์ในการเผยแพร่ไปยังหัวข้อ Cloud Pub/Sub เช่น คุณสามารถใช้บทบาท roles/pubsub.publisher เพื่อเผยแพร่ไปยังหัวข้อต่างๆ ได้ ดูข้อมูลเพิ่มเติมเกี่ยวกับบทบาทของ Cloud Pub/Sub ได้ที่การควบคุมการเข้าถึง
ใช้ Google Cloud Console เพื่อสร้างคีย์สำหรับบัญชีบริการ
ใช้เนื้อหาของไฟล์ JSON คีย์ที่ได้เมื่อเพิ่มและกำหนดค่าส่วนขยายโดยใช้ข้อมูลอ้างอิงการกำหนดค่า

เกี่ยวกับ Cloud Pub/Sub

Cloud Pub/Sub มีการรับส่งข้อความแบบไม่พร้อมกันแบบหลายต่อหลายข้อความที่แยกผู้ส่งและผู้รับออกจากกัน Cloud Pub/Sub ส่งข้อความที่คงทนและมีเวลาในการตอบสนองต่ำ ซึ่งช่วยให้นักพัฒนาซอฟต์แวร์ผสานรวมระบบที่โฮสต์ใน Google Cloud และภายนอกได้อย่างรวดเร็ว

หากเพิ่งเริ่มต้นใช้งาน Cloud Pub/Sub โปรดดูการเริ่มต้นใช้งานฉบับย่อในเอกสารประกอบของ Cloud Pub/Sub

ตัวอย่าง

ตัวอย่างต่อไปนี้แสดงวิธีกำหนดค่าการรองรับการดำเนินการของส่วนขยาย Cloud Pub/Sub โดยใช้นโยบาย ExtensionCallout

ข้อความ

ในตัวอย่างนี้ publish การดำเนินการจะเผยแพร่ข้อความเป็นสตริงไปยังหัวข้อที่ระบุไว้ในการกำหนดค่าของส่วนขยาย publish การดำเนินการจะแสดงรหัสของข้อความที่เผยแพร่ในหัวข้อที่เผยแพร่ และเขียนลงในตัวแปรที่ระบุโดยแท็ก <Output>

<?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</Output>
</ConnectorCallout>

นโยบายกำหนดข้อความต่อไปนี้ใช้ค่าของตัวแปรที่จัดเก็บการตอบกลับของส่วนขยายเพื่อกำหนดเพย์โหลดการตอบกลับ ระบบจะจัดเก็บรหัสข้อความไว้ในพร็อพเพอร์ตี้ messageId ของตัวแปรเอาต์พุต

<?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.messageId}</Payload>
    </Set>
</AssignMessage>

ระบบจะแสดงข้อมูลการตอบกลับเป็น JSON ดังนี้

{"messageId":"165918654986954"}

ดังนั้น ค่าของ topic.message.messageId คือ 165918654986954

ข้อความ JSON

ในตัวอย่างนี้ publish การดำเนินการจะเผยแพร่ข้อความเป็น JSON ไปยังหัวข้อที่ระบุไว้ในการกำหนดค่าของส่วนขยาย publish การดำเนินการจะแสดงรหัสของข้อความที่เผยแพร่ในหัวข้อที่เผยแพร่ และเขียนลงในตัวแปรที่ระบุโดยแท็ก <Output>

<?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" : { "info" : "My test message" }
      }
    ]]></Input>
    <Output>topic.message</Output>
</ConnectorCallout>

<?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.messageId}</Payload>
    </Set>
</AssignMessage>

ระบบจะแสดงข้อมูลการตอบกลับเป็น JSON ดังนี้

{"messageId":"165918654986954"}

ดังนั้น ค่าของ topic.message.messageId คือ 165918654986954

การดำเนินการ

เผยแพร่

เผยแพร่ข้อความไปยังหัวข้อที่ระบุไว้ในการกำหนดค่าของส่วนขยายนี้

ไวยากรณ์

<Action>publish</Action>
<Input><![CDATA[{
  "message" : "message-to-publish" | JSON-structured-data,
  "customAttributes": JSON-array
}]]></Input>

ตัวอย่างสตริง

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

ตัวอย่าง Structured Data JSON

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

ตัวอย่างแอตทริบิวต์ที่กำหนดเอง

<Action>publish</Action>
<Input><![CDATA[
  {
      "message" : { "info" : "My test message" },
      "customAttributes": {"attr1": "foo", "attr2": "bar"}
  }
]]></Input>

พารามิเตอร์คำขอ

พารามิเตอร์	คำอธิบาย	ประเภท	ค่าเริ่มต้น	ต้องระบุ
ข้อความ	ข้อความที่จะเผยแพร่ คุณจะใช้สตริงหรือจัดโครงสร้างข้อความด้วย JSON ที่ออกแบบเองก็ได้	สตริงหรือ JSON	ไม่มี	ใช่
customAttributes	แอตทริบิวต์ที่กำหนดเองที่จะเพิ่มลงในข้อความในแบบฟอร์ม `"customAttributes": {"attr1": "foo", "attr2": "bar"}`	อาร์เรย์ JSON	ไม่มี	ไม่

การตอบกลับ

JSON ที่มีรหัสของข้อความตามที่เผยแพร่ไปยังหัวข้อ เช่น

{"messageId":"165918654986954"}

ข้อมูลอ้างอิงการกำหนดค่า

ใช้ข้อมูลต่อไปนี้เมื่อกำหนดค่าและติดตั้งใช้งานส่วนขยายนี้เพื่อใช้ในพร็อกซี API

คุณสมบัติส่วนขยายทั่วไป

พร็อพเพอร์ตี้ต่อไปนี้มีอยู่ในส่วนขยายทุกรายการ

พร็อพเพอร์ตี้	คำอธิบาย	ค่าเริ่มต้น	ต้องระบุ
`name`	ชื่อที่คุณกําหนดให้การกําหนดค่านี้ของส่วนขยาย	ไม่มี	ได้
`packageName`	ชื่อแพ็กเกจส่วนขยายที่ระบุโดย Apigee Edge	ไม่มี	ได้
`version`	หมายเลขเวอร์ชันของแพ็กเกจส่วนขยายที่คุณกําหนดค่าส่วนขยาย	ไม่มี	ได้
`configuration`	ค่าการกําหนดค่าเฉพาะสําหรับส่วนขยายที่คุณกําลังเพิ่ม ดูพร็อพเพอร์ตี้สําหรับแพ็กเกจส่วนขยายนี้	ไม่มี	ได้

พร็อพเพอร์ตี้สำหรับแพ็กเกจส่วนขยายนี้

พร็อพเพอร์ตี้	คำอธิบาย	ค่าเริ่มต้น	ต้องระบุ
`topic`	หัวข้อที่จะเผยแพร่ รับค่านี้จากบริการ Pub/Sub เช่น จากคอนโซล Google Cloud สำหรับบริการ เช่น ชื่อหัวข้ออาจมีรูปแบบเป็น `projects/GCP-PROJECT-ID/topics/TOPIC-NAME`	ไม่มี	ได้
`credentials`	เมื่อป้อนในคอนโซล Apigee Edge นี่คือเนื้อหาของไฟล์คีย์บัญชีบริการ เมื่อส่งโดยใช้ Management API ค่าจะเป็นค่าที่เข้ารหัส Base64 ซึ่งสร้างจากไฟล์คีย์บัญชีบริการ	ไม่มี	ได้