TIPCommon.adapters

class TIPCommon.adapters.pubsub.pubsub.PubSubAdapter

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

Bases: object

Clase de adaptador para administrar suscripciones y temas de Pub/Sub del proyecto Google Cloud .

ack

ack(sub_name, ack_ids)

Confirma la recepción de los mensajes asociados con el ackIds en la respuesta AcknowledgeRequest que se devolvió desde PubSubAdapter.pull().

Parámetros
sub_name	str Es el nombre de la suscripción.
ack_ids	list[str] Es una lista de IDs de confirmación para los mensajes que se confirman. El sistema de Pub/Sub devuelve la lista en la respuesta PubSubAdapter.pull().

static build_pubsub_message

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

Crea un objeto PubSubMessage.

Parámetros
message_content	str Es el contenido del mensaje.
encoding	str Es el tipo de codificación para codificar o decodificar el texto del mensaje. El valor predeterminado es UTF-8.
ordering_key	str Es opcional. Si se configura, el parámetro identifica todos los mensajes relacionados que deben seguir el orden de publicación.
**attr	str Es opcional. Atributos que se pasarán como atributos de objeto de mensaje.

Devoluciones

Un objeto TIPCommon.adapters.pubsub.PubSubMessage.

Tipo de datos que se muestra

PubSubMessage

create_subscription

create_subscription(sub_name, topic, **attr)

Crea una suscripción a Pub/Sub para el tema especificado.

Parámetros
sub_name	str Es el nombre de la suscripción.
topic	str Es el nombre del tema de Pub/Sub para el que se creará la suscripción.
**attr	Son parámetros adicionales que se pasan a la solicitud de suscripción.

Devoluciones

Objeto TIPCommon.adapters.pubsub.Subscription de la suscripción creada.

Tipo de datos que se muestra

Subscription

create_topic

create_topic(topic_name)

Crea un tema de Pub/Sub en un proyecto Google Cloud .

Parámetros
topic_name	str Es el nombre del tema. El nombre debe corresponder a las Google Cloud reglas de nombres de recursos.

Devoluciones

Objeto TIPCommon.adapters.pubsub.Topic del tema creado.

Tipo de datos que se muestra

Topic

delete_subscription

delete_subscription(sub_name)

Borra una suscripción a Pub/Sub de un proyecto Google Cloud .

Parámetros
sub_name	str Es el nombre de la suscripción que se quitará.

delete_topic

delete_topic(topic_name)

Borra un tema de Pub/Sub de un proyecto Google Cloud .

Parámetros
topic_name	str Es el tema que se quitará.

static from_credentials

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

Crea un objeto PubSubAdapter a partir de un objeto google.oauth2.credentials.Credentials.

Parámetros
credentials	google.oauth2.credentials.Credentials Un objeto google.oauth2.credentials.Credentials.
project_id	Es opcional. str ID del proyecto Google Cloud Si no se proporciona, la función intentará usar el proyecto configurado en el objeto de credenciales de forma predeterminada.
verify_ssl	Es opcional. bool Especifica si la verificación del certificado SSL está habilitada para las sesiones HTTP.
quota_project	Es opcional. str Es el proyecto que se usará para la cuota y la facturación.
logger	Es opcional. SiemplifyLogger Un objeto SiemplifyLogger.
region	str Es la región en la que funcionará Pub/Sub.

Devoluciones

Un objeto PubSubAdapter.

Tipo de datos que se muestra

PubSubAdapter

static de from_service_account_info

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

Crea un objeto PubSubAdapter a partir de un objeto service_account JSON.

Parámetros
user_service_account	str Es el Google Cloud JSON de la cuenta de servicio en formato de texto.
project_id	Es opcional. str ID del proyecto Google Cloud Si no se proporciona, la función intentará usar el proyecto configurado en el objeto de credenciales de forma predeterminada.
verify_ssl	Es opcional. bool Especifica si la verificación del certificado SSL está habilitada para las sesiones HTTP.
quota_project	Es opcional. str Es el proyecto que se usará para la cuota y la facturación.
logger	Es opcional. SiemplifyLogger Un objeto SiemplifyLogger.

Devoluciones

Un objeto PubSubAdapter.

Tipo de datos que se muestra

PubSubAdapter

get_subscription

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

Recupera una suscripción a Pub/Sub.

Parámetros
sub_name	str Es el nombre de la suscripción.
topic	str Es el nombre de un tema de Pub/Sub para el que se creará una suscripción. Obligatorio si create_if_not_exist es True.
create_if_not_exist	Crea la suscripción a Pub/Sub en Google Cloud si no existe.
**attr	Son parámetros adicionales que se deben pasar a la solicitud de creación de suscripción.

Devoluciones

Es el objeto TIPCommon.adapters.pubsub.Subscription de la suscripción recuperada.

Tipo de datos que se muestra

Subscription

get_topic

get_topic(topic_name, create_if_not_exist=False)

Recupera un objeto de tema de Pub/Sub del proyecto Google Cloudconfigurado.

Parámetros
topic_name	str Nombre del tema (simplificado, sin el prefijo projects/PROJECT_ID/topics/).
create_if_not_exist	bool Crea el tema de Pub/Sub en Google Cloud si no existe.

Devoluciones

Es el objeto TIPCommon.adapters.pubsub.Topic del tema recibido.

