TIPCommon.adapters

class TIPCommon.adapters.pubsub.pubsub.PubSubAdapter

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

Basen: object

Adapterklasse zum Verwalten von Pub/Sub-Themen und ‑Abos für das Google Cloud Projekt.

ack

ack(sub_name, ack_ids)

Bestätigt die Nachrichten, die mit dem ackIds in der AcknowledgeRequest-Antwort verknüpft sind, die von PubSubAdapter.pull() zurückgegeben wird.

Parameter
sub_name	str Der Name des Abos.
ack_ids	list[str] Eine Liste der Bestätigungs-IDs für die bestätigten Nachrichten. Die Liste wird vom Pub/Sub-System in der Antwort PubSubAdapter.pull() zurückgegeben.

static build_pubsub_message

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

Erstellt ein PubSubMessage-Objekt.

Parameter
message_content	str Der Inhalt der Nachricht.
encoding	str Der Codierungstyp zum Codieren oder Decodieren des Nachrichtentextes. Der Standardwert ist UTF-8.
ordering_key	str Optional. Wenn der Parameter konfiguriert ist, werden alle zugehörigen Nachrichten identifiziert, die der Veröffentlichungsreihenfolge entsprechen müssen.
**attr	str Optional. Die Attribute, die als Attribute des Nachrichtenobjekts übergeben werden sollen.

Gibt Folgendes zurück:

Ein TIPCommon.adapters.pubsub.PubSubMessage-Objekt.

Rückgabetyp

PubSubMessage

create_subscription

create_subscription(sub_name, topic, **attr)

Erstellt ein Pub/Sub-Abo für das angegebene Thema.

Parameter
sub_name	str Der Name des Abos.
topic	str Ein Pub/Sub-Themaname, für den das Abo erstellt werden soll.
**attr	Zusätzliche Parameter, die an die Aboanfrage übergeben werden sollen.

Gibt Folgendes zurück:

TIPCommon.adapters.pubsub.Subscription-Objekt des erstellten Abos.

Rückgabetyp

Subscription

create_topic

create_topic(topic_name)

Erstellt ein Pub/Sub-Thema in einem Google Cloud -Projekt.

Parameter
topic_name	str Der Name des Themas. Der Name muss den Regeln für Ressourcennamen entsprechen. Google Cloud

Gibt Folgendes zurück:

TIPCommon.adapters.pubsub.Topic-Objekt des erstellten Themas.

Rückgabetyp

Topic

delete_subscription

delete_subscription(sub_name)

Löscht ein Pub/Sub-Abo aus einem Google Cloud -Projekt.

Parameter
sub_name	str Der Name des Abos, das entfernt werden soll.

delete_topic

delete_topic(topic_name)

Löscht ein Pub/Sub-Thema aus einem Google Cloud -Projekt.

Parameter
topic_name	str Das zu entfernende Thema.

static from_credentials

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

Erstellt ein PubSubAdapter-Objekt aus einem google.oauth2.credentials.Credentials-Objekt.

Parameter
credentials	google.oauth2.credentials.Credentials Ein google.oauth2.credentials.Credentials-Objekt.
project_id	Optional. str Die Google Cloud -Projekt-ID. Wenn keine Angabe erfolgt, wird standardmäßig versucht, das im Anmeldedatenobjekt konfigurierte Projekt zu verwenden.
verify_ssl	Optional. bool Gibt an, ob die SSL-Zertifikatsüberprüfung für HTTP-Sitzungen aktiviert ist.
quota_project	Optional. str Das Projekt, das für Kontingent und Abrechnung verwendet werden soll.
logger	Optional. SiemplifyLogger Ein SiemplifyLogger-Objekt.
region	str Die Region, in der Pub/Sub verwendet werden soll.

Gibt Folgendes zurück:

Ein PubSubAdapter-Objekt.

Rückgabetyp

PubSubAdapter

static from_service_account_info

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

Erstellt ein PubSubAdapter-Objekt aus einem service_account-JSON.

