TIPCommon.adapters

class TIPCommon.adapters.pubsub.pubsub.PubSubAdapter

class TIPCommon.adapters.pubsub.pubsub.PubSubAdapter(session, project_id=None, logger=None, region=None)

Basis: object

Class adapter untuk mengelola topik dan langganan Pub/Sub project Google Cloud .

ack

ack(sub_name, ack_ids)

Mengonfirmasi pesan yang terkait dengan ackIds dalam respons AcknowledgeRequest yang ditampilkan dari PubSubAdapter.pull().

Parameter
sub_name str

Nama langganan.
ack_ids list[str]

Daftar ID konfirmasi untuk pesan yang dikonfirmasi. Daftar ini ditampilkan oleh sistem Pub/Sub dalam respons PubSubAdapter.pull().

static build_pubsub_message

statis build_pubsub_message(message_content, encoding='utf-8', ordering_key=None, **attr)

Membuat objek PubSubMessage.

Parameter
message_content str

Konten pesan.
encoding str

Jenis encoding untuk mengenkode atau mendekode teks pesan.

Nilai defaultnya adalah UTF-8.
ordering_key str

Opsional.

Jika dikonfigurasi, parameter ini mengidentifikasi semua pesan terkait yang harus mengikuti urutan publikasi.
**attr str

Opsional.

Atribut yang akan diteruskan sebagai atribut objek pesan.

Hasil

Objek TIPCommon.adapters.pubsub.PubSubMessage.

Jenis hasil yang ditampilkan

PubSubMessage

create_subscription

create_subscription(sub_name, topic, **attr)

Membuat langganan Pub/Sub untuk topik yang ditentukan.

Parameter
sub_name str

Nama langganan.
topic str

Nama topik Pub/Sub untuk membuat langganan.
**attr Parameter tambahan yang akan diteruskan ke permintaan langganan.

Hasil

Objek TIPCommon.adapters.pubsub.Subscription langganan yang dibuat.

Jenis hasil yang ditampilkan

Subscription

create_topic

create_topic(topic_name)

Membuat topik Pub/Sub di project Google Cloud .

Parameter
topic_name str

Nama topik.

Nama harus sesuai dengan Google Cloud aturan nama resource.

Hasil

Objek TIPCommon.adapters.pubsub.Topic dari topik yang dibuat.

Jenis hasil yang ditampilkan

Topic

delete_subscription

delete_subscription(sub_name)

Menghapus langganan Pub/Sub dari project Google Cloud .

Parameter
sub_name str

Nama langganan yang akan dihapus.

delete_topic

delete_topic(topic_name)

Menghapus topik Pub/Sub dari Google Cloud project.

Parameter
topic_name str

Topik yang akan dihapus.

static from_credentials

statis from_credentials(credentials, project_id=None, verify_ssl=True, quota_project=None, logger=None, region=None)

Membuat objek PubSubAdapter dari objek google.oauth2.credentials.Credentials.

Parameter
credentials google.oauth2.credentials.Credentials

Objek google.oauth2.credentials.Credentials.
project_id Opsional.

str

Google Cloud Project ID.

Jika tidak diberikan, fungsi akan mencoba menggunakan project yang dikonfigurasi dalam objek kredensial secara default.
verify_ssl Opsional.

bool

Menentukan apakah verifikasi sertifikat SSL diaktifkan untuk sesi HTTP.
quota_project Opsional.

str

Project yang akan digunakan untuk kuota dan penagihan.
logger Opsional.

SiemplifyLogger

Objek SiemplifyLogger.
region str

Region tempat Pub/Sub akan beroperasi.

Hasil

Objek PubSubAdapter.

Jenis hasil yang ditampilkan

PubSubAdapter

static from_service_account_info

statis subscription_name(user_service_account, project_id=None, verify_ssl=True, quota_project=None, logger=None)

Membuat objek PubSubAdapter dari JSON service_account.

Parameter
user_service_account str

Google Cloud JSON Akun Layanan dalam format teks.
project_id Opsional.

str

Google Cloud Project ID.

Jika tidak diberikan, fungsi akan mencoba menggunakan project yang dikonfigurasi dalam objek kredensial secara default.
verify_ssl Opsional.

bool

Menentukan apakah verifikasi sertifikat SSL diaktifkan untuk sesi HTTP.
quota_project Opsional.

str

Project yang akan digunakan untuk kuota dan penagihan.
logger Opsional.

SiemplifyLogger

Objek SiemplifyLogger.

Hasil

Objek PubSubAdapter.

Jenis hasil yang ditampilkan

PubSubAdapter

get_subscription

get_subscription(sub_name, topic=None, create_if_not_exist=False, **attr)

Mengambil langganan Pub/Sub.

Parameter
sub_name str

Nama langganan.
topic str

Nama topik Pub/Sub untuk membuat langganan.

Wajib jika create_if_not_exist adalah True.
create_if_not_exist Membuat langganan Pub/Sub di Google Cloud jika belum ada.
**attr Parameter tambahan yang akan diteruskan ke permintaan pembuatan langganan.

Hasil

Objek TIPCommon.adapters.pubsub.Subscription langganan yang diambil.

Jenis hasil yang ditampilkan

Subscription

get_topic

get_topic(topic_name, create_if_not_exist=False)

Mengambil objek topik Pub/Sub dari project Google Cloud yang dikonfigurasi.

Parameter
topic_name str

Nama topik (disederhanakan, tanpa awalan projects/PROJECT_ID/topics/).
create_if_not_exist bool

Membuat topik Pub/Sub di Google Cloud jika belum ada.

Hasil

Objek TIPCommon.adapters.pubsub.Topic dari topik yang diterima.

Jenis hasil yang ditampilkan

Topic

patch_subscription

