Events — Models
EventsApiAdminOutboxGetFailedFailedOutboxMessage
Details of a failed outbox message
Field | Type |
|---|---|
id | int | Unset |
event_id | int | Unset |
delivery_channel | EventsApiEventsDeliveryChannel | Unset |
routing_key | None | str | Unset |
subscriber_id | None | str | Unset |
subscription_id | None | str | Unset |
payload_size | int | Unset |
attempt_count | int | Unset |
last_attempt_at | datetime.datetime | None | Unset |
created_at | datetime.datetime | Unset |
EventsApiAdminOutboxGetFailedRequest
Request to get failed outbox messages with pagination and filtering
Field | Type |
|---|---|
delivery_channel | EventsApiEventsDeliveryChannel | None | Unset |
page_number | int | None | Unset |
page_size | int | None | Unset |
EventsApiAdminOutboxGetFailedResponse
Response containing paginated failed outbox messages
Field | Type |
|---|---|
failed_messages | list[EventsApiAdminOutboxGetFailedFailedOutboxMessage] | Unset |
page_number | int | Unset |
page_size | int | Unset |
total_count | int | Unset |
total_pages | int | Unset |
EventsApiAdminOutboxRetryResponse
Response after retrying a failed outbox message
Field | Type |
|---|---|
id | int | Unset |
success | bool | Unset |
message | str | Unset |
EventsApiAdminPerfOutboxTimingChannelTimingStats
Field | Type |
|---|---|
channel | str | Unset |
sample_count | int | Unset |
persistence_ms | |
polling_wait_ms | |
batch_queue_ms | |
delivery_exec_ms | |
api_side_total_ms |
EventsApiAdminPerfOutboxTimingLatencyStats
Field | Type |
|---|---|
min_ | float | Unset |
p50 | float | Unset |
p95 | float | Unset |
p99 | float | Unset |
max_ | float | Unset |
EventsApiAdminPerfOutboxTimingRequest
EventsApiAdminPerfOutboxTimingResponse
Field | Type |
|---|---|
channels | list[EventsApiAdminPerfOutboxTimingChannelTimingStats] | Unset |
EventsApiEventsCreateRequest
Request model for creating a new event
Field | Type |
|---|---|
source_name | str |
source_id | str |
source_created_at | datetime.datetime |
type_ | str | Unset |
source_category | EventsApiEventsEventSourceCategory | Unset |
source_component | EventsApiEventsEventSourceComponent | None | Unset |
payload_type | None | str | Unset |
payload | None | str | Unset |
state | None | str | Unset |
stream_id | None | str | Unset |
description | None | str | Unset |
triggering_event_id | int | None | Unset |
source_component_extended_description | None | str | Unset |
file_references | list[EventsApiEventsFileReferencesFileReferenceInput] | None | Unset |
severity | EventsApiEventsEventSeverity | None | Unset |
user_id | None | str | Unset |
EventsApiEventsDeliveryChannel
Values
- GLOBAL_TOPIC — global_topic
- SUBSCRIBER_TOPIC — subscriber_topic
- WEBHOOK — webhook
- WEBSOCKET — websocket
EventsApiEventsEventIncludes
Values
- FILE_REFERENCES — file_references
EventsApiEventsEventSeverity
Values
- CRITICAL — critical
- DEBUG — debug
- ERROR — error
- INFO — info
- WARNING — warning
EventsApiEventsEventSourceCategory
Values
- CELLARIO_EDGE — cellario_edge
- CELLARIO_OS — cellario_os
- INTEGRATION — integration
- OTHER — other
EventsApiEventsEventSourceComponent
Values
- BLOB_STORAGE_API — blob_storage_api
- CELLARIO_AGENT — cellario_agent
- CELLARIO_SCHEDULER — cellario_scheduler
- CELLARIO_SCHEDULER_CLOUD — cellario_scheduler_cloud
- DATA_ACCESS_API — data_access_api
- DRIVER — driver
- DRIVER_HOST — driver_host
- EVENTS_API — events_api
- EXTENSION_SERVICE — extension_service
- JOB_ORCHESTRATOR — job_orchestrator
- LAB_SERVICES_API — lab_services_api
- OTHER — other
- PLATFORM_API — platform_api
EventsApiEventsFileReferencesFileReferenceInput
Input model for creating a file reference as part of an event
Field | Type |
|---|---|
file_name | str | Unset |
description | None | str | Unset |
type_ | |
link | str | Unset |
EventsApiEventsFileReferencesFileReferenceResponse
Field | Type |
|---|---|
id | str | Unset |
file_name | str | Unset |
description | None | str | Unset |
type_ | |
link | str | Unset |
date_created | datetime.datetime | Unset |
date_last_modified | datetime.datetime | Unset |
EventsApiEventsFileReferencesFileReferenceType
Values
- CELLARIO_OS_BLOB — cellario_os_blob
- EXTERNAL — external
EventsApiEventsGetPaginatedResponse
Paginated response wrapper for event queries
Field | Type |
|---|---|
events | list[EventsApiEventsResponse] | Unset |
page_number | int | Unset |
page_size | int | Unset |
total_count | int | Unset |
total_pages | int | Unset |
EventsApiEventsGetSearchFilter
Represents the filter criteria for searching events.
Field | Type |
|---|---|
id_in | list[int] | None | Unset |
source_category | EventsApiEventsEventSourceCategory | None | Unset |
source_component | EventsApiEventsEventSourceComponent | None | Unset |
source_created_at_from | datetime.datetime | None | Unset |
source_created_at_to | datetime.datetime | None | Unset |
type_in | list[str] | None | Unset |
state_in | list[str] | None | Unset |
source_name | None | str | Unset |
source_name_in | list[str] | None | Unset |
source_id | None | str | Unset |
source_id_in | list[str] | None | Unset |
stream_id | None | str | Unset |
stream_id_in | list[str] | None | Unset |
user_id | None | str | Unset |
user_id_in | list[str] | None | Unset |
triggering_event_id | int | None | Unset |
triggering_event_id_in | list[int] | None | Unset |
payload_type | None | str | Unset |
payload_type_in | list[str] | None | Unset |
payload_has_key | list[str] | None | Unset |
payload_has_any_key | list[str] | None | Unset |
payload_match | list[str] | None | Unset |
payload_match_any | list[str] | None | Unset |
severity_in | list[EventsApiEventsEventSeverity] | None | Unset |
page_size | int | None | Unset |
page_number | int | None | Unset |
EventsApiEventsResponse
Represents the response model for an event.
Field | Type |
|---|---|
id | int | Unset |
type_ | str | Unset |
source_category | EventsApiEventsEventSourceCategory | Unset |
source_component | EventsApiEventsEventSourceComponent | None | Unset |
source_name | str | Unset |
source_id | str | Unset |
source_created_at | datetime.datetime | Unset |
received_at | datetime.datetime | Unset |
payload_type | None | str | Unset |
payload | None | str | Unset |
state | None | str | Unset |
stream_id | None | str | Unset |
description | None | str | Unset |
triggering_event_id | int | None | Unset |
source_component_extended_description | None | str | Unset |
file_references | list[EventsApiEventsFileReferencesFileReferenceResponse] | None | Unset |
sequence | int | None | Unset |
severity | EventsApiEventsEventSeverity | None | Unset |
user_id | None | str | Unset |
EventsApiEventsSearchRequest
Request body for POST /v1/events/search
Field | Type |
|---|---|
id | int | None | Unset |
id_in | list[int] | None | Unset |
type_ | None | str | Unset |
type_in | list[str] | None | Unset |
state | None | str | Unset |
state_in | list[str] | None | Unset |
source_category | EventsApiEventsEventSourceCategory | None | Unset |
source_component | EventsApiEventsEventSourceComponent | None | Unset |
severity | EventsApiEventsEventSeverity | None | Unset |
severity_in | list[EventsApiEventsEventSeverity] | None | Unset |
source_name | None | str | Unset |
source_name_in | list[str] | None | Unset |
source_id | None | str | Unset |
source_id_in | list[str] | None | Unset |
stream_id | None | str | Unset |
stream_id_in | list[str] | None | Unset |
user_id | None | str | Unset |
user_id_in | list[str] | None | Unset |
triggering_event_id | int | None | Unset |
triggering_event_id_in | list[int] | None | Unset |
from_ | datetime.datetime | None | Unset |
to | datetime.datetime | None | Unset |
source_created_at_from | datetime.datetime | None | Unset |
source_created_at_to | datetime.datetime | None | Unset |
payload_type | None | str | Unset |
payload_type_in | list[str] | None | Unset |
payload_has_keys | list[str] | None | Unset |
payload_has_any_keys | list[str] | None | Unset |
payload_matches | EventsApiEventsSearchRequestPayloadMatchesType0 | None | Unset |
payload_matches_any | EventsApiEventsSearchRequestPayloadMatchesAnyType0 | None | Unset |
page_size | int | None | Unset |
page_number | int | None | Unset |
include | list[EventsApiEventsEventIncludes] | None | Unset |
search | None | str | Unset |
EventsApiEventsSearchRequestPayloadMatchesAnyType0
Key to array of values — event matches if ANY key:value pair matches (full OR across all keys and values). Keys support dot notation.
Field | Type |
|---|---|
additional_properties | dict[str, list[Any]] |
additional_keys | list[str] |
EventsApiEventsSearchRequestPayloadMatchesType0
Key/value pairs that must all match in payload (AND logic). Keys support dot notation.
Field | Type |
|---|---|
additional_properties | dict[str, Any] |
additional_keys | list[str] |
EventsApiFiltersCreateRequest
Request to create a complex filter for a subscriber
Field | Type |
|---|---|
filter_ | |
subscriber_id | str | Unset |
EventsApiFiltersCreateResponse
Response from creating a filter
Field | Type |
|---|---|
filter_id | str | Unset |
filter_ | |
date_created | datetime.datetime | Unset |
EventsApiFiltersGetRequest
Request to get a filter by ID
Field | Type |
|---|---|
subscriber_id | str | Unset |
filter_id | str | Unset |
EventsApiFiltersGetResponse
Filter details
Field | Type |
|---|---|
filter_id | str | Unset |
filter_ | |
archived | bool | Unset |
date_created | datetime.datetime | Unset |
EventsApiFiltersListFilterSummary
Filter summary for list view
Field | Type |
|---|---|
filter_id | str | Unset |
filter_ | |
archived | bool | Unset |
subscription_count | int | Unset |
date_created | datetime.datetime | Unset |
EventsApiFiltersListRequest
Request to list filters for a subscriber
Field | Type |
|---|---|
subscriber_id | str | Unset |
include_archived | bool | Unset |
page_size | int | None | Unset |
page_number | int | None | Unset |
EventsApiFiltersListResponse
Paginated list of filters
Field | Type |
|---|---|
filters | list[EventsApiFiltersListFilterSummary] | Unset |
page_number | int | Unset |
page_size | int | Unset |
total_count | int | Unset |
total_pages | int | Unset |
EventsApiSubscribersAcknowledgmentMode
Values
- AUTO — auto
- MANUAL — manual
EventsApiSubscribersConfigureDeliveryConfigurationRequest
Delivery configuration for the subscriber
Field | Type |
|---|---|
delivery_type | EventsApiSubscribersDeliveryType | Unset |
web_hook | EventsApiSubscribersConfigureWebHookConfigRequest | None | Unset |
web_socket | EventsApiSubscribersConfigureWebSocketConfigRequest | None | Unset |
EventsApiSubscribersConfigureDeliveryConfigurationResponse
Delivery configuration response
Field | Type |
|---|---|
delivery_type | EventsApiSubscribersDeliveryType | Unset |
web_hook | EventsApiSubscribersConfigureWebHookConfigResponse | None | Unset |
web_socket | EventsApiSubscribersConfigureWebSocketConfigResponse | None | Unset |
EventsApiSubscribersConfigureRequest
Request to configure a subscriber and activate event delivery. The subscriberId is provided in the URI. If it doesn't exist, a new subscriber will be created with that ID.
Attributes:
subscriber_id (str): Globally unique identifier for the subscriber (from URI).
Can be an existing subscriberId or a new client-generated GUID.
If the ID doesn't exist, a new subscriber will be created.
delivery_configuration (EventsApiSubscribersConfigureDeliveryConfigurationRequest): Delivery configuration for
the subscriber
name (None | str | Unset): Optional name for the subscriber
delivery_mode (EventsApiSubscribersDeliveryMode | None | Unset): Delivery mode: "guaranteed" for sequence-
ordered delivery with blocking on failure,
"best_effort" for parallel delivery without ordering guarantees.
Default: guaranteed
max_retry_attempts (int | None | Unset): Maximum number of automatic retry attempts before entering blocked
state.
Default: 5
enable_auto_dlq (bool | None | Unset): Whether to automatically move blocked entries to DLQ after timeout.
Default: true
dlq_timeout_minutes (int | None | Unset): Minutes in blocked state before auto-DLQ (only applies if
EnableAutoDlq is true).
Default: 60Field | Type |
|---|---|
subscriber_id | str |
delivery_configuration | |
name | None | str | Unset |
delivery_mode | EventsApiSubscribersDeliveryMode | None | Unset |
max_retry_attempts | int | None | Unset |
enable_auto_dlq | bool | None | Unset |
dlq_timeout_minutes | int | None | Unset |
EventsApiSubscribersConfigureResponse
Response from configuring a subscriber
Field | Type |
|---|---|
subscriber_id | str | Unset |
name | None | str | Unset |
state | EventsApiSubscribersSubscriberState | Unset |
delivery_mode | EventsApiSubscribersDeliveryMode | Unset |
max_retry_attempts | int | Unset |
enable_auto_dlq | bool | Unset |
dlq_timeout_minutes | int | Unset |
delivery_configuration | |
date_last_modified | datetime.datetime | Unset |
EventsApiSubscribersConfigureWebHookConfigRequest
WebHook delivery configuration
Field | Type |
|---|---|
endpoint_url | str | Unset |
api_key | None | str | Unset |
max_retries | int | None | Unset |
base_backoff_seconds | int | None | Unset |
max_backoff_seconds | int | None | Unset |
EventsApiSubscribersConfigureWebHookConfigResponse
WebHook configuration response
Field | Type |
|---|---|
endpoint_url | str | Unset |
max_retries | int | Unset |
base_backoff_seconds | int | Unset |
max_backoff_seconds | int | Unset |
EventsApiSubscribersConfigureWebSocketConfigRequest
WebSocket delivery configuration
Field | Type |
|---|---|
connection_token_expiry_minutes | int | None | Unset |
acknowledgment_mode | EventsApiSubscribersAcknowledgmentMode | None | Unset |
acknowledgment_timeout_seconds | int | None | Unset |
heartbeat_interval_seconds | int | None | Unset |
EventsApiSubscribersConfigureWebSocketConfigResponse
WebSocket configuration response
Field | Type |
|---|---|
connection_token_expiry_minutes | int | Unset |
acknowledgment_mode | |
acknowledgment_timeout_seconds | int | Unset |
heartbeat_interval_seconds | int | Unset |
connection_token | None | str | Unset |
connection_token_expires_at | datetime.datetime | None | Unset |
EventsApiSubscribersCreateRequest
Request to create a new subscriber. This endpoint is required for RabbitMQ clients who need the subscriberId before configuring queue bindings. WebHook and WebSocket clients can skip this step and use the Configure endpoint directly.
Attributes:
name (None | str | Unset): Optional name for the subscriber (can be set during configure as well)Field | Type |
|---|---|
name | None | str | Unset |
EventsApiSubscribersCreateResponse
Response from creating a new subscriber
Field | Type |
|---|---|
subscriber_id | str | Unset |
name | None | str | Unset |
state | EventsApiSubscribersSubscriberState | Unset |
date_created | datetime.datetime | Unset |
EventsApiSubscribersDeliveryManagementBlockedRequest
Request for listing blocked outbox entries for a subscriber
Field | Type |
|---|---|
subscriber_id | str | Unset |
page_number | int | None | Unset |
page_size | int | None | Unset |
EventsApiSubscribersDeliveryManagementBlockedResponse
Response containing blocked outbox entries for a subscriber
Field | Type |
|---|---|
entries | list[EventsApiSubscribersDeliveryManagementOutboxEntryResponse] | Unset |
page_number | int | Unset |
page_size | int | Unset |
total_count | int | Unset |
total_pages | int | Unset |
EventsApiSubscribersDeliveryManagementDlqRequest
Request for listing DLQ entries for a subscriber
Field | Type |
|---|---|
subscriber_id | str | Unset |
page_number | int | None | Unset |
page_size | int | None | Unset |
EventsApiSubscribersDeliveryManagementDlqResponse
Response containing DLQ entries for a subscriber
Field | Type |
|---|---|
entries | list[EventsApiSubscribersDeliveryManagementOutboxEntryResponse] | Unset |
page_number | int | Unset |
page_size | int | Unset |
total_count | int | Unset |
total_pages | int | Unset |
EventsApiSubscribersDeliveryManagementDlqRetryRequest
Request to retry a DLQ entry
Field | Type |
|---|---|
subscriber_id | str | Unset |
outbox_id | int | Unset |
EventsApiSubscribersDeliveryManagementOutboxEntryResponse
Shared response model for outbox entry details
Field | Type |
|---|---|
id | int | Unset |
event_id | int | Unset |
event_sequence | int | None | Unset |
delivery_channel | str | Unset |
subscription_id | None | str | Unset |
attempt_count | int | Unset |
last_attempt_at | datetime.datetime | None | Unset |
failed_at | datetime.datetime | None | Unset |
is_in_dlq | bool | Unset |
created_at | datetime.datetime | Unset |
EventsApiSubscribersDeliveryManagementRetryRequest
Request to retry a blocked outbox entry
Field | Type |
|---|---|
subscriber_id | str | Unset |
outbox_id | int | Unset |
EventsApiSubscribersDeliveryManagementSkipRequest
Request to skip a blocked outbox entry
Field | Type |
|---|---|
subscriber_id | str | Unset |
outbox_id | int | Unset |
EventsApiSubscribersDeliveryManagementStatusBlockingMessageInfo
Information about a message that is blocking delivery
Field | Type |
|---|---|
outbox_id | int | Unset |
event_id | int | Unset |
event_sequence | int | None | Unset |
attempt_count | int | Unset |
failed_at | datetime.datetime | None | Unset |
created_at | datetime.datetime | Unset |
EventsApiSubscribersDeliveryManagementStatusRequest
Request for getting subscriber delivery status
Field | Type |
|---|---|
subscriber_id | str | Unset |
EventsApiSubscribersDeliveryManagementStatusResponse
Response containing subscriber delivery status
Field | Type |
|---|---|
subscriber_id | str | Unset |
delivery_mode | str | Unset |
is_blocked | bool | Unset |
pending_count | int | Unset |
blocked_count | int | Unset |
dlq_count | int | Unset |
auto_dlq_enabled | bool | Unset |
dlq_timeout_minutes | int | None | Unset |
blocking_message | EventsApiSubscribersDeliveryManagementStatusBlockingMessageInfo | None | Unset |
EventsApiSubscribersDeliveryMode
Values
- BEST_EFFORT — best_effort
- GUARANTEED — guaranteed
EventsApiSubscribersDeliveryType
Values
- RABBIT — rabbit
- WEBHOOK — webhook
- WEBSOCKET — websocket
EventsApiSubscribersFiltersDateTimeOffsetRangeFilter
Filter for DateTimeOffset range queries
Field | Type |
|---|---|
from_ | datetime.datetime | None | Unset |
to | datetime.datetime | None | Unset |
EventsApiSubscribersFiltersEnumFilterOfEventSeverity
Filter for enum field matching
Field | Type |
|---|---|
in_ | list[EventsApiEventsEventSeverity] | None | Unset |
not_in | list[EventsApiEventsEventSeverity] | None | Unset |
is_null | bool | None | Unset |
EventsApiSubscribersFiltersEnumFilterOfEventSourceCategory
Filter for enum field matching
Field | Type |
|---|---|
in_ | list[EventsApiEventsEventSourceCategory] | None | Unset |
not_in | list[EventsApiEventsEventSourceCategory] | None | Unset |
is_null | bool | None | Unset |
EventsApiSubscribersFiltersEnumFilterOfEventSourceComponent
Filter for enum field matching
Field | Type |
|---|---|
in_ | list[EventsApiEventsEventSourceComponent] | None | Unset |
not_in | list[EventsApiEventsEventSourceComponent] | None | Unset |
is_null | bool | None | Unset |
EventsApiSubscribersFiltersEventFieldFilters
Structured filters for Event entity fields
EventsApiSubscribersFiltersEventFieldFiltersPayloadMatchesAnyType0
Key to list of values where value must match any in list (OR logic across all keys and values) Keys support dot notation for nested access.
Field | Type |
|---|---|
additional_properties | dict[str, list[Any]] |
additional_keys | list[str] |
EventsApiSubscribersFiltersEventFieldFiltersPayloadMatchesType0
Key/value pairs that must all match (AND logic) Keys support dot notation for nested access.
Field | Type |
|---|---|
additional_properties | dict[str, Any] |
additional_keys | list[str] |
EventsApiSubscribersFiltersJsonPathFilter
Filter for JSON payload content using JSONPath expressions
Field | Type |
|---|---|
json_path | str | Unset |
value | Any | Unset |
not_value | Any | Unset |
EventsApiSubscribersFiltersLongRangeFilter
Filter for long/int64 field matching and range queries
Field | Type |
|---|---|
min_ | int | None | Unset |
max_ | int | None | Unset |
in_ | list[int] | None | Unset |
not_in | list[int] | None | Unset |
is_null | bool | None | Unset |
EventsApiSubscribersFiltersStringFilter
Filter for string field matching with various operators
Field | Type |
|---|---|
in_ | list[str] | None | Unset |
not_in | list[str] | None | Unset |
contains | None | str | Unset |
starts_with | None | str | Unset |
ends_with | None | str | Unset |
is_null | bool | None | Unset |
EventsApiSubscribersGetDeliveryConfigurationResponse
Delivery configuration details
Field | Type |
|---|---|
delivery_type | EventsApiSubscribersDeliveryType | Unset |
web_hook | EventsApiSubscribersGetWebHookConfigResponse | None | Unset |
web_socket | EventsApiSubscribersGetWebSocketConfigResponse | None | Unset |
EventsApiSubscribersGetRequest
Request to get a subscriber by ID
Field | Type |
|---|---|
subscriber_id | str | Unset |
EventsApiSubscribersGetResponse
Response containing subscriber details
Field | Type |
|---|---|
subscriber_id | str | Unset |
name | None | str | Unset |
state | EventsApiSubscribersSubscriberState | Unset |
archived | bool | Unset |
delivery_configuration | EventsApiSubscribersGetDeliveryConfigurationResponse | None | Unset |
date_created | datetime.datetime | Unset |
date_last_modified | datetime.datetime | Unset |
EventsApiSubscribersGetWebHookConfigResponse
WebHook configuration details
Field | Type |
|---|---|
endpoint_url | str | Unset |
max_retries | int | Unset |
base_backoff_seconds | int | Unset |
max_backoff_seconds | int | Unset |
EventsApiSubscribersGetWebSocketConfigResponse
WebSocket configuration details
Field | Type |
|---|---|
connection_token_expiry_minutes | int | Unset |
acknowledgment_mode | |
acknowledgment_timeout_seconds | int | Unset |
heartbeat_interval_seconds | int | Unset |
connection_token_expires_at | datetime.datetime | None | Unset |
EventsApiSubscribersHistoricalBackfillState
Values
- COMPLETE — complete
- IN_PROGRESS — in_progress
- PENDING — pending
EventsApiSubscribersListRequest
Request to list subscribers with pagination and filtering
Field | Type |
|---|---|
include_archived | bool | Unset |
page_size | int | None | Unset |
page_number | int | None | Unset |
EventsApiSubscribersListResponse
Paginated list of subscribers
Field | Type |
|---|---|
subscribers | list[EventsApiSubscribersListSubscriberSummary] | Unset |
page_number | int | Unset |
page_size | int | Unset |
total_count | int | Unset |
total_pages | int | Unset |
EventsApiSubscribersListSubscriberSummary
Subscriber summary for list view
Field | Type |
|---|---|
subscriber_id | str | Unset |
name | None | str | Unset |
state | EventsApiSubscribersSubscriberState | Unset |
archived | bool | Unset |
delivery_type | EventsApiSubscribersDeliveryType | None | Unset |
subscription_count | int | Unset |
date_created | datetime.datetime | Unset |
date_last_modified | datetime.datetime | Unset |
EventsApiSubscribersRegenerateTokenRequest
Request to regenerate a WebSocket connection token
Field | Type |
|---|---|
subscriber_id | str | Unset |
EventsApiSubscribersRegenerateTokenResponse
Response containing the new connection token
Field | Type |
|---|---|
connection_token | str | Unset |
connection_token_expires_at | datetime.datetime | Unset |
EventsApiSubscribersSubscriberState
Values
- ACTIVE — active
- PAUSED — paused
- UNCONFIGURED — unconfigured
EventsApiSubscriptionsCreateBatchingSettings
Batching settings for event delivery
Field | Type |
|---|---|
max_batch_size | int | None | Unset |
max_batch_interval_seconds | int | None | Unset |
EventsApiSubscriptionsCreateBatchingSettingsResponse
Batching settings response
Field | Type |
|---|---|
max_batch_size | int | None | Unset |
max_batch_interval_seconds | int | None | Unset |
EventsApiSubscriptionsCreateHistoricalSettings
Historical event delivery settings
Field | Type |
|---|---|
enabled | bool | Unset |
start_time | datetime.datetime | None | Unset |
end_time | datetime.datetime | None | Unset |
from_event_id | int | None | Unset |
EventsApiSubscriptionsCreateHistoricalSettingsResponse
Historical event delivery settings response
Field | Type |
|---|---|
enabled | bool | Unset |
start_time | datetime.datetime | None | Unset |
end_time | datetime.datetime | None | Unset |
from_event_id | int | None | Unset |
cutoff_sequence | int | None | Unset |
backfill_state | EventsApiSubscribersHistoricalBackfillState | None | Unset |
EventsApiSubscriptionsCreateRequest
Request to create a new subscription for a subscriber
Field | Type |
|---|---|
subscriber_id | str | Unset |
simple_filter | None | str | Unset |
complex_filter_id | None | str | Unset |
batching | EventsApiSubscriptionsCreateBatchingSettings | None | Unset |
historical | EventsApiSubscriptionsCreateHistoricalSettings | None | Unset |
EventsApiSubscriptionsCreateResponse
Response from creating a new subscription
Field | Type |
|---|---|
subscription_id | str | Unset |
simple_filter | None | str | Unset |
complex_filter_id | None | str | Unset |
batching | EventsApiSubscriptionsCreateBatchingSettingsResponse | None | Unset |
historical | EventsApiSubscriptionsCreateHistoricalSettingsResponse | None | Unset |
archived | bool | Unset |
date_created | datetime.datetime | Unset |
EventsApiSubscriptionsGetBatchingSettings
Field | Type |
|---|---|
max_batch_size | int | None | Unset |
max_batch_interval_seconds | int | None | Unset |
EventsApiSubscriptionsGetHistoricalSettings
Field | Type |
|---|---|
enabled | bool | Unset |
start_time | datetime.datetime | None | Unset |
end_time | datetime.datetime | None | Unset |
from_event_id | int | None | Unset |
cutoff_sequence | int | None | Unset |
backfill_state | EventsApiSubscribersHistoricalBackfillState | None | Unset |
EventsApiSubscriptionsGetRequest
Request to get a subscription
Field | Type |
|---|---|
subscriber_id | str | Unset |
subscription_id | str | Unset |
EventsApiSubscriptionsGetResponse
Subscription details
Field | Type |
|---|---|
subscription_id | str | Unset |
simple_filter | None | str | Unset |
complex_filter_id | None | str | Unset |
batching | EventsApiSubscriptionsGetBatchingSettings | None | Unset |
historical | EventsApiSubscriptionsGetHistoricalSettings | None | Unset |
archived | bool | Unset |
date_created | datetime.datetime | Unset |
date_last_modified | datetime.datetime | Unset |
EventsApiSubscriptionsHistoricalStatusRequest
Request to get historical backfill status for a subscription
Field | Type |
|---|---|
subscriber_id | str | Unset |
subscription_id | str | Unset |
EventsApiSubscriptionsHistoricalStatusResponse
Response containing historical backfill status for a subscription
Field | Type |
|---|---|
historical_enabled | bool | Unset |
backfill_state | EventsApiSubscribersHistoricalBackfillState | None | Unset |
cutoff_sequence | int | None | Unset |
backfill_last_processed_sequence | int | None | Unset |
start_time | datetime.datetime | None | Unset |
end_time | datetime.datetime | None | Unset |
from_event_id | int | None | Unset |
EventsApiSubscriptionsListRequest
Request to list subscriptions for a subscriber
Field | Type |
|---|---|
subscriber_id | str | Unset |
include_archived | bool | Unset |
page_size | int | None | Unset |
page_number | int | None | Unset |
EventsApiSubscriptionsListResponse
Paginated list of subscriptions
Field | Type |
|---|---|
subscriptions | list[EventsApiSubscriptionsListSubscriptionSummary] | Unset |
page_number | int | Unset |
page_size | int | Unset |
total_count | int | Unset |
total_pages | int | Unset |
EventsApiSubscriptionsListSubscriptionSummary
Subscription summary for list view
Field | Type |
|---|---|
subscription_id | str | Unset |
simple_filter | None | str | Unset |
complex_filter_id | None | str | Unset |
archived | bool | Unset |
has_batching | bool | Unset |
historical_enabled | bool | Unset |
date_created | datetime.datetime | Unset |
date_last_modified | datetime.datetime | Unset |
EventsApiSubscriptionsUpdateBatchingSettings
Field | Type |
|---|---|
max_batch_size | int | None | Unset |
max_batch_interval_seconds | int | None | Unset |
EventsApiSubscriptionsUpdateBatchingSettingsResponse
Field | Type |
|---|---|
max_batch_size | int | None | Unset |
max_batch_interval_seconds | int | None | Unset |
EventsApiSubscriptionsUpdateHistoricalSettingsResponse
Field | Type |
|---|---|
enabled | bool | Unset |
start_time | datetime.datetime | None | Unset |
end_time | datetime.datetime | None | Unset |
from_event_id | int | None | Unset |
cutoff_sequence | int | None | Unset |
backfill_state | EventsApiSubscribersHistoricalBackfillState | None | Unset |
EventsApiSubscriptionsUpdateRequest
Request to update a subscription
Field | Type |
|---|---|
subscriber_id | str |
subscription_id | str |
simple_filter | None | str | Unset |
complex_filter_id | None | str | Unset |
batching | EventsApiSubscriptionsUpdateBatchingSettings | None | Unset |
EventsApiSubscriptionsUpdateResponse
Response from updating a subscription
Field | Type |
|---|---|
subscription_id | str | Unset |
simple_filter | None | str | Unset |
complex_filter_id | None | str | Unset |
batching | EventsApiSubscriptionsUpdateBatchingSettingsResponse | None | Unset |
historical | EventsApiSubscriptionsUpdateHistoricalSettingsResponse | None | Unset |
date_last_modified | datetime.datetime | Unset |
FastEndpointsErrorResponse
the dto used to send an error response to the client
Field | Type |
|---|---|
status_code | int | Unset |
message | str | Unset |
errors | FastEndpointsErrorResponseErrors | Unset |
FastEndpointsErrorResponseErrors
the collection of errors for the current context
Field | Type |
|---|---|
additional_properties | dict[str, list[str]] |
additional_keys | list[str] |