Skip to content

ConnectorFileTransferResult

Source code in docs_src/capo_transfer/types/connector_file_transfer_result.py 
16
17
18
19
20
21
22
23
24
class ConnectorFileTransferResult(TypedDict, closed=True):
    file_path: "capo_transfer.types.file_path.FilePath"
    """<p>The filename and path to where the file was sent to or retrieved from.</p>"""
    status_code: "capo_transfer.types.transfer_table_status.TransferTableStatus"
    """<p>The current status for the transfer.</p>"""
    failure_code: NotRequired["capo_transfer.types.failure_code.FailureCode"]
    """<p>For transfers that fail, this parameter contains a code indicating the reason. For example, <code>RETRIEVE_FILE_NOT_FOUND</code> </p>"""
    failure_message: NotRequired["capo_transfer.types.message.Message"]
    """<p>For transfers that fail, this parameter describes the reason for the failure.</p>"""

failure_code instance-attribute 

failure_code: NotRequired[FailureCode]

For transfers that fail, this parameter contains a code indicating the reason. For example, RETRIEVE_FILE_NOT_FOUND

failure_message instance-attribute 

failure_message: NotRequired[Message]

For transfers that fail, this parameter describes the reason for the failure.

file_path instance-attribute 

file_path: FilePath

The filename and path to where the file was sent to or retrieved from.

status_code instance-attribute 

status_code: TransferTableStatus

The current status for the transfer.