KnowledgeBaseResourceFileStatusItem

pydantic model openapi_client.models.knowledge_base_resource_file_status_item.KnowledgeBaseResourceFileStatusItem

KnowledgeBaseResourceFileStatusItem

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

File name (last path segment of the catalog file key).

field file_status: Optional[StrictStr] = None (alias 'FileStatus')

Per-KB indexing status from IndexingStatus. NOT_INDEXED if unset. Sync writes values such as IN_PROGRESS, COMPLETE, FAILED, or ERROR.

field dataset_name: Optional[StrictStr] = None (alias 'DatasetName')

Dataset name parsed from the catalog file path.

field file_path: Optional[StrictStr] = None (alias 'FilePath')

s3:// URI of the file in the DLZ bucket.

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 KnowledgeBaseResourceFileStatusItem 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 KnowledgeBaseResourceFileStatusItem from a dict

Return type:

Optional[Self]