TIPCommon.adapters

class TIPCommon.adapters.pubsub.pubsub.PubSubAdapter

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

Basi: object

Classe adattatore per la gestione di argomenti e sottoscrizioni Pub/Sub del progetto. Google Cloud

ack

ack(sub_name, ack_ids)

Riconosce i messaggi associati a ackIds nella risposta AcknowledgeRequest restituita da PubSubAdapter.pull().

Parametri
sub_name	str Il nome dell'abbonamento.
ack_ids	list[str] Un elenco di ID di conferma per i messaggi confermati. L'elenco viene restituito dal sistema Pub/Sub nella risposta PubSubAdapter.pull().

static build_pubsub_message

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

Crea un oggetto PubSubMessage.

Parametri
message_content	str Il contenuto del messaggio.
encoding	str Il tipo di codifica per codificare o decodificare il testo del messaggio. Il valore predefinito è UTF-8.
ordering_key	str Facoltativo. Se configurato, il parametro identifica tutti i messaggi correlati che devono seguire l'ordine di pubblicazione.
**attr	str Facoltativo. Gli attributi da passare come attributi dell'oggetto messaggio.

Restituisce

Un oggetto TIPCommon.adapters.pubsub.PubSubMessage.

Tipo restituito

PubSubMessage

create_subscription

create_subscription(sub_name, topic, **attr)

Crea una sottoscrizione Pub/Sub per l'argomento specificato.

Parametri
sub_name	str Il nome dell'abbonamento.
topic	str Un nome di argomento Pub/Sub per creare la sottoscrizione.
**attr	Parametri aggiuntivi da trasmettere alla richiesta di abbonamento.

Restituisce

Oggetto TIPCommon.adapters.pubsub.Subscription dell'abbonamento creato.

Tipo restituito

Subscription

create_topic

create_topic(topic_name)

Crea un argomento Pub/Sub in un progetto Google Cloud .

Parametri
topic_name	str Il nome dell'argomento. Il nome deve corrispondere alle regole di denominazione delle risorse. Google Cloud

Restituisce

Oggetto TIPCommon.adapters.pubsub.Topic dell'argomento creato.

Tipo restituito

Topic

delete_subscription

delete_subscription(sub_name)

Elimina una sottoscrizione Pub/Sub da un progetto Google Cloud .

Parametri
sub_name	str Il nome dell'abbonamento da rimuovere.

delete_topic

delete_topic(topic_name)

Elimina un argomento Pub/Sub da un progetto Google Cloud .

Parametri
topic_name	str L'argomento da rimuovere.

static from_credentials

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

Crea un oggetto PubSubAdapter da un oggetto google.oauth2.credentials.Credentials.

Parametri
credentials	google.oauth2.credentials.Credentials Un oggetto google.oauth2.credentials.Credentials.
project_id	Facoltativo. str L'ID progetto Google Cloud . Se non viene fornito, la funzione tenta di utilizzare per impostazione predefinita il progetto configurato nell'oggetto delle credenziali.
verify_ssl	Facoltativo. bool Specifica se la verifica del certificato SSL è abilitata per le sessioni HTTP.
quota_project	Facoltativo. str Il progetto da utilizzare per la quota e la fatturazione.
logger	Facoltativo. SiemplifyLogger Un oggetto SiemplifyLogger.
region	str La regione in cui deve operare Pub/Sub.

Restituisce

Un oggetto PubSubAdapter.

Tipo restituito

PubSubAdapter

static from_service_account_info

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

Crea un oggetto PubSubAdapter da un file JSON service_account.

Parametri
user_service_account	str Il Google Cloud file JSON dell'account di servizio in formato di testo.
project_id	Facoltativo. str L'ID progetto Google Cloud . Se non viene fornito, la funzione tenta di utilizzare per impostazione predefinita il progetto configurato nell'oggetto delle credenziali.
verify_ssl	Facoltativo. bool Specifica se la verifica del certificato SSL è abilitata per le sessioni HTTP.
quota_project	Facoltativo. str Il progetto da utilizzare per la quota e la fatturazione.
logger	Facoltativo. SiemplifyLogger Un oggetto SiemplifyLogger.

Restituisce

Un oggetto PubSubAdapter.

Tipo restituito

PubSubAdapter

get_subscription

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

Recupera una sottoscrizione Pub/Sub.

Parametri
sub_name	str Il nome dell'abbonamento.
topic	str Un nome di argomento Pub/Sub per creare una sottoscrizione. Obbligatorio se create_if_not_exist è True.
create_if_not_exist	Crea la sottoscrizione Pub/Sub in Google Cloud se non esiste.
**attr	Parametri aggiuntivi da passare alla richiesta di creazione dell'abbonamento.

Restituisce

L'oggetto TIPCommon.adapters.pubsub.Subscription dell'abbonamento recuperato.

Tipo restituito

Subscription

get_topic

get_topic(topic_name, create_if_not_exist=False)

Recupera un oggetto argomento Pub/Sub dal progetto Google Cloudconfigurato.

Parametri
topic_name	str Nome dell'argomento (semplificato, senza il prefisso projects/PROJECT_ID/topics/).
create_if_not_exist	bool Crea l'argomento Pub/Sub in Google Cloud se non esiste.

Restituisce

L'oggetto TIPCommon.adapters.pubsub.Topic dell'argomento ricevuto.

Tipo restituito

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)

Aggiorna un abbonamento esistente.