patch_subscription(sub_name, topic_name, push_config=None, bigquery_config=None, cloud_storage_config=None, ack_deadline_seconds=None, retain_acked_messages=None, retention_duration=None, labels=None, enable_message_ordering=None, expiration_policy=None, query_filter=None, dead_letter_policy=None, return_policy=None, detached=None, enable_once_delivery=None)

Memperbarui langganan yang sudah ada.

Parameter
sub_name str

Nama langganan.
topic_name str

Nama topik tempat langganan menerima pesan.
push_config dict

Opsional. Konfigurasi untuk endpoint pengiriman push.
bigquery_config dict

Opsional. Konfigurasi untuk langganan BigQuery.
cloud_storage_config dict

Opsional. Konfigurasi untuk langganan Cloud Storage.
ack_deadline_seconds int

Opsional. Perkiraan jangka waktu Pub/Sub menunggu konfirmasi penerimaan pesan dari pelanggan sebelum pesan dikirim ulang.
retain_acked_messages bool

Opsional. Menunjukkan apakah pesan yang dikonfirmasi harus dipertahankan.
retention_duration str

Opsional. Jumlah waktu untuk mempertahankan pesan yang tidak dikonfirmasi dalam backlog langganan, sejak pesan dipublikasikan.
labels dict

Opsional. Kumpulan key-value pair yang digunakan untuk mengatur langganan.
enable_message_ordering bool

Opsional. Jika True, pesan yang dipublikasikan dengan ordering_key yang sama di PubsubMessage akan dikirimkan sesuai urutan saat diterima oleh sistem Pub/Sub.
expiration_policy dict

Opsional. Kebijakan yang menentukan kondisi untuk masa berlaku langganan ini.
query_filter str

Opsional. Ekspresi yang ditulis dalam bahasa filter Pub/Sub yang menentukan pesan mana yang dikirimkan ke langganan.
dead_letter_policy dict

Opsional. Kebijakan yang menentukan kondisi untuk pesan yang tidak terkirim dalam langganan ini.
return_policy dict

Opsional. Kebijakan yang menentukan kondisi untuk menampilkan pesan.
detached bool

Opsional. Menunjukkan apakah langganan dilepaskan dari topik.
enable_once_delivery bool

Opsional. Jika True, Pub/Sub menyediakan "pengiriman tepat sekali" untuk pesan dalam langganan ini.

Hasil

Objek TIPCommon.adapters.pubsub.Subscription langganan yang diterima.

Jenis hasil yang ditampilkan

Subscription

patch_topic

patch_topic(topic_name, labels=None, message_storage_policy=None, kms_key_name=None, schema_settings=None, satisfies_pzs=None, retention_duration=None)

Memperbarui topik yang ada.

Parameter
topic_name str

Nama topik.
labels dict

Opsional. Kumpulan pasangan nilai kunci yang digunakan untuk mengatur topik.
message_storage_policy dict

Opsional. Kebijakan yang membatasi region tempat pesan disimpan dalam penyimpanan.
kms_key_name str

Opsional. Nama resource CryptoKey Cloud Key Management Service yang akan digunakan untuk melindungi pesan yang dipublikasikan ke topik ini.
schema_settings dict

Opsional. Setelan untuk memvalidasi pesan yang dipublikasikan terhadap skema.
satisfies_pzs bool

Opsional. Dipesan untuk penggunaan di masa mendatang. Kolom ini ditetapkan ke True jika topik memenuhi pemisahan zona fisik.
retention_duration str

Opsional. Jumlah waktu pesan yang dipublikasikan dipertahankan oleh topik. Jika dikonfigurasi, pesan akan dipertahankan selama durasi ini, terlepas dari konfigurasi langganan apa pun.

Hasil

Objek TIPCommon.adapters.pubsub.Topic dari topik yang diterima.

Jenis hasil yang ditampilkan

Topic

publish

publish(topic_name, messages)

Memublikasikan daftar objek PubSubMessage ke topik.

Parameter
topic_name str

Nama topik target untuk publikasi pesan.
messages list

Daftar yang berisi objek PubSubMessage.

Metode statis PubSubAdapter.build_message() digunakan untuk membuat objek ini.

Hasil

Daftar ID pesan.

Jenis hasil yang ditampilkan

list[str]

pull

pull(sub_name, limit, timeout=60, encoding='utf-8')

Menarik pesan dari langganan Pub/Sub.

Parameter
sub_name str

Nama langganan.
limit int

Jumlah maksimum pesan yang akan ditampilkan untuk permintaan ini.
timeout int

Waktu tunggu permintaan HTTP, dalam detik.

Nilai defaultnya adalah 60.
encoding str

Encoding pesan Pub/Sub.

Nilai defaultnya adalah utf-8.

Hasil

Daftar objek TIPCommon.adapters.pubsub.ReceivedMessage.

Jenis hasil yang ditampilkan

ReceivedMessage

static subscription_name

statis subscription_name(project_id, sub_name)

Mengambil nama langganan lengkap dalam format berikut: projects/project_id/topics/topic_name.

Parameter
project_id str

Nama project yang berisi resource.
sub_name str

Nama langganan Pub/Sub.

Hasil

Nama langganan lengkap dalam format berikut: projects/project_id/topics/topic_name.

Jenis hasil yang ditampilkan

str

static topic_name

statis topic_name(project_id, topic)

Mengambil nama topik lengkap dalam format berikut: projects/project_id/topics/topic_name.

Parameter
project_id str

Nama project yang berisi resource.
topic str

Nama topik Pub/Sub.

Hasil

Nama topik lengkap: projects/project_id/topics/topic_name.

Jenis hasil yang ditampilkan

str

Perlu bantuan lain? Dapatkan jawaban dari anggota Komunitas dan profesional Google SecOps.