Struct PackLogContext

pub struct PackLogContext {

    pub additional_metadata: Map<String, Value>,
    pub autocomplete_parameter_name: Option<String>,
    pub connection_id: String,
    pub created_at: DateTime<Utc>,
    pub details_key: String,
    pub doc_column_id: Option<String>,
    pub doc_id: String,
    pub doc_object_id: Option<String>,
    pub doc_row_id: Option<String>,
    pub formula_name: String,
    pub ingestion_execution_attempt: Option<i64>,
    pub ingestion_execution_id: Option<String>,
    pub ingestion_id: Option<String>,
    pub ingestion_parent_item_id: Option<String>,
    pub ingestion_parent_stage: Option<String>,
    pub ingestion_process_id: Option<String>,
    pub ingestion_stage: Option<String>,
    pub invocation_source: Option<String>,
    pub is_continued_sync_table: Option<bool>,
    pub is_sync_table: Option<bool>,
    pub log_id: String,
    pub pack_id: String,
    pub pack_version: String,
    pub request_id: String,
    pub request_type: PackLogRequestType,
    pub root_ingestion_id: Option<String>,
    pub user_id: String,
}

Logging context that comes with a Pack log.

JSON schema

{
 "description": "Logging context that comes with a Pack log.",
 "type": "object",
 "required": [
   "connectionId",
   "createdAt",
   "detailsKey",
   "docId",
   "formulaName",
   "logId",
   "packId",
   "packVersion",
   "requestId",
   "requestType",
   "userId"
 ],
 "properties": {
   "additionalMetadata": {
     "description": "Additional metadata for the ingestion log.",
     "type": "object"
   },
   "autocompleteParameterName": {
     "description": "If this formula invocation was for a parameter
auto-complete, this names the parameter.",
     "type": "string"
   },
   "connectionId": {
     "type": "string"
   },
   "createdAt": {
     "description": "Creation time of the log.",
     "examples": [
       "2018-04-11T00:18:57.946Z"
     ],
     "type": "string",
     "format": "date-time"
   },
   "detailsKey": {
     "description": "Key to be used in fetching log details.",
     "type": "string"
   },
   "docColumnId": {
     "description": "Doc canvas column id where the formula was fired
from.",
     "type": "string"
   },
   "docId": {
     "type": "string"
   },
   "docObjectId": {
     "description": "Doc canvas object id where the formula was fired
from.",
     "type": "string"
   },
   "docRowId": {
     "description": "Doc canvas row id where the formula was fired
from.",
     "type": "string"
   },
   "formulaName": {
     "type": "string"
   },
   "ingestionExecutionAttempt": {
     "description": "Execution attempt for this ingestion log.",
     "type": "integer"
   },
   "ingestionExecutionId": {
     "description": "Unique identifier of the ingestion execution that
triggered this log.",
     "type": "string"
   },
   "ingestionId": {
     "description": "Unique identifier of the ingestion that triggered
this log.",
     "type": "string"
   },
   "ingestionParentItemId": {
     "description": "Parent item id for this ingestion log.",
     "type": "string"
   },
   "ingestionParentStage": {
     "description": "An ingestion lifecycle stage that this ingestion
log is bundled under.",
     "type": "string"
   },
   "ingestionProcessId": {
     "description": "Unique identifier of the ingestion processing call
that triggered this log.",
     "type": "string"
   },
   "ingestionStage": {
     "description": "Stage along the ingestion lifecycle that this log
was created in.",
     "type": "string"
   },
   "invocationSource": {
     "description": "If this formula was invoked by something other than
a user action, this should say what that was.",
     "type": "string"
   },
   "isContinuedSyncTable": {
     "description": "True if this is an execution of a sync table which
received a pagination parameter.",
     "type": "boolean"
   },
   "isSyncTable": {
     "description": "True if this is a formula invocation loading a page
of a sync table, or metadata for a sync table (like creating a dynamic
schema).",
     "type": "boolean"
   },
   "logId": {
     "description": "Unique identifier of this log record.",
     "type": "string"
   },
   "packId": {
     "type": "string"
   },
   "packVersion": {
     "type": "string"
   },
   "requestId": {
     "description": "A unique identifier of the Pack invocation that can
be used to associate all log types generated in one call of a Pack
formula.\n",
     "type": "string"
   },
   "requestType": {
     "$ref": "#/components/schemas/PackLogRequestType"
   },
   "rootIngestionId": {
     "description": "Unique identifier of the root ingestion that
triggered this log.",
     "type": "string"
   },
   "userId": {
     "type": "string"
   }
 },
 "additionalProperties": false,
 "x-schema-name": "PackLogContext"
}

Fields

additional_metadata: Map<String, Value>

Additional metadata for the ingestion log.

autocomplete_parameter_name: Option<String>

If this formula invocation was for a parameter auto-complete, this names the parameter.

connection_id: String

created_at: DateTime<Utc>

Creation time of the log.

details_key: String

Key to be used in fetching log details.

doc_column_id: Option<String>

Doc canvas column id where the formula was fired from.

doc_id: String

doc_object_id: Option<String>

Doc canvas object id where the formula was fired from.

doc_row_id: Option<String>

Doc canvas row id where the formula was fired from.

formula_name: String

ingestion_execution_attempt: Option<i64>

Execution attempt for this ingestion log.

ingestion_execution_id: Option<String>

Unique identifier of the ingestion execution that triggered this log.

ingestion_id: Option<String>

Unique identifier of the ingestion that triggered this log.

ingestion_parent_item_id: Option<String>

Parent item id for this ingestion log.

ingestion_parent_stage: Option<String>

An ingestion lifecycle stage that this ingestion log is bundled under.

ingestion_process_id: Option<String>

Unique identifier of the ingestion processing call that triggered this log.

ingestion_stage: Option<String>

Stage along the ingestion lifecycle that this log was created in.

invocation_source: Option<String>

If this formula was invoked by something other than a user action, this should say what that was.

is_continued_sync_table: Option<bool>

True if this is an execution of a sync table which received a pagination parameter.

is_sync_table: Option<bool>

True if this is a formula invocation loading a page of a sync table, or metadata for a sync table (like creating a dynamic schema).

log_id: String

Unique identifier of this log record.

pack_id: String

pack_version: String

request_id: String

A unique identifier of the Pack invocation that can be used to associate all log types generated in one call of a Pack formula.

request_type: PackLogRequestType

root_ingestion_id: Option<String>

Unique identifier of the root ingestion that triggered this log.

user_id: String

Trait Implementations

impl Clone for PackLogContext

fn clone(&self) -> PackLogContext

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PackLogContext

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PackLogContext

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&PackLogContext> for PackLogContext

fn from(value: &PackLogContext) -> Self

Converts to this type from the input type.

impl Serialize for PackLogContext

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.