Parameter
user_service_account	str Die Google Cloud Dienstkonto-JSON im Textformat.
project_id	Optional. str Die Google Cloud -Projekt-ID. Wenn keine Angabe erfolgt, wird standardmäßig versucht, das im Anmeldedatenobjekt konfigurierte Projekt zu verwenden.
verify_ssl	Optional. bool Gibt an, ob die SSL-Zertifikatsüberprüfung für HTTP-Sitzungen aktiviert ist.
quota_project	Optional. str Das Projekt, das für Kontingent und Abrechnung verwendet werden soll.
logger	Optional. SiemplifyLogger Ein SiemplifyLogger-Objekt.

Gibt Folgendes zurück:

Ein PubSubAdapter-Objekt.

Rückgabetyp

PubSubAdapter

get_subscription

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

Ruft ein Pub/Sub-Abo ab.

Parameter
sub_name	str Der Name des Abos.
topic	str Der Name eines Pub/Sub-Themas, für das ein Abo erstellt werden soll. Erforderlich, wenn create_if_not_exist True ist.
create_if_not_exist	Erstellt das Pub/Sub-Abo in Google Cloud , falls es nicht vorhanden ist.
**attr	Zusätzliche Parameter, die an die Anfrage zur Erstellung des Abos übergeben werden sollen.

Gibt Folgendes zurück:

Das TIPCommon.adapters.pubsub.Subscription-Objekt des abgerufenen Abos.

Rückgabetyp

Subscription

get_topic

get_topic(topic_name, create_if_not_exist=False)

Ruft ein Pub/Sub-Themenobjekt aus dem konfigurierten Google Cloud-Projekt ab.

Parameter
topic_name	str Name des Themas (vereinfacht, ohne das Präfix projects/PROJECT_ID/topics/).
create_if_not_exist	bool Erstellt das Pub/Sub-Thema in Google Cloud , falls es nicht vorhanden ist.

Gibt Folgendes zurück:

Das TIPCommon.adapters.pubsub.Topic-Objekt des empfangenen Themas.

Rückgabetyp

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)

Aktualisiert ein vorhandenes Abo.

Hinweis: Bestimmte Aboattribute können nicht geändert werden.

Parameter
sub_name	str Der Name des Abos.
topic_name	str Der Name des Themas, aus dem das Abo Nachrichten empfängt.
push_config	dict Optional. Konfiguration für einen Push-Zustellungsendpunkt.
bigquery_config	dict Optional. Konfiguration für ein BigQuery-Abo.
cloud_storage_config	dict Optional. Konfiguration für ein Cloud Storage-Abo.
ack_deadline_seconds	int Optional. Die ungefähre Zeit, die Pub/Sub auf die Bestätigung einer empfangenen Nachricht durch den Abonnenten wartet, bevor die Nachricht noch einmal gesendet wird.
retain_acked_messages	bool Optional. Gibt an, ob bestätigte Nachrichten aufbewahrt werden sollen.
retention_duration	str Optional. Die Zeitspanne, in der nicht bestätigte Nachrichten im Backlog des Abos aufbewahrt werden, ab dem Zeitpunkt, an dem eine Nachricht veröffentlicht wird.
labels	dict Optional. Eine Reihe von Schlüssel/Wert-Paaren, mit denen das Abo organisiert wird.
enable_message_ordering	bool Optional. Wenn True, werden Nachrichten, die mit demselben ordering_key in PubsubMessage veröffentlicht wurden, in der Reihenfolge zugestellt, in der sie vom Pub/Sub-System empfangen werden.
expiration_policy	dict Optional. Richtlinie, in der die Bedingungen für den Ablauf dieses Abos festgelegt sind.
query_filter	str Optional. Ein Ausdruck in der Pub/Sub-Filtersprache, der angibt, welche Nachrichten an das Abo gesendet werden.
dead_letter_policy	dict Optional. Eine Richtlinie, die die Bedingungen für das Senden von Nachrichten in diesem Abo an ein Thema für unzustellbare Nachrichten angibt.
return_policy	dict Optional. Richtlinie, in der die Bedingungen für die Rückgabe von Nachrichten festgelegt sind.
detached	bool Optional. Gibt an, ob das Abo vom Thema getrennt wurde.
enable_once_delivery	bool Optional. Wenn True, bietet Pub/Sub die „genau einmalige Zustellung“ für Nachrichten in diesem Abo.

