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	Opsional (str) Jika digunakan, parameter ini mengidentifikasi semua pesan terkait yang harus mengikuti urutan publikasi.
**attr	Opsional (str) 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 penamaan 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(project_id, sub_name)

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 topik tersebut belum ada.

Hasil

Objek TIPCommon.adapters.pubsub.Topic 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.

Catatan: Properti langganan tertentu tidak dapat diubah.

Parameter
sub_name	(str) Nama langganan.
topic_name	(str) Nama topik tempat langganan ini menerima pesan.

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.

Catatan: Properti topik tertentu tidak dapat diubah.

Parameter
topic_name	(str) Nama topik.

Hasil

Objek TIPCommon.adapters.pubsub.Topic 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 untuk memublikasikan pesan.
messages	list Daftar objek PubSubMessage. Anda dapat membuat daftar dengan metode statis PubSubAdapter.build_message().

Hasil

Daftar ID pesan.

Jenis hasil yang ditampilkan

list[str]

pull

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

Tarik 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. Defaultnya adalah 60 detik.
encoding	(str) Encoding pesan Pub/Sub. Default-nya adalah utf-8.

Hasil

Daftar objek TIPCommon.adapters.pubsub.ReceivedMessage.

Jenis hasil yang ditampilkan

list[ReceivedMessage]

static subscription_name

statis subscription_name(project_id, sub_name)

Mengambil nama langganan lengkap dalam format berikut: projects/project_id/subscriptions/subscription_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/subscriptions/subscription_name.

Jenis hasil yang ditampilkan

str

static topic_name

statis topic_name(project_id, topic)

Mengambil 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

class TIPCommon.adapters.pubsub.data_models.PubSubMessage

class TIPCommon.adapters.pubsub.data_models.PubSubMessage(raw_data: 'dict', data: 'str' = None, attributes: 'dict' = None, message_id: 'str' = None, publish_time: 'int' = None, ordering_key: 'str' = None)

Dasar: object

attributes: dict= None

data: str= None

json()

message_id: str= None

ordering_key: str= None

publish_time: int= None

raw_data: dict

class TIPCommon.adapters.pubsub.data_models.ReceivedMessage

class TIPCommon.adapters.pubsub.data_models.ReceivedMessage(raw_data: 'dict', ack_id: 'str', message: 'PubSubMessage', delivery_attempt: 'int')

Dasar: object

ack_id: str

delivery_attempt: int

json()

message: PubSubMessage

raw_data: dict

class TIPCommon.adapters.pubsub.data_models.SchemaSettings

class TIPCommon.adapters.pubsub.data_models.SchemaSettings(raw_data: 'dict', schema: 'str', encoding: 'str' = None, first_revision_id: 'str' = None, last_revision_id: 'str' = None)

Dasar: object

encoding: str= None

first_revision_id: str= None

json()

last_revision_id: str= None

raw_data: dict

schema: str

class TIPCommon.adapters.pubsub.data_models.Subscription

class TIPCommon.adapters.pubsub.data_models.Subscription(raw_data: 'dict', name: 'str', identifier: 'str', topic_identifier: 'str', state: 'str', ack_deadline_secs: 'int' = None, retain_ack_messages: 'bool' = None, message_retention_duration: 'int' = None, labels: 'dict' = None, message_ordering: 'bool' = None, query_filter: 'str' = None, topic_message_retention_duration: 'int' = None)

Dasar: object

ack_deadline_secs: int= None

identifier: str

json()

labels: dict= None

message_ordering: bool= None

message_retention_duration: int= None

name: str

query_filter: str= None

raw_data: dict

retain_ack_messages: bool= None

state: str

topic_identifier: str

topic_message_retention_duration: int= None

class TIPCommon.adapters.pubsub.data_models.Topic

class TIPCommon.adapters.pubsub.data_models.Topic(raw_data: 'dict', name: 'str', identifier: 'str', labels: 'dict' = None, schema_settings: 'SchemaSettings' = None, message_retention_duration: 'int' = None)

Dasar: object

identifier: str

json()

labels: dict= None

message_retention_duration: int= None

name: str

raw_data: dict

schema_settings: SchemaSettings= None

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