saturn_api.ObjectStorageApi

All URIs are relative to http://localhost

Method	HTTP request	Description
cancel_upload	DELETE /api/object_storage/upload/{object_storage_upload_id}	Cancel object storage upload
complete_upload	POST /api/object_storage/upload/{object_storage_upload_id}	Complete object storage upload
delete	DELETE /api/object_storage/delete	Delete object storage
delete_bulk	DELETE /api/object_storage/bulk_delete	Delete multiple object storage
download	POST /api/object_storage/download	Download object storage
download_bulk	POST /api/object_storage/bulk_download	Download bulk object storage
get_usage	GET /api/object_storage/usage	Get object storage usage stats
list	GET /api/object_storage	List object storage
list_shared	GET /api/object_storage/shared	List shared object storage
list_uploads	GET /api/object_storage/upload	List object storage uploads
resume_upload	GET /api/object_storage/upload/{object_storage_upload_id}	Resume object storage upload
upload	POST /api/object_storage/upload	Create object storage upload

cancel_upload

cancel_upload(object_storage_upload_id)

Cancel object storage upload

Example

Bearer Authentication (bearerAuth):

import saturn_api
from saturn_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to the SATURN_BASE_URL env or http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = saturn_api.Configuration(
    host = os.getenv("SATURN_BASE_URL", "http://localhost")
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth, defaults to the SATURN_TOKEN env
configuration = saturn_api.Configuration(
    access_token = os.environ["SATURN_TOKEN"]
)

# Enter a context with an instance of the API client
async with saturn_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = saturn_api.ObjectStorageApi(api_client)
    object_storage_upload_id = 'object_storage_upload_id_example' # str | 

    try:
        # Cancel object storage upload
        await api_instance.cancel_upload(object_storage_upload_id)
    except Exception as e:
        print("Exception when calling ObjectStorageApi->cancel_upload: %s\n" % e)

Parameters

Name	Type	Description	Notes
object_storage_upload_id	str

Return type

void (empty response body)

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	Canceled	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

complete_upload

complete_upload(object_storage_upload_id, object_storage_completed_upload)

Complete object storage upload

Example

Bearer Authentication (bearerAuth):

import saturn_api
from saturn_api.models.object_storage_completed_upload import ObjectStorageCompletedUpload
from saturn_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to the SATURN_BASE_URL env or http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = saturn_api.Configuration(
    host = os.getenv("SATURN_BASE_URL", "http://localhost")
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth, defaults to the SATURN_TOKEN env
configuration = saturn_api.Configuration(
    access_token = os.environ["SATURN_TOKEN"]
)

# Enter a context with an instance of the API client
async with saturn_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = saturn_api.ObjectStorageApi(api_client)
    object_storage_upload_id = 'object_storage_upload_id_example' # str | 
    object_storage_completed_upload = saturn_api.ObjectStorageCompletedUpload() # ObjectStorageCompletedUpload | 

    try:
        # Complete object storage upload
        await api_instance.complete_upload(object_storage_upload_id, object_storage_completed_upload)
    except Exception as e:
        print("Exception when calling ObjectStorageApi->complete_upload: %s\n" % e)

Parameters

Name	Type	Description	Notes
object_storage_upload_id	str
object_storage_completed_upload	ObjectStorageCompletedUpload

Return type

void (empty response body)

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	Completed	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete

delete(object_storage_reference)

Delete object storage

Example

Bearer Authentication (bearerAuth):

import saturn_api
from saturn_api.models.object_storage_reference import ObjectStorageReference
from saturn_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to the SATURN_BASE_URL env or http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = saturn_api.Configuration(
    host = os.getenv("SATURN_BASE_URL", "http://localhost")
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth, defaults to the SATURN_TOKEN env
configuration = saturn_api.Configuration(
    access_token = os.environ["SATURN_TOKEN"]
)

# Enter a context with an instance of the API client
async with saturn_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = saturn_api.ObjectStorageApi(api_client)
    object_storage_reference = saturn_api.ObjectStorageReference() # ObjectStorageReference | 

    try:
        # Delete object storage
        await api_instance.delete(object_storage_reference)
    except Exception as e:
        print("Exception when calling ObjectStorageApi->delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
object_storage_reference	ObjectStorageReference

Return type

void (empty response body)

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	Deleted	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_bulk

ObjectStorageBulkDeleteResults delete_bulk(object_storage_bulk_reference)

Delete multiple object storage

Example

Bearer Authentication (bearerAuth):

import saturn_api
from saturn_api.models.object_storage_bulk_delete_results import ObjectStorageBulkDeleteResults
from saturn_api.models.object_storage_bulk_reference import ObjectStorageBulkReference
from saturn_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to the SATURN_BASE_URL env or http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = saturn_api.Configuration(
    host = os.getenv("SATURN_BASE_URL", "http://localhost")
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth, defaults to the SATURN_TOKEN env
configuration = saturn_api.Configuration(
    access_token = os.environ["SATURN_TOKEN"]
)

# Enter a context with an instance of the API client
async with saturn_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = saturn_api.ObjectStorageApi(api_client)
    object_storage_bulk_reference = saturn_api.ObjectStorageBulkReference() # ObjectStorageBulkReference | 

    try:
        # Delete multiple object storage
        api_response = await api_instance.delete_bulk(object_storage_bulk_reference)
        print("The response of ObjectStorageApi->delete_bulk:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectStorageApi->delete_bulk: %s\n" % e)

Parameters

Name	Type	Description	Notes
object_storage_bulk_reference	ObjectStorageBulkReference

Return type

ObjectStorageBulkDeleteResults

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Deleted	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

download

ObjectStoragePresignedDownload download(object_storage_reference)

Download object storage

Create a presigned download URL for a file.

Example

Bearer Authentication (bearerAuth):

import saturn_api
from saturn_api.models.object_storage_presigned_download import ObjectStoragePresignedDownload
from saturn_api.models.object_storage_reference import ObjectStorageReference
from saturn_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to the SATURN_BASE_URL env or http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = saturn_api.Configuration(
    host = os.getenv("SATURN_BASE_URL", "http://localhost")
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth, defaults to the SATURN_TOKEN env
configuration = saturn_api.Configuration(
    access_token = os.environ["SATURN_TOKEN"]
)

# Enter a context with an instance of the API client
async with saturn_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = saturn_api.ObjectStorageApi(api_client)
    object_storage_reference = saturn_api.ObjectStorageReference() # ObjectStorageReference | 

    try:
        # Download object storage
        api_response = await api_instance.download(object_storage_reference)
        print("The response of ObjectStorageApi->download:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectStorageApi->download: %s\n" % e)

Parameters

Name	Type	Description	Notes
object_storage_reference	ObjectStorageReference

Return type

ObjectStoragePresignedDownload

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Ok	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

download_bulk

ObjectStorageBulkDownload download_bulk(object_storage_bulk_reference)

Download bulk object storage

Create presigned download URLs for multiple files.

Example

Bearer Authentication (bearerAuth):

import saturn_api
from saturn_api.models.object_storage_bulk_download import ObjectStorageBulkDownload
from saturn_api.models.object_storage_bulk_reference import ObjectStorageBulkReference
from saturn_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to the SATURN_BASE_URL env or http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = saturn_api.Configuration(
    host = os.getenv("SATURN_BASE_URL", "http://localhost")
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth, defaults to the SATURN_TOKEN env
configuration = saturn_api.Configuration(
    access_token = os.environ["SATURN_TOKEN"]
)

# Enter a context with an instance of the API client
async with saturn_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = saturn_api.ObjectStorageApi(api_client)
    object_storage_bulk_reference = saturn_api.ObjectStorageBulkReference() # ObjectStorageBulkReference | 

    try:
        # Download bulk object storage
        api_response = await api_instance.download_bulk(object_storage_bulk_reference)
        print("The response of ObjectStorageApi->download_bulk:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectStorageApi->download_bulk: %s\n" % e)

Parameters

Name	Type	Description	Notes
object_storage_bulk_reference	ObjectStorageBulkReference

Return type

ObjectStorageBulkDownload

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Ok	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_usage

ObjectStorageUsageStats get_usage(owner_name=owner_name, owner_id=owner_id, user_id=user_id, group_id=group_id, org_id=org_id, owner=owner)

Get object storage usage stats

Example

Bearer Authentication (bearerAuth):

import saturn_api
from saturn_api.models.object_storage_usage_stats import ObjectStorageUsageStats
from saturn_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to the SATURN_BASE_URL env or http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = saturn_api.Configuration(
    host = os.getenv("SATURN_BASE_URL", "http://localhost")
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth, defaults to the SATURN_TOKEN env
configuration = saturn_api.Configuration(
    access_token = os.environ["SATURN_TOKEN"]
)

# Enter a context with an instance of the API client
async with saturn_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = saturn_api.ObjectStorageApi(api_client)
    owner_name = 'owner_name_example' # str | Reference owner by name. (optional)
    owner_id = 'owner_id_example' # str | Reference owner by ID. (optional)
    user_id = 'user_id_example' # str | Reference owner by user ID. (optional)
    group_id = 'group_id_example' # str | Reference owner by group ID. (optional)
    org_id = 'org_id_example' # str | Reference owner by org ID. (optional)
    owner = 'owner_example' # str | Reference owner by name. (optional)

    try:
        # Get object storage usage stats
        api_response = await api_instance.get_usage(owner_name=owner_name, owner_id=owner_id, user_id=user_id, group_id=group_id, org_id=org_id, owner=owner)
        print("The response of ObjectStorageApi->get_usage:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectStorageApi->get_usage: %s\n" % e)

Parameters

Name	Type	Description	Notes
owner_name	str	Reference owner by name.	[optional]
owner_id	str	Reference owner by ID.	[optional]
user_id	str	Reference owner by user ID.	[optional]
group_id	str	Reference owner by group ID.	[optional]
org_id	str	Reference owner by org ID.	[optional]
owner	str	Reference owner by name.	[optional]

Return type

ObjectStorageUsageStats

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Ok	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list

ObjectStorageList list(owner_name=owner_name, owner_id=owner_id, user_id=user_id, group_id=group_id, org_id=org_id, owner=owner, prefix=prefix, last_key=last_key, max_keys=max_keys, delimited=delimited)

List object storage

Paginated list of object storage.

Example

Bearer Authentication (bearerAuth):

import saturn_api
from saturn_api.models.object_storage_list import ObjectStorageList
from saturn_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to the SATURN_BASE_URL env or http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = saturn_api.Configuration(
    host = os.getenv("SATURN_BASE_URL", "http://localhost")
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth, defaults to the SATURN_TOKEN env
configuration = saturn_api.Configuration(
    access_token = os.environ["SATURN_TOKEN"]
)

# Enter a context with an instance of the API client
async with saturn_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = saturn_api.ObjectStorageApi(api_client)
    owner_name = 'owner_name_example' # str | Reference owner by name. (optional)
    owner_id = 'owner_id_example' # str | Reference owner by ID. (optional)
    user_id = 'user_id_example' # str | Reference owner by user ID. (optional)
    group_id = 'group_id_example' # str | Reference owner by group ID. (optional)
    org_id = 'org_id_example' # str | Reference owner by org ID. (optional)
    owner = 'owner_example' # str | Reference owner by name. (optional)
    prefix = '' # str | Prefix matched search string on object storage file path. (optional) (default to '')
    last_key = 'last_key_example' # str | Last seen key for pagination. (optional)
    max_keys = 1000 # int | Page size. (optional) (default to 1000)
    delimited = True # bool | Delimit results by directory. (optional) (default to True)

    try:
        # List object storage
        api_response = await api_instance.list(owner_name=owner_name, owner_id=owner_id, user_id=user_id, group_id=group_id, org_id=org_id, owner=owner, prefix=prefix, last_key=last_key, max_keys=max_keys, delimited=delimited)
        print("The response of ObjectStorageApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectStorageApi->list: %s\n" % e)

Parameters

Name	Type	Description	Notes
owner_name	str	Reference owner by name.	[optional]
owner_id	str	Reference owner by ID.	[optional]
user_id	str	Reference owner by user ID.	[optional]
group_id	str	Reference owner by group ID.	[optional]
org_id	str	Reference owner by org ID.	[optional]
owner	str	Reference owner by name.	[optional]
prefix	str	Prefix matched search string on object storage file path.	[optional] [default to '']
last_key	str	Last seen key for pagination.	[optional]
max_keys	int	Page size.	[optional] [default to 1000]
delimited	bool	Delimit results by directory.	[optional] [default to True]

Return type

ObjectStorageList

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Ok	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_shared

ObjectStorageSharedOwnerList list_shared(owner_name=owner_name, owner_id=owner_id, user_id=user_id, group_id=group_id, org_id=org_id, owner=owner, last_key=last_key, max_keys=max_keys)

List shared object storage

List owners that have shared object storage accessible to the given owner.

Example

Bearer Authentication (bearerAuth):

import saturn_api
from saturn_api.models.object_storage_shared_owner_list import ObjectStorageSharedOwnerList
from saturn_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to the SATURN_BASE_URL env or http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = saturn_api.Configuration(
    host = os.getenv("SATURN_BASE_URL", "http://localhost")
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth, defaults to the SATURN_TOKEN env
configuration = saturn_api.Configuration(
    access_token = os.environ["SATURN_TOKEN"]
)

# Enter a context with an instance of the API client
async with saturn_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = saturn_api.ObjectStorageApi(api_client)
    owner_name = 'owner_name_example' # str | Reference owner by name. (optional)
    owner_id = 'owner_id_example' # str | Reference owner by ID. (optional)
    user_id = 'user_id_example' # str | Reference owner by user ID. (optional)
    group_id = 'group_id_example' # str | Reference owner by group ID. (optional)
    org_id = 'org_id_example' # str | Reference owner by org ID. (optional)
    owner = 'owner_example' # str | Reference owner by name. (optional)
    last_key = 'last_key_example' # str | Last seen key for pagination. (optional)
    max_keys = 1000 # int | Page size. (optional) (default to 1000)

    try:
        # List shared object storage
        api_response = await api_instance.list_shared(owner_name=owner_name, owner_id=owner_id, user_id=user_id, group_id=group_id, org_id=org_id, owner=owner, last_key=last_key, max_keys=max_keys)
        print("The response of ObjectStorageApi->list_shared:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectStorageApi->list_shared: %s\n" % e)

Parameters

Name	Type	Description	Notes
owner_name	str	Reference owner by name.	[optional]
owner_id	str	Reference owner by ID.	[optional]
user_id	str	Reference owner by user ID.	[optional]
group_id	str	Reference owner by group ID.	[optional]
org_id	str	Reference owner by org ID.	[optional]
owner	str	Reference owner by name.	[optional]
last_key	str	Last seen key for pagination.	[optional]
max_keys	int	Page size.	[optional] [default to 1000]

Return type

ObjectStorageSharedOwnerList

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Ok	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_uploads

ObjectStorageUploadList list_uploads(owner_name=owner_name, owner_id=owner_id, user_id=user_id, group_id=group_id, org_id=org_id, owner=owner, prefix=prefix, is_copy=is_copy)

List object storage uploads

Example

Bearer Authentication (bearerAuth):

import saturn_api
from saturn_api.models.object_storage_upload_list import ObjectStorageUploadList
from saturn_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to the SATURN_BASE_URL env or http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = saturn_api.Configuration(
    host = os.getenv("SATURN_BASE_URL", "http://localhost")
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth, defaults to the SATURN_TOKEN env
configuration = saturn_api.Configuration(
    access_token = os.environ["SATURN_TOKEN"]
)

# Enter a context with an instance of the API client
async with saturn_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = saturn_api.ObjectStorageApi(api_client)
    owner_name = 'owner_name_example' # str | Reference owner by name. (optional)
    owner_id = 'owner_id_example' # str | Reference owner by ID. (optional)
    user_id = 'user_id_example' # str | Reference owner by user ID. (optional)
    group_id = 'group_id_example' # str | Reference owner by group ID. (optional)
    org_id = 'org_id_example' # str | Reference owner by org ID. (optional)
    owner = 'owner_example' # str | Reference owner by name. (optional)
    prefix = '' # str | Prefix matched search string on object storage upload file path (optional) (default to '')
    is_copy = True # bool | Filter object storage uploads that are or aren't copy operations. (optional)

    try:
        # List object storage uploads
        api_response = await api_instance.list_uploads(owner_name=owner_name, owner_id=owner_id, user_id=user_id, group_id=group_id, org_id=org_id, owner=owner, prefix=prefix, is_copy=is_copy)
        print("The response of ObjectStorageApi->list_uploads:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectStorageApi->list_uploads: %s\n" % e)

Parameters

Name	Type	Description	Notes
owner_name	str	Reference owner by name.	[optional]
owner_id	str	Reference owner by ID.	[optional]
user_id	str	Reference owner by user ID.	[optional]
group_id	str	Reference owner by group ID.	[optional]
org_id	str	Reference owner by org ID.	[optional]
owner	str	Reference owner by name.	[optional]
prefix	str	Prefix matched search string on object storage upload file path	[optional] [default to '']
is_copy	bool	Filter object storage uploads that are or aren't copy operations.	[optional]

Return type

ObjectStorageUploadList

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Ok	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

resume_upload

ObjectStoragePresignedUpload resume_upload(object_storage_upload_id, first_part=first_part, last_part=last_part, last_part_size=last_part_size)

Resume object storage upload

Example

Bearer Authentication (bearerAuth):

import saturn_api
from saturn_api.models.object_storage_presigned_upload import ObjectStoragePresignedUpload
from saturn_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to the SATURN_BASE_URL env or http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = saturn_api.Configuration(
    host = os.getenv("SATURN_BASE_URL", "http://localhost")
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth, defaults to the SATURN_TOKEN env
configuration = saturn_api.Configuration(
    access_token = os.environ["SATURN_TOKEN"]
)

# Enter a context with an instance of the API client
async with saturn_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = saturn_api.ObjectStorageApi(api_client)
    object_storage_upload_id = 'object_storage_upload_id_example' # str | 
    first_part = 1 # int | Index of the first part to retrieve presigned upload URLs for. (optional) (default to 1)
    last_part = 56 # int | Index of the last part to retrieve presigned upload URLs for. (optional)
    last_part_size = 56 # int | Final part size for uploads with unspecified total size. (optional)

    try:
        # Resume object storage upload
        api_response = await api_instance.resume_upload(object_storage_upload_id, first_part=first_part, last_part=last_part, last_part_size=last_part_size)
        print("The response of ObjectStorageApi->resume_upload:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectStorageApi->resume_upload: %s\n" % e)

Parameters

Name	Type	Description	Notes
object_storage_upload_id	str
first_part	int	Index of the first part to retrieve presigned upload URLs for.	[optional] [default to 1]
last_part	int	Index of the last part to retrieve presigned upload URLs for.	[optional]
last_part_size	int	Final part size for uploads with unspecified total size.	[optional]

Return type

ObjectStoragePresignedUpload

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Ok	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

upload

ObjectStoragePresignedUpload upload(object_storage_upload_create)

Create object storage upload

Example

Bearer Authentication (bearerAuth):

import saturn_api
from saturn_api.models.object_storage_presigned_upload import ObjectStoragePresignedUpload
from saturn_api.models.object_storage_upload_create import ObjectStorageUploadCreate
from saturn_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to the SATURN_BASE_URL env or http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = saturn_api.Configuration(
    host = os.getenv("SATURN_BASE_URL", "http://localhost")
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth, defaults to the SATURN_TOKEN env
configuration = saturn_api.Configuration(
    access_token = os.environ["SATURN_TOKEN"]
)

# Enter a context with an instance of the API client
async with saturn_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = saturn_api.ObjectStorageApi(api_client)
    object_storage_upload_create = saturn_api.ObjectStorageUploadCreate() # ObjectStorageUploadCreate | 

    try:
        # Create object storage upload
        api_response = await api_instance.upload(object_storage_upload_create)
        print("The response of ObjectStorageApi->upload:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectStorageApi->upload: %s\n" % e)

Parameters

Name	Type	Description	Notes
object_storage_upload_create	ObjectStorageUploadCreate

Return type

ObjectStoragePresignedUpload

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Created	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

ObjectStorageApi.md

Latest commit

History

ObjectStorageApi.md

File metadata and controls

saturn_api.ObjectStorageApi

cancel_upload

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

complete_upload

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_bulk

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

download

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

download_bulk

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_usage

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_shared

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_uploads

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

resume_upload

Example

Parameters