Documentation | Files › import_from

Files

FilesResource

Methods

client.files.create() ->

File

post/v5/files

Upload File

client.files.import_from_cloud() ->

FileImportFromCloudResponse

post/v5/files/cloud_imports

Import files from existing blob storage in cloud (batch operation)

Parameters

files:

Iterable

[

File

]

List of files to import from cloud storage

container: str

The cloud storage container/bucket name

file_type: str

The MIME type of the file

filename: str

The name of the file

filepath: str

The path to the file within the container

Returns

class FileImportFromCloudResponse:

results: List[

Result

]

Results for each file import attempt

Request example

import os
from scale_gp_beta import SGPClient

client = SGPClient(
    api_key=os.environ.get("SGP_API_KEY"),  # This is the default and can be omitted
)
response = client.files.import_from_cloud(
    files=[{
        "container": "container",
        "file_type": "file_type",
        "filename": "filename",
        "filepath": "filepath",
    }],
)
print(response.results)

200Example

{
  "results": [
    {
      "file": {
        "id": "id",
        "created_at": "2019-12-27T18:11:19.117Z",
        "created_by": {
          "id": "id",
          "type": "user",
          "object": "identity"
        },
        "filename": "filename",
        "md5_checksum": "md5_checksum",
        "mime_type": "mime_type",
        "size": 0,
        "duration_seconds": 0,
        "object": "file",
        "tags": {
          "foo": "bar"
        }
      },
      "status": "SUCCESS"
    }
  ]
}