Diese Seite wurde von der Cloud Translation API übersetzt.

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`	Optional (`str`) Wenn dieser Parameter verwendet wird, werden alle zugehörigen Nachrichten identifiziert, die der Veröffentlichungsreihenfolge folgen müssen.
`**attr`	Optional (`str`) Die Attribute, die als Attribute des Nachrichtenobjekts übergeben werden sollen.

Gibt Folgendes zurück:

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 Google Cloud Regeln für Ressourcennamen entsprechen.

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(project_id, sub_name)

Erstellt ein PubSubAdapter-Objekt aus 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:

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:

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.

Parameter
`sub_name`	(`str`) Der Name des Abos.
`topic_name`	(`str`) Der Name des Themas, aus dem dieses Abo Nachrichten empfängt.

Gibt Folgendes zurück:

TIPCommon.adapters.pubsub.Subscription-Objekt des erhaltenen 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.

Parameter
`topic_name`	(`str`) Der Name des Themas.

Gibt Folgendes zurück:

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

Rückgabetyp

Topic

publish

publish(topic_name, messages)

Eine Liste von PubSubMessage-Objekten in einem Thema veröffentlichen.

Parameter

Parameter
`topic_name`	(`str`) Der Name des Themas, in dem die Nachrichten veröffentlicht werden sollen.
`messages`	`list` Eine Liste von PubSubMessage-Objekten. Sie können die Liste mit der statischen Methode `PubSubAdapter.build_message()` erstellen.

topic_name

(str)

Der Name des Themas, in dem die Nachrichten veröffentlicht werden sollen.

messages

list

Eine Liste von PubSubMessage-Objekten.

Sie können die Liste mit der statischen Methode PubSubAdapter.build_message() erstellen.

Gibt Folgendes zurück:

Liste der Nachrichten-IDs.

Rückgabetyp

list[str]

pull

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

Nachrichten aus Pub/Sub-Abos abrufen

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` HTTP-Anfrage-Zeitlimit in Sekunden. Der Standardwert beträgt 60 Sekunden.
`encoding`	(`str`) Eine Pub/Sub-Nachrichtencodierung. Der Standardwert ist `utf-8`.

Gibt Folgendes zurück:

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

Rückgabetyp

list[ReceivedMessage]

statisch subscription_name

static subscription_name(project_id, sub_name)

Ruft den vollständigen Abostatus im folgenden Format ab: projects/project_id/subscriptions/subscription_name.

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

Gibt Folgendes zurück:

Ein vollständiger Aboname im folgenden Format: projects/project_id/subscriptions/subscription_name.

Rückgabetyp

str

static topic_name

static topic_name(project_id, topic)

Ruft projects/project_id/topics/topic_name ab.

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

Gibt Folgendes zurück:

Vollständiger Themenname: projects/project_id/topics/topic_name.

Rückgabetyp

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)

Basiert auf: 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')

Basiert auf: 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)

Basiert auf: 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)

Basiert auf: 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)

Basiert auf: object

identifier: str

json()

labels: dict= None

message_retention_duration: int= None

name: str

raw_data: dict

schema_settings: SchemaSettings= None

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