Online Ingestion Result#

OnlineIngestionResult #

Metadata object used to provide Online Ingestion Batch Result information.

This class encapsulates the result of a single batch operation during online ingestion, including the ingestion ID, status, and number of rows processed.

online_ingestion_id `property` #

online_ingestion_id: int

Get the unique identifier for the online ingestion batch.

RETURNS	DESCRIPTION
`int`	The online ingestion batch ID. TYPE: `int`

rows `property` #

rows: int

Get the number of rows processed in this batch.

RETURNS	DESCRIPTION
`int`	The number of rows. TYPE: `int`

status `property` #

status: str

Get the status of the ingestion batch.

RETURNS	DESCRIPTION
`str`	The status of the batch (e.g., "UPSERTED", "FAILED"). TYPE: `str`

init #

__init__(
    online_ingestion_id: int = None,
    status: str = None,
    rows: int = None,
    **kwargs,
)

Initialize an OnlineIngestionResult object.

PARAMETER	DESCRIPTION
`online_ingestion_id`	The unique identifier for the online ingestion batch. TYPE: `int` DEFAULT: `None`
`status`	The status of the ingestion batch (e.g., "UPSERTED", "FAILED"). TYPE: `str` DEFAULT: `None`
`rows`	The number of rows processed in this batch. TYPE: `int` DEFAULT: `None`

from_response_json `classmethod` #

from_response_json(
    json_dict: dict[str, Any],
) -> OnlineIngestionResult

Create an OnlineIngestionResult object (or list of objects) from a JSON response.

PARAMETER	DESCRIPTION
`json_dict`	The JSON dictionary from the API response. TYPE: `Dict[str, Any]`

RETURNS	DESCRIPTION
`OnlineIngestionResult`	OnlineIngestionResult or List[OnlineIngestionResult] or None: The created object(s), or None if input is None.

json #

json()

Serialize the OnlineIngestionResult object to a JSON string.

RETURNS	DESCRIPTION
`str`	JSON string representation of the object.

to_dict #

to_dict()

Convert the OnlineIngestionResult object to a dictionary.

RETURNS	DESCRIPTION
`dict`	Dictionary representation of the object.

Online Ingestion Result#