zcloud.pubsub.util module

class zcloud.pubsub.util.AttributeKeys(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Enum for standard attribute keys used in pub/sub messages.

EVENT_AUDIENCE = 'event_audience'

ORIGIN_SERVICE = 'origin_service'

class zcloud.pubsub.util.EventAudience(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Enum for event audience types.

BQ_TABLE_PUBLICATION = 'bq-table-publication'

CHECK_UPLOAD_FOR_STRUCTURE = 'check-upload-for-structure'

ETL_SERVICE = 'standardize-structure-data'

GET_STRUCTURE_DATA = 'get-structure-data'

GET_STRUCTURE_DATA_BACKOFF = 'get-structure-data-backoff'

METADATA_UPDATE = 'metadata-update'

RAW_STRUCTURE_POSTED = 'raw_structure_posted'

STANDARD_STRUCTURE_AVRO_POSTED = 'standard-structure-avro-posted'

STRUCTURE_POSTED = 'structure-posted'

WEBSOCKET_NOTIFICATION = 'websocket-notification'

class zcloud.pubsub.util.GCPMessageFields(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Enum for top level pub/sub message fields.

ATTRIBUTES = 'attributes'

DATA = 'data'

MESSAGE_ID = 'messageId'

ORDERING_KEY = 'orderingKey'

PUBLISH_TIME = 'publishTime'

class zcloud.pubsub.util.MessageData(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Enum for standard message data fields used in pub/sub messages.

CLIENT_ID = 'clientID'

DETAILS = 'details'

ENTITY_IDS = 'entityIDs'

STATUS = 'status'

STRUCTURE_CORRELATION_IDS = 'StructureCorrelationIDs'

STRUCTURE_CORRELATION_IDS_FOUND = 'structureCorrelationIDs_found'

STRUCTURE_CORRELATION_IDS_UNFOUND = 'structureCorrelationIDs_unfound'

STRUCTURE_ENTITY_IDS = 'structureEntityIDs'

UPLOAD_UUID = 'uploadUUID'

WEBSOCKET_MESSAGE = 'websocketMessage'

class zcloud.pubsub.util.MessageMetadataFields(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Enum for standard message metadata fields used in pub/sub messages.

CORRELATION_ID = 'correlationId'

TAGS = 'tags'

class zcloud.pubsub.util.MessageSchemaFields(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Enum for standard message schema fields used in pub/sub messages.

MESSAGE_SUBJECT = 'messageSubject'

MESSAGE_TYPE = 'messageType'

METADATA = 'metadata'

PAYLOAD = 'payload'

PRIORITY = 'priority'

SOURCE = 'source'

class zcloud.pubsub.util.MessageType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Enum for standard message types.

ALERT = 'alert'

ERROR = 'error'

EVENT = 'event'

METRIC = 'metric'

SUCCESS = 'success'

class zcloud.pubsub.util.Priority(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Enum for message priority levels.

HIGH = 'high'

LOW = 'low'

MEDIUM = 'medium'

class zcloud.pubsub.util.Schema(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Enum for pub/sub schemas.

COLUMNA_PRIMARY = 'columna-primary'

class zcloud.pubsub.util.Topic(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Enum for pub/sub topics.

COLUMNA_TEST = 'columna-test'