Containers

interface Containers

Manages hosted containers and their files. Container creation can incur hosted resource charges. Default implementations preserve source compatibility for custom clients.

Inheritors

Functions

Link copied to clipboard
open suspend fun containerFilesPage(id: ContainerId, query: ContainerFileListQuery = ContainerFileListQuery(), requestOptions: RequestOptions? = null): PaginatedList<ContainerFile>

Lists container files with pagination metadata.

Link copied to clipboard
open suspend fun containersPage(query: ContainerListQuery = ContainerListQuery(), requestOptions: RequestOptions? = null): PaginatedList<Container>

Lists containers while preserving pagination cursors and the has-more indicator.

Link copied to clipboard
open suspend fun copyContainerFile(id: ContainerId, fileId: FileId, requestOptions: RequestOptions? = null): ContainerFile

Copies a regular File resource into the container using a JSON file_id request.

Link copied to clipboard
open suspend fun createContainer(request: ContainerRequest, requestOptions: RequestOptions? = null): Container

Creates a container with the requested files, skills and resource policy.

Link copied to clipboard
open suspend fun deleteContainer(id: ContainerId, requestOptions: RequestOptions? = null): Boolean

Deletes a container, returning false if it no longer exists.

Link copied to clipboard
open suspend fun deleteContainerFile(id: ContainerId, fileId: ContainerFileId, requestOptions: RequestOptions? = null): Boolean

Deletes a container file, returning false if it no longer exists.

Link copied to clipboard
open suspend fun downloadContainerFile(id: ContainerId, fileId: ContainerFileId, requestOptions: RequestOptions? = null): ByteArray

Downloads exact file bytes; missing files and other API errors propagate.

Link copied to clipboard
open suspend fun retrieveContainer(id: ContainerId, requestOptions: RequestOptions? = null): Container?

Retrieves a container, or null if it does not exist.

Link copied to clipboard
open suspend fun retrieveContainerFile(id: ContainerId, fileId: ContainerFileId, requestOptions: RequestOptions? = null): ContainerFile?

Retrieves a container-file resource, or null if it no longer exists.

Link copied to clipboard
open suspend fun uploadContainerFile(id: ContainerId, file: FileSource, requestOptions: RequestOptions? = null): ContainerFile

Uploads raw bytes once, closing the source even on failure. Use a fresh source for each request; uploads are not automatically retried.