Nota: alcune proprietà dell'abbonamento non sono modificabili.

Parametri
sub_name	str Il nome dell'abbonamento.
topic_name	str Il nome dell'argomento da cui la sottoscrizione riceve i messaggi.
push_config	dict Facoltativo. Configurazione per un endpoint di pubblicazione push.
bigquery_config	dict Facoltativo. Configurazione per una sottoscrizione BigQuery.
cloud_storage_config	dict Facoltativo. Configurazione di una sottoscrizione Cloud Storage.
ack_deadline_seconds	int Facoltativo. Il periodo di tempo approssimativo durante il quale Pub/Sub attende la conferma di ricezione di un messaggio da parte del sottoscrittore prima che il messaggio venga nuovamente inviato.
retain_acked_messages	bool Facoltativo. Indica se conservare i messaggi confermati.
retention_duration	str Facoltativo. Il periodo di tempo per conservare i messaggi non confermati nel backlog della sottoscrizione, dal momento della pubblicazione di un messaggio.
labels	dict Facoltativo. Un insieme di coppie chiave-valore utilizzate per organizzare l'abbonamento.
enable_message_ordering	bool Facoltativo. Se True, i messaggi pubblicati con lo stesso ordering_key in PubsubMessage vengono consegnati nell'ordine in cui vengono ricevuti dal sistema Pub/Sub.
expiration_policy	dict Facoltativo. Norme che specificano le condizioni per la scadenza di questo abbonamento.
query_filter	str Facoltativo. Un'espressione scritta nel linguaggio di filtro Pub/Sub che specifica quali messaggi vengono recapitati alla sottoscrizione.
dead_letter_policy	dict Facoltativo. Un criterio che specifica le condizioni per i messaggi non recapitabili in questo abbonamento.
return_policy	dict Facoltativo. Norme che specificano le condizioni per la restituzione dei messaggi.
detached	bool Facoltativo. Indica se la sottoscrizione è scollegata dall'argomento.
enable_once_delivery	bool Facoltativo. Se True, Pub/Sub fornisce la "consegna exactly-once" per i messaggi in questa sottoscrizione.

Restituisce

L'oggetto TIPCommon.adapters.pubsub.Subscription dell'abbonamento ricevuto.

Tipo restituito

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)

Aggiorna un argomento esistente.

Nota: alcune proprietà degli argomenti non sono modificabili.

Parametri
topic_name	str Il nome dell'argomento.
labels	dict Facoltativo. Un insieme di coppie chiave-valore utilizzate per organizzare l'argomento.
message_storage_policy	dict Facoltativo. Policy che limita le regioni in cui i messaggi vengono archiviati at-rest.
kms_key_name	str Facoltativo. Il nome della risorsa della CryptoKey di Cloud Key Management Service da utilizzare per proteggere i messaggi pubblicati in questo argomento.
schema_settings	dict Facoltativo. Impostazioni per la convalida dei messaggi pubblicati in base a uno schema.
satisfies_pzs	bool Facoltativo. Riservato per l'uso futuro. Questo campo è impostato su True se l'argomento soddisfa la separazione delle zone fisiche.
retention_duration	str Facoltativo. Il periodo di tempo in cui un messaggio pubblicato viene conservato dall'argomento. Se configurato, il messaggio verrà conservato per questo periodo di tempo, indipendentemente dalle configurazioni della sottoscrizione.

Restituisce

L'oggetto TIPCommon.adapters.pubsub.Topic dell'argomento ricevuto.

Tipo restituito

Topic

publish

publish(topic_name, messages)

Pubblica un elenco di oggetti PubSubMessage in un argomento.

Parametri
topic_name	str Il nome dell'argomento di destinazione per la pubblicazione del messaggio.
messages	list Un elenco contenente PubSubMessage oggetti. Il metodo statico PubSubAdapter.build_message() viene utilizzato per costruire questi oggetti.

Restituisce

Un elenco di ID messaggio.

Tipo restituito

list[str]

eseguire il pull

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

Esegue il pull dei messaggi dalle sottoscrizioni Pub/Sub.

Parametri
sub_name	str Il nome dell'abbonamento.
limit	int Il numero massimo di messaggi da restituire per questa richiesta.
timeout	int Il timeout della richiesta HTTP, in secondi. Il valore predefinito è 60.
encoding	str Una codifica dei messaggi Pub/Sub. Il valore predefinito è utf-8.

Restituisce

Un elenco di TIPCommon.adapters.pubsub.ReceivedMessage oggetti.

Tipo restituito

ReceivedMessage

static subscription_name

static subscription_name(project_id, sub_name)

Recupera il nome completo dell'abbonamento nel seguente formato: projects/project_id/topics/topic_name.

Parametri
project_id	str Il nome del progetto che contiene la risorsa.
sub_name	str Un nome di sottoscrizione Pub/Sub.

Restituisce

Il nome completo dell'abbonamento nel seguente formato: projects/project_id/topics/topic_name.

Tipo restituito

str

static topic_name

static topic_name(project_id, topic)

Recupera il nome completo di un argomento nel seguente formato: projects/project_id/topics/topic_name.

Parametri
project_id	str Il nome del progetto contenente la risorsa.
topic	str Un nome argomento Pub/Sub.

Restituisce

Un nome di argomento completo: projects/project_id/topics/topic_name.

Tipo restituito

str

Hai bisogno di ulteriore assistenza? Ricevi risposte dai membri della community e dai professionisti di Google SecOps.