TIPCommon.adapters

‫class TIPCommon.adapters.pubsub.pubsub.PubSubAdapter

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

בסיסים: object

מחלקת מתאם לניהול נושאים ומינויים ב-Pub/Sub של פרויקט. Google Cloud

ack

ack(sub_name, ack_ids)

מאשר את קבלת ההודעות שמשויכות אל ackIDs בתשובה AcknowledgeRequest שמוחזרת מ-PubSubAdapter.pull().

פרמטרים
sub_name	(str) שם המינוי.
ack_ids	(list[str]) רשימה של מזהי אישור להודעות שאושרו. הרשימה מוחזרת על ידי מערכת Pub/Sub בתשובה PubSubAdapter.pull().

‫static build_pubsub_message

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

יוצרת אובייקט PubSubMessage.

פרמטרים
message_content	(str) תוכן ההודעה.
encoding	(str) סוג הקידוד לקידוד או לפענוח של טקסט ההודעה. ערך ברירת המחדל הוא UTF-8.
ordering_key	אופציונלי (str) אם משתמשים בפרמטר, הוא מזהה את כל ההודעות הקשורות שצריכות להיות מסודרות לפי סדר הפרסום.
**attr	אופציונלי (str) המאפיינים שיועברו כמאפיינים של אובייקט ההודעה.

מחזירה

TIPCommon.adapters.pubsub.PubSubMessage אובייקט.

סוג הערך שמוחזר

PubSubMessage

create_subscription

create_subscription(sub_name, topic, **attr)

יוצרת מינוי Pub/Sub לנושא שצוין.

פרמטרים
sub_name	(str) שם המינוי.
topic	(str) שם של נושא ב-Pub/Sub שעבורו רוצים ליצור את המינוי.
**attr	פרמטרים נוספים להעברה לבקשת המינוי.

מחזירה

אובייקט TIPCommon.adapters.pubsub.Subscription של המינוי שנוצר.

סוג הערך שמוחזר

Subscription

create_topic

create_topic(topic_name)

יצירת נושא Pub/Sub ב Google Cloud פרויקט.

פרמטרים
topic_name	(str) שם הנושא. השם צריך להתאים ל Google Cloud כללים למתן שמות למשאבים.

מחזירה

אובייקט TIPCommon.adapters.pubsub.Topic של הנושא שנוצר.

סוג הערך שמוחזר

Topic

delete_subscription

delete_subscription(sub_name)

מחיקה של מינוי ל-Pub/Sub מ Google Cloud פרויקט.

פרמטרים
sub_name	(str) שם המינוי שרוצים להסיר.

delete_topic

delete_topic(topic_name)

מחיקה של נושא Pub/Sub מפרויקט Google Cloud .

פרמטרים
topic_name	(str) הנושא שרוצים להסיר.

‫static מ-from_credentials

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

יוצרת אובייקט PubSubAdapter מאובייקט google.oauth2.credentials.Credentials.

פרמטרים
credentials	(google.oauth2.credentials.Credentials) אובייקט google.oauth2.credentials.Credentials.
project_id	אופציונלי (str) מזהה הפרויקט Google Cloud . אם לא מספקים את הפרויקט, הפונקציה מנסה להשתמש בפרויקט שהוגדר באובייקט של פרטי הכניסה כברירת מחדל.
verify_ssl	אופציונלי (bool) ההגדרה מציינת אם אימות אישור ה-SSL מופעל בסשנים של HTTP.
quota_project	אופציונלי (str) הפרויקט שמשמש למכסה ולחיוב.
logger	אופציונלי (SiemplifyLogger) אובייקט SiemplifyLogger.
region	(str) האזור שבו Pub/Sub פועל.

מחזירה

אובייקט PubSubAdapter.

סוג הערך שמוחזר

PubSubAdapter

‫static from_service_account_info

static subscription_name(project_id, sub_name)

יוצרת אובייקט PubSubAdapter מ-JSON‏ service_account.

פרמטרים
user_service_account	(str) קובץ ה-JSON של חשבון השירות בפורמט טקסט. Google Cloud
project_id	אופציונלי (str) מזהה הפרויקט Google Cloud . אם לא מספקים את הפרויקט, הפונקציה מנסה להשתמש בפרויקט שהוגדר באובייקט של פרטי הכניסה כברירת מחדל.
verify_ssl	אופציונלי (bool) ההגדרה מציינת אם אימות אישור ה-SSL מופעל בסשנים של HTTP.
quota_project	אופציונלי (str) הפרויקט שמשמש למכסה ולחיוב.
logger	אופציונלי (SiemplifyLogger) אובייקט SiemplifyLogger.

