Skip to content

FileImportResource

API Access class for file imports

Source code in src/specklepy/api/resources/current/file_import_resource.py 
20
21
22
23
24
25
26
def __init__(self, account, basepath, client, server_version) -> None:
    super().__init__(
        account=account,
        basepath=basepath,
        client=client,
        server_version=server_version,
    )

start_file_import 

start_file_import(
    input: StartFileImportInput,
) -> FileImport
Source code in src/specklepy/api/resources/current/file_import_resource.py 
28
29
30
31
@override
def start_file_import(self, input: StartFileImportInput) -> FileImport:
    metrics.track(metrics.SDK, self.account, {"name": "File Import Start"})
    return super().start_file_import(input)

generate_upload_url 

generate_upload_url(
    input: GenerateFileUploadUrlInput,
) -> FileUploadUrl

Get a file upload url from the Speckle server.

This method asks the server to create a pre-signed S3 url, which can be used as a short term authenticated route, to put a file to the server.

Source code in src/specklepy/api/resources/current/file_import_resource.py 
33
34
35
36
37
38
39
40
41
42
43
44
45
@override
def generate_upload_url(self, input: GenerateFileUploadUrlInput) -> FileUploadUrl:
    """
    Get a file upload url from the Speckle server.

    This method asks the server to create a pre-signed S3 url,
    which can be used as a short term authenticated route,
    to put a file to the server.
    """
    metrics.track(
        metrics.SDK, self.account, {"name": "File Import Generate Upload Url"}
    )
    return super().generate_upload_url(input)

upload_file 

upload_file(file: Path, url: str) -> UploadFileResponse

Uploads a file to the given S3 url.

This method should be used together with the generate_upload_url method, which generates a pre-signed S3 url, that can be used to upload the file to.

Source code in src/specklepy/api/resources/current/file_import_resource.py 
47
48
49
50
51
52
53
54
55
56
@override
def upload_file(self, file: Path, url: str) -> UploadFileResponse:
    """
    Uploads a file to the given S3 url.

    This method should be used together with the generate_upload_url method,
    which generates a pre-signed S3 url, that can be used to upload the file to.
    """
    metrics.track(metrics.SDK, self.account, {"name": "File Import Upload File"})
    return super().upload_file(file, url)

download_file 

download_file(
    project_id: str, file_id: str, target_file: Path
) -> Path

Download a file blob attached to the project, to the target path.

Source code in src/specklepy/api/resources/current/file_import_resource.py 
58
59
60
61
62
@override
def download_file(self, project_id: str, file_id: str, target_file: Path) -> Path:
    """Download a file blob attached to the project, to the target path."""
    metrics.track(metrics.SDK, self.account, {"name": "File Import Download File"})
    return super().download_file(project_id, file_id, target_file)

finish_file_import_job 

finish_file_import_job(
    input: FinishFileImportInput,
) -> bool

This is mostly an internal api, that marks a file import job finished.

Only use this if you are writing a file importer, that is responsible for processing file import jobs.

Source code in src/specklepy/api/resources/current/file_import_resource.py 
64
65
66
67
68
69
70
71
72
73
@override
def finish_file_import_job(self, input: FinishFileImportInput) -> bool:
    """
    This is mostly an internal api, that marks a file import job finished.

    Only use this if you are writing a file importer, that is responsible for
    processing file import jobs.
    """
    metrics.track(metrics.SDK, self.account, {"name": "File Import Finish Job"})
    return super().finish_file_import_job(input)

get_model_file_import_jobs 

get_model_file_import_jobs(
    *,
    project_id: str,
    model_id: str,
    limit: int = 25,
    cursor: str | None = None,
) -> ResourceCollection[FileImport]
Source code in src/specklepy/api/resources/current/file_import_resource.py 
75
76
77
78
79
80
81
82
83
84
85
86
87
@override
def get_model_file_import_jobs(
    self,
    *,
    project_id: str,
    model_id: str,
    limit: int = 25,
    cursor: str | None = None,
) -> ResourceCollection[FileImport]:
    metrics.track(metrics.SDK, self.account, {"name": "File Import Get Model Jobs"})
    return super().get_model_file_import_jobs(
        project_id=project_id, model_id=model_id, limit=limit, cursor=cursor
    )