FileStatus1

pydantic model openapi_client.models.file_status1.FileStatus1

One file-load record from the file status / file-loads table.

Fields:

• batch_status (str | None)

• current_state (str | None)

• dataset_id (str | None)

• file_name (str | None)

• file_size (int | None)

• is_sync_required (bool | None)

• last_modified (str | None)

• last_modified_by (str | None)

• load_status (str | None)

• message (str | None)

• pending_files_exist (str | None)

• s3_insert_time (str | None)

• state_machine_execution_id (str | None)

• user_id (str | None)

• user_principal_id (str | None)

field file_name: Optional[StrictStr] = None (alias 'FileName')

File-load key for the object (typically {Domain}/{DatasetName}/upload_date={epoch}/{UserId}_{DatasetId}_{epoch}_{FileNameWithExtension}).

field dataset_id: Optional[StrictStr] = None (alias 'DatasetId')

Dataset ID this file-load belongs to.

field load_status: Optional[StrictStr] = None (alias 'LoadStatus')

High-level load outcome. On get_dataload_status responses, only completed, failed, or processing appear (bucketed accordingly). pending exists on stored items but is not queried by this API.

field user_id: Optional[StrictStr] = None (alias 'UserId')

User who uploaded or last associated with the file load.

field message: Optional[StrictStr] = None (alias 'Message')

Human-readable status or error detail for the load.

field last_modified: Optional[StrictStr] = None (alias 'LastModified')

Last modification timestamp for the file-load record.

field last_modified_by: Optional[StrictStr] = None (alias 'LastModifiedBy')

User or system principal that last updated the record.

field user_principal_id: Optional[StrictStr] = None (alias 'UserPrincipalId')

Principal / uploader identity associated with the S3 upload when present.

field current_state: Optional[StrictStr] = None (alias 'CurrentState')

Finer-grained pipeline stage or sub-status for the file (beyond LoadStatus), including dataload and data-reload stages.

field s3_insert_time: Optional[StrictStr] = None (alias 'S3InsertTime')

Time the object was recorded as inserted into S3 / LZ when present.

field file_size: Optional[StrictInt] = None (alias 'FileSize')

Size of the file in bytes when recorded.

field state_machine_execution_id: Optional[StrictStr] = None (alias 'StateMachineExecutionId')

Step Functions execution id for the load workflow when present.

field pending_files_exist: Optional[StrictStr] = None (alias 'PendingFilesExist')

Whether pending files were flagged for the related load workflow.

field is_sync_required: Optional[StrictBool] = None (alias 'IsSyncRequired')

Whether a sync step is required for this file-load item.

field batch_status: Optional[StrictStr] = None (alias 'BatchStatus')

Batch-level status when the file participates in a batched load.

to_str()

Returns the string representation of the model using alias

Return type:

str

to_json()

Returns the JSON representation of the model using alias

Return type:

str

classmethod from_json(json_str)

Create an instance of FileStatus1 from a JSON string

Return type:

Optional[Self]

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

Return type:

Dict[str, Any]

classmethod from_dict(obj)

Create an instance of FileStatus1 from a dict

Return type:

Optional[Self]