Tipo de datos que se muestra

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)

Actualiza una suscripción existente.

Nota: Algunas propiedades de la suscripción no se pueden modificar.

Parámetros
sub_name	str Es el nombre de la suscripción.
topic_name	str Es el nombre del tema del que la suscripción recibe mensajes.
push_config	dict Es opcional. Es la configuración de un extremo de entrega push.
bigquery_config	dict Es opcional. Es la configuración de una suscripción a BigQuery.
cloud_storage_config	dict Es opcional. Es la configuración de una suscripción a Cloud Storage.
ack_deadline_seconds	int Es opcional. Es la cantidad aproximada de tiempo que Pub/Sub espera a que el suscriptor confirme la recepción de un mensaje antes de que se vuelva a entregar.
retain_acked_messages	bool Es opcional. Indica si se deben conservar los mensajes confirmados.
retention_duration	str Es opcional. Es la cantidad de tiempo que se retienen los mensajes no confirmados en el backlog de la suscripción, desde el momento en que se publica un mensaje.
labels	dict Es opcional. Es un conjunto de pares clave-valor que se usa para organizar la suscripción.
enable_message_ordering	bool Es opcional. Si es True, los mensajes publicados con el mismo ordering_key en PubsubMessage se entregan en el orden en que los recibe el sistema de Pub/Sub.
expiration_policy	dict Es opcional. Política que especifica las condiciones para el vencimiento de esta suscripción.
query_filter	str Es opcional. Es una expresión escrita en el lenguaje de filtro de Pub/Sub que especifica qué mensajes se entregan a la suscripción.
dead_letter_policy	dict Es opcional. Es una política que especifica las condiciones para enviar mensajes a la cola de mensajes no entregados en esta suscripción.
return_policy	dict Es opcional. Política que especifica las condiciones para devolver mensajes.
detached	bool Es opcional. Indica si la suscripción está desvinculada del tema.
enable_once_delivery	bool Es opcional. Si es True, Pub/Sub proporciona la "entrega exactamente una vez" para los mensajes de esta suscripción.

Devoluciones

Es el objeto TIPCommon.adapters.pubsub.Subscription de la suscripción recibida.

Tipo de datos que se muestra

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)

Actualiza un tema existente.

Nota: Algunas propiedades del tema no se pueden modificar.

Parámetros
topic_name	str Es el nombre del tema.
labels	dict Es opcional. Es un conjunto de pares clave-valor que se usa para organizar el tema.
message_storage_policy	dict Es opcional. Es la política que restringe las regiones en las que se almacenan los mensajes en reposo.
kms_key_name	str Es opcional. Es el nombre del recurso de la CryptoKey de Cloud Key Management Service que se usará para proteger los mensajes publicados en este tema.
schema_settings	dict Es opcional. Es la configuración para validar los mensajes publicados en función de un esquema.
satisfies_pzs	bool Es opcional. Se reserva para usarlo más adelante. Este campo se establece en True si el tema cumple con la separación física de zonas.
retention_duration	str Es opcional. Es la cantidad de tiempo que el tema retiene un mensaje publicado. Si se configura, el mensaje se conservará durante este período, independientemente de la configuración de la suscripción.

Devoluciones

Es el objeto TIPCommon.adapters.pubsub.Topic del tema recibido.

Tipo de datos que se muestra

Topic

publish

publish(topic_name, messages)

Publica una lista de objetos PubSubMessage en un tema.

Parámetros
topic_name	str Es el nombre del tema de destino para la publicación del mensaje.
messages	list Es una lista que contiene objetos PubSubMessage. El método estático PubSubAdapter.build_message() se usa para construir estos objetos.

Devoluciones

Es una lista de IDs de mensajes.

Tipo de datos que se muestra

list[str]

extraer

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

Extrae mensajes de suscripciones de Pub/Sub.

Parámetros
sub_name	str Es el nombre de la suscripción.
limit	int Es la cantidad máxima de mensajes que se devolverán para esta solicitud.
timeout	int Es el tiempo de espera de la solicitud HTTP, en segundos. El valor predeterminado es 60.
encoding	str Es una codificación de mensajes de Pub/Sub. El valor predeterminado es utf-8.

Devoluciones

Una lista de objetos TIPCommon.adapters.pubsub.ReceivedMessage.

Tipo de datos que se muestra

ReceivedMessage

static subscription_name

static subscription_name(project_id, sub_name)

Recupera el nombre completo de la suscripción en el siguiente formato: projects/project_id/topics/topic_name.

Parámetros
project_id	str Es el nombre del proyecto que contiene el recurso.
sub_name	str Es el nombre de una suscripción a Pub/Sub.

Devoluciones

Nombre completo de la suscripción con el siguiente formato:projects/project_id/topics/topic_name.

Tipo de datos que se muestra

str

static topic_name

static topic_name(project_id, topic)

Recupera el nombre completo de un tema en el siguiente formato: projects/project_id/topics/topic_name.

Parámetros
project_id	str Es el nombre del proyecto que contiene el recurso.
topic	str Es el nombre de un tema de Pub/Sub.

Devoluciones

Nombre completo del tema:projects/project_id/topics/topic_name.

Tipo de datos que se muestra

str

¿Necesitas más ayuda? Obtén respuestas de miembros de la comunidad y profesionales de Google SecOps.