Gibt Folgendes zurück:

Das TIPCommon.adapters.pubsub.Subscription-Objekt des empfangenen Abos.

Rückgabetyp

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)

Aktualisiert ein vorhandenes Thema.

Hinweis :Bestimmte Attributwerte für Themen können nicht geändert werden.

Parameter
topic_name	str Der Name des Themas.
labels	dict Optional. Eine Reihe von Schlüssel/Wert-Paaren zum Organisieren des Themas.
message_storage_policy	dict Optional. Richtlinie, die die Regionen einschränkt, in denen Nachrichten im Ruhezustand gespeichert werden.
kms_key_name	str Optional. Der Ressourcenname des Cloud Key Management Service-CryptoKey, der zum Schutz von Nachrichten verwendet wird, die in diesem Thema veröffentlicht werden.
schema_settings	dict Optional. Einstellungen zum Validieren von Nachrichten, die anhand eines Schemas veröffentlicht werden.
satisfies_pzs	bool Optional. Reserviert für zukünftige Verwendungen. Dieses Feld wird auf True gesetzt, wenn das Thema die physische Zonentrennung erfüllt.
retention_duration	str Optional. Die Zeitspanne, in der eine veröffentlichte Nachricht im Thema aufbewahrt wird. Wenn die Nachricht konfiguriert ist, wird sie für diesen Zeitraum aufbewahrt, unabhängig von Abo-Konfigurationen.

Gibt Folgendes zurück:

Das TIPCommon.adapters.pubsub.Topic-Objekt des empfangenen Themas.

Rückgabetyp

Topic

publish

publish(topic_name, messages)

Veröffentlicht eine Liste von PubSubMessage-Objekten in einem Thema.

Parameter
topic_name	str Der Name des Zielthemas für die Veröffentlichung der Nachricht.
messages	list Eine Liste mit PubSubMessage-Objekten. Die statische Methode PubSubAdapter.build_message() wird verwendet, um diese Objekte zu erstellen.

Gibt Folgendes zurück:

Eine Liste der Nachrichten-IDs.

Rückgabetyp

list[str]

pull

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

Ruft Nachrichten aus Pub/Sub-Abos ab.

Parameter
sub_name	str Der Name des Abos.
limit	int Die maximale Anzahl von Nachrichten, die für diese Anfrage zurückgegeben werden sollen.
timeout	int Das HTTP-Anfrage-Zeitlimit in Sekunden. Der Standardwert ist 60.
encoding	str Eine Pub/Sub-Nachrichtencodierung. Der Standardwert ist utf-8.

Gibt Folgendes zurück:

Eine Liste mit TIPCommon.adapters.pubsub.ReceivedMessage-Objekten.

Rückgabetyp

ReceivedMessage

statisch subscription_name

static subscription_name(project_id, sub_name)

Ruft den vollständigen Abonnennamen im folgenden Format ab: projects/project_id/topics/topic_name.

Parameter
project_id	str Der Projektname, der die Ressource enthält.
sub_name	str Name eines Pub/Sub-Abos.

Gibt Folgendes zurück:

Der vollständige Aboname im folgenden Format: projects/project_id/topics/topic_name.

Rückgabetyp

str

static topic_name

static topic_name(project_id, topic)

Ruft einen vollständigen Themennamen im folgenden Format ab: projects/project_id/topics/topic_name.

Parameter
project_id	str Der Projektname, der die Ressource enthält.
topic	str Ein Pub/Sub-Themenname.

Gibt Folgendes zurück:

Ein vollständiger Themenname: projects/project_id/topics/topic_name.

Rückgabetyp

str

Benötigen Sie weitere Hilfe? Antworten von Community-Mitgliedern und Google SecOps-Experten erhalten