מחזירה

אובייקט PubSubAdapter.

סוג הערך שמוחזר

PubSubAdapter

get_subscription

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

מאחזר מינוי ל-Pub/Sub.

פרמטרים
sub_name	(str) שם המינוי.
topic	(str) שם של נושא ב-Pub/Sub שעבורו רוצים ליצור מינוי. חובה אם הערך של create_if_not_exist הוא True.
create_if_not_exist	יוצר את המינוי ל-Pub/Sub ב- Google Cloud אם הוא לא קיים.
**attr	פרמטרים נוספים להעברה לבקשה ליצירת מינוי.

מחזירה

אובייקט TIPCommon.adapters.pubsub.Subscription של המינוי שאוחזר.

סוג הערך שמוחזר

Subscription

get_topic

get_topic(topic_name, create_if_not_exist=False)

מאחזר אובייקט של נושא Pub/Sub מהפרויקט שהוגדר Google Cloud.

פרמטרים
topic_name	(str) שם הנושא (פשוט, ללא התחילית projects/PROJECT_ID/topics/ ).
create_if_not_exist	bool יוצר את נושא Pub/Sub ב- Google Cloud, אם הוא לא קיים.

מחזירה

אובייקט TIPCommon.adapters.pubsub.Topic של הנושא שהתקבל.

סוג הערך שמוחזר

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)

עדכון של מינוי קיים.

הערה: אי אפשר לשנות חלק מהמאפיינים של המינוי.

פרמטרים
sub_name	(str) שם המינוי.
topic_name	(str) השם של הנושא שממנו המינוי הזה מקבל הודעות.

מחזירה

אובייקט TIPCommon.adapters.pubsub.Subscription של המינוי שהתקבל.

סוג הערך שמוחזר

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)

מעדכנים נושא קיים.

הערה: אי אפשר לשנות חלק מהמאפיינים של הנושאים.

פרמטרים
topic_name	(str) שם הנושא.

מחזירה

אובייקט TIPCommon.adapters.pubsub.Topic של הנושא שהתקבל.

סוג הערך שמוחזר

Topic

פרסום

publish(topic_name, messages)

פרסום רשימה של אובייקטים מסוג PubSubMessage בנושא.

פרמטרים
topic_name	(str) השם של הנושא שבו רוצים לפרסם את ההודעות.
messages	list רשימה של אובייקטים מסוג PubSubMessage. אפשר ליצור את הרשימה באמצעות PubSubAdapter.build_message() השיטה הסטטית.

מחזירה

רשימה של מזהי הודעות.

סוג הערך שמוחזר

list[str]

שליפת הודעות

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

שליפת הודעות ממינויים ל-Pub/Sub.

פרמטרים
sub_name	(str) שם המינוי.
limit	int המספר המקסימלי של הודעות שיוחזרו לבקשה הזו.
timeout	int פסק הזמן לבקשת HTTP בשניות. ברירת המחדל היא 60 שניות.
encoding	(str) קידוד של הודעת Pub/Sub. ערך ברירת המחדל הוא utf-8.

מחזירה

רשימה של TIPCommon.adapters.pubsub.ReceivedMessage אובייקטים.

סוג הערך שמוחזר

list[ReceivedMessage]

static subscription_name

static subscription_name(project_id, sub_name)

הפונקציה מחזירה את השם המלא של המינוי בפורמט הבא: projects/project_id/subscriptions/subscription_name.

פרמטרים
project_id	(str) שם הפרויקט שמכיל את המשאב.
sub_name	(str) שם המינוי ל-Pub/Sub.

מחזירה

שם מלא של מינוי בפורמט הבא: projects/project_id/subscriptions/subscription_name.

סוג הערך שמוחזר

str

‫static topic_name

static topic_name(project_id, topic)

שליפה של projects/project_id/topics/topic_name.

פרמטרים
project_id	(str) שם הפרויקט שמכיל את המשאב.
topic	(str) שם של נושא ב-Pub/Sub.

מחזירה

שם נושא מלא: projects/project_id/topics/topic_name.

סוג הערך שמוחזר

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)

בסיסים: 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')

בסיסים: 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)

בסיסים: 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)

בסיסים: 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)

בסיסים: object

identifier: str

json()

labels: dict= None

message_retention_duration: int= None

name: str

raw_data: dict

schema_settings: SchemaSettings= None

הבעיה עדיין לא נפתרה? קבלת תשובות מחברי הקהילה וממומחי Google SecOps.