Images Manager - Nebius Token Factory documentation

`class ImagesManager`

class contree_sdk.sdk.managers.images.ImagesManager(client)

Attributes

alias of ContreeImage

Methods

`aiter()`

async def __aiter__()

`call()`

async def __call__(number, tagged, since, until) -> list[ContreeImage]

Fetch a list of images with optional filters.

int | None

default:"100"

Maximum number of images to return. None returns all.

bool

default:"False"

If True, return only tagged images.

datetime | timedelta | None

default:"None"

Return images created after this time. Accepts datetime or timedelta relative to now.

datetime | timedelta | None

default:"None"

Return images created before this time. Accepts datetime or timedelta relative to now.

list[ContreeImage]

list[ContreeImage]List of images matching the given filters.

`docker()`

async def docker(ref, *, tag, username, password, timeout) -> ContreeImage

Resolve an image by tag, falling back to import if not found.Derives the target tag from the tag parameter or from the reference itself, then tries to find an existing image with that tag. If the image does not exist, triggers an import and returns the result.

str | OCIReference | UUID

required

str | OCIReference | UUIDUUID, OCI reference string, or OCIReference of the image.

str | None

default:"None"

Tag override; if provided, replaces the tag from the reference.

str | None

default:"None"

Registry username for authenticated imports.

str | None

default:"None"

Registry password for authenticated imports.

float | None

default:"None"

Maximum seconds to wait for the import operation.

ContreeImage

ContreeImageResolved or imported image object.

NotFoundError – If ref is a UUID and the image does not exist.

`get_image_by_tag()`

async def get_image_by_tag(tag) -> ContreeImage

required

ContreeImage

ContreeImage

`get_image_by_uuid()`

async def get_image_by_uuid(uuid) -> ContreeImage

required

ContreeImage

ContreeImage

`get_images_list()`

async def get_images_list(number, tagged, since, until) -> list[ContreeImage]

Fetch a list of images with optional filters.

int | None

default:"100"

Maximum number of images to return. None returns all.

bool

default:"False"

If True, return only tagged images.

datetime | timedelta | None

default:"None"

Return images created after this time. Accepts datetime or timedelta relative to now.

datetime | timedelta | None

default:"None"

Return images created before this time. Accepts datetime or timedelta relative to now.

list[ContreeImage]

list[ContreeImage]List of images matching the given filters.

`image_by_data()`

def image_by_data(image) -> TypeVar(ImageT, bound= ContreeImageBase)

required

TypeVar(ImageT, bound= ContreeImageBase)

`import_from()`

async def import_from(image, *, tag, username, password, timeout) -> ContreeImage

Import an image from an external registry into Contree.

str | OCIReference

required

str | OCIReferenceOCI reference string or OCIReference pointing to the source image.

str | None

default:"None"

Tag to assign to the imported image. Defaults to the tag in the reference.

str | None

default:"None"

Registry username for private registries.

str | None

default:"None"

Registry password for private registries.

float | None

default:"None"

Maximum seconds to wait for the import operation.

ContreeImage

ContreeImageImported image object.

ValueError – If image is a UUID or credentials are incomplete.

FailedOperationError – If the import operation completes without returning an image.

CancelledOperationError – If the import operation was cancelled.

OperationTimedOutError – If the import operation did not complete within timeout.

`import_image()`

async def import_image(image, *, tag, username, password, timeout) -> ContreeImage

Import an image from an external registry into Contree.

str | OCIReference

required

str | OCIReferenceOCI reference string or OCIReference pointing to the source image.

str | None

default:"None"

Tag to assign to the imported image. Defaults to the tag in the reference.

str | None

default:"None"

Registry username for private registries.

str | None

default:"None"

Registry password for private registries.

float | None

default:"None"

Maximum seconds to wait for the import operation.

ContreeImage

ContreeImageImported image object.

ValueError – If image is a UUID or credentials are incomplete.

FailedOperationError – If the import operation completes without returning an image.

CancelledOperationError – If the import operation was cancelled.

OperationTimedOutError – If the import operation did not complete within timeout.

`iter_images()`

async def iter_images(number, tagged, since, until)

`oci()`

async def oci(ref, *, tag, username, password, timeout) -> ContreeImage

str | OCIReference | UUID

required

str | OCIReference | UUIDUUID, OCI reference string, or OCIReference of the image.

str | None

default:"None"

Tag override; if provided, replaces the tag from the reference.

str | None

default:"None"

Registry username for authenticated imports.

str | None

default:"None"

Registry password for authenticated imports.

float | None

default:"None"

Maximum seconds to wait for the import operation.

ContreeImage

ContreeImageResolved or imported image object.

NotFoundError – If ref is a UUID and the image does not exist.

`parse_ref()`

@classmethod
def parse_ref(ref) -> UUID | OCIReference

required

UUID | OCIReference

UUID | OCIReference

`podman()`

async def podman(ref, *, tag, username, password, timeout) -> ContreeImage

str | OCIReference | UUID

required

str | OCIReference | UUIDUUID, OCI reference string, or OCIReference of the image.

str | None

default:"None"

Tag override; if provided, replaces the tag from the reference.

str | None

default:"None"

Registry username for authenticated imports.

str | None

default:"None"

Registry password for authenticated imports.

float | None

default:"None"

Maximum seconds to wait for the import operation.

ContreeImage

ContreeImageResolved or imported image object.

NotFoundError – If ref is a UUID and the image does not exist.

`pull_by_oci()`

async def pull_by_oci(ref, *, tag, username, password, timeout) -> ContreeImage

str | OCIReference | UUID

required

str | OCIReference | UUIDUUID, OCI reference string, or OCIReference of the image.

str | None

default:"None"

Tag override; if provided, replaces the tag from the reference.

str | None

default:"None"

Registry username for authenticated imports.

str | None

default:"None"

Registry password for authenticated imports.

float | None

default:"None"

Maximum seconds to wait for the import operation.

ContreeImage

ContreeImageResolved or imported image object.

NotFoundError – If ref is a UUID and the image does not exist.

`pull_image_by_oci()`

async def pull_image_by_oci(ref, *, tag, username, password, timeout) -> ContreeImage

str | OCIReference | UUID

required

str | OCIReference | UUIDUUID, OCI reference string, or OCIReference of the image.

str | None

default:"None"

Tag override; if provided, replaces the tag from the reference.

str | None

default:"None"

Registry username for authenticated imports.

str | None

default:"None"

Registry password for authenticated imports.

float | None

default:"None"

Maximum seconds to wait for the import operation.

ContreeImage

ContreeImageResolved or imported image object.

NotFoundError – If ref is a UUID and the image does not exist.

`use()`

async def use(ref, strict) -> ContreeImage

Resolve a reference to an image object without importing.

str | UUID | OCIReference

required

str | UUID | OCIReferenceImage identifier: UUID, OCI reference string, or OCIReference object.

bool

default:"False"

If True, verify the image exists by fetching it from the API.

ContreeImage

ContreeImageImage object corresponding to the given reference.

`use_image()`

async def use_image(ref, strict) -> ContreeImage

Resolve a reference to an image object without importing.

str | UUID | OCIReference

required

str | UUID | OCIReferenceImage identifier: UUID, OCI reference string, or OCIReference object.

bool

default:"False"

If True, verify the image exists by fetching it from the API.

ContreeImage

ContreeImageImage object corresponding to the given reference.

`class ImagesManagerSync`

class contree_sdk.sdk.managers.images.ImagesManagerSync(client)

Attributes

alias of ContreeImageSync

Methods

`call()`

def __call__(number, tagged, since, until) -> list[ContreeImageSync]

Fetch a list of images with optional filters.

int | None

default:"100"

Maximum number of images to return. None returns all.

bool

default:"False"

If True, return only tagged images.

datetime | timedelta | None

default:"None"

Return images created after this time. Accepts datetime or timedelta relative to now.

datetime | timedelta | None

default:"None"

Return images created before this time. Accepts datetime or timedelta relative to now.

list[ContreeImageSync]

list[ContreeImageSync]List of images matching the given filters.

`iter()`

def __iter__()

`docker()`

def docker(ref, *, tag, username, password, timeout) -> ContreeImageSync

Resolve an image by tag, falling back to import if not found.

str | OCIReference | UUID

required

str | OCIReference | UUIDUUID, OCI reference string, or OCIReference of the image.

str | None

default:"None"

Tag override; if provided, replaces the tag from the reference.

str | None

default:"None"

Registry username for authenticated imports.

str | None

default:"None"

Registry password for authenticated imports.

float | None

default:"None"

Maximum seconds to wait for the import operation.

ContreeImageSync

ContreeImageSyncResolved or imported image object.

NotFoundError – If ref is a UUID and the image does not exist.

`get_image_by_tag()`

def get_image_by_tag(tag) -> ContreeImageSync

required

ContreeImageSync

ContreeImageSync

`get_image_by_uuid()`

def get_image_by_uuid(uuid) -> ContreeImageSync

required

ContreeImageSync

ContreeImageSync

`get_images_list()`

def get_images_list(number, tagged, since, until) -> list[ContreeImageSync]

Fetch a list of images with optional filters.

int | None

default:"100"

Maximum number of images to return. None returns all.

bool

default:"False"

If True, return only tagged images.

datetime | timedelta | None

default:"None"

Return images created after this time. Accepts datetime or timedelta relative to now.

datetime | timedelta | None

default:"None"

Return images created before this time. Accepts datetime or timedelta relative to now.

list[ContreeImageSync]

list[ContreeImageSync]List of images matching the given filters.

`image_by_data()`

def image_by_data(image) -> TypeVar(ImageT, bound= ContreeImageBase)

required

TypeVar(ImageT, bound= ContreeImageBase)

`import_from()`

def import_from(image, *, tag, username, password, timeout) -> ContreeImageSync

Import an image from an external registry into Contree.

str | OCIReference

required

str | OCIReferenceOCI reference string or OCIReference pointing to the source image.

str | None

default:"None"

Tag to assign to the imported image. Defaults to the tag in the reference.

str | None

default:"None"

Registry username for private registries.

str | None

default:"None"

Registry password for private registries.

float | None

default:"None"

Maximum seconds to wait for the import operation.

ContreeImageSync

ContreeImageSyncImported image object.

ValueError – If image is a UUID or credentials are incomplete.

FailedOperationError – If the import operation completes without returning an image.

CancelledOperationError – If the import operation was cancelled.

OperationTimedOutError – If the import operation did not complete within timeout.

`import_image()`

def import_image(image, *, tag, username, password, timeout) -> ContreeImageSync

Import an image from an external registry into Contree.

str | OCIReference

required

str | OCIReferenceOCI reference string or OCIReference pointing to the source image.

str | None

default:"None"

Tag to assign to the imported image. Defaults to the tag in the reference.

str | None

default:"None"

Registry username for private registries.

str | None

default:"None"

Registry password for private registries.

float | None

default:"None"

Maximum seconds to wait for the import operation.

ContreeImageSync

ContreeImageSyncImported image object.

ValueError – If image is a UUID or credentials are incomplete.

FailedOperationError – If the import operation completes without returning an image.

CancelledOperationError – If the import operation was cancelled.

OperationTimedOutError – If the import operation did not complete within timeout.

`iter_images()`

def iter_images(number, tagged, since, until)

`oci()`

def oci(ref, *, tag, username, password, timeout) -> ContreeImageSync

Resolve an image by tag, falling back to import if not found.

str | OCIReference | UUID

required

str | OCIReference | UUIDUUID, OCI reference string, or OCIReference of the image.

str | None

default:"None"

Tag override; if provided, replaces the tag from the reference.

str | None

default:"None"

Registry username for authenticated imports.

str | None

default:"None"

Registry password for authenticated imports.

float | None

default:"None"

Maximum seconds to wait for the import operation.

ContreeImageSync

ContreeImageSyncResolved or imported image object.

NotFoundError – If ref is a UUID and the image does not exist.

`parse_ref()`

@classmethod
def parse_ref(ref) -> UUID | OCIReference

required

UUID | OCIReference

UUID | OCIReference

`podman()`

def podman(ref, *, tag, username, password, timeout) -> ContreeImageSync

Resolve an image by tag, falling back to import if not found.

str | OCIReference | UUID

required

str | OCIReference | UUIDUUID, OCI reference string, or OCIReference of the image.

str | None

default:"None"

Tag override; if provided, replaces the tag from the reference.

str | None

default:"None"

Registry username for authenticated imports.

str | None

default:"None"

Registry password for authenticated imports.

float | None

default:"None"

Maximum seconds to wait for the import operation.

ContreeImageSync

ContreeImageSyncResolved or imported image object.

NotFoundError – If ref is a UUID and the image does not exist.

`pull_by_oci()`

def pull_by_oci(ref, *, tag, username, password, timeout) -> ContreeImageSync

Resolve an image by tag, falling back to import if not found.

str | OCIReference | UUID

required

str | OCIReference | UUIDUUID, OCI reference string, or OCIReference of the image.

str | None

default:"None"

Tag override; if provided, replaces the tag from the reference.

str | None

default:"None"

Registry username for authenticated imports.

str | None

default:"None"

Registry password for authenticated imports.

float | None

default:"None"

Maximum seconds to wait for the import operation.

ContreeImageSync

ContreeImageSyncResolved or imported image object.

NotFoundError – If ref is a UUID and the image does not exist.

`pull_image_by_oci()`

def pull_image_by_oci(ref, *, tag, username, password, timeout) -> ContreeImageSync

Resolve an image by tag, falling back to import if not found.

str | OCIReference | UUID

required

str | OCIReference | UUIDUUID, OCI reference string, or OCIReference of the image.

str | None

default:"None"

Tag override; if provided, replaces the tag from the reference.

str | None

default:"None"

Registry username for authenticated imports.

str | None

default:"None"

Registry password for authenticated imports.

float | None

default:"None"

Maximum seconds to wait for the import operation.

ContreeImageSync

ContreeImageSyncResolved or imported image object.

NotFoundError – If ref is a UUID and the image does not exist.

`use()`

def use(ref, strict) -> ContreeImageSync

Resolve a reference to an image object without importing.

str | UUID | OCIReference

required

str | UUID | OCIReferenceImage identifier: UUID, OCI reference string, or OCIReference object.

bool

default:"False"

If True, verify the image exists by fetching it from the API.

ContreeImageSync

ContreeImageSyncImage object corresponding to the given reference.

`use_image()`

def use_image(ref, strict) -> ContreeImageSync

Resolve a reference to an image object without importing.

str | UUID | OCIReference

required

str | UUID | OCIReferenceImage identifier: UUID, OCI reference string, or OCIReference object.

bool

default:"False"

If True, verify the image exists by fetching it from the API.

ContreeImageSync

ContreeImageSyncImage object corresponding to the given reference.

​class ImagesManager

​Attributes

​Methods

​__aiter__()

​__call__()

​docker()

​get_image_by_tag()

​get_image_by_uuid()

​get_images_list()

​image_by_data()

​import_from()

​import_image()

​iter_images()

​oci()

​parse_ref()

​podman()

​pull_by_oci()

​pull_image_by_oci()

​use()

​use_image()

​class ImagesManagerSync

​Attributes

​Methods

​__call__()

​__iter__()

​docker()

​get_image_by_tag()

​get_image_by_uuid()

​get_images_list()

​image_by_data()

​import_from()

​import_image()

​iter_images()

​oci()

​parse_ref()

​podman()

​pull_by_oci()

​pull_image_by_oci()

​use()

​use_image()

`class ImagesManager`

Attributes

Methods

`aiter()`

`call()`

`docker()`

`get_image_by_tag()`

`get_image_by_uuid()`

`get_images_list()`

`image_by_data()`

`import_from()`

`import_image()`

`iter_images()`

`oci()`

`parse_ref()`

`podman()`

`pull_by_oci()`

`pull_image_by_oci()`

`use()`

`use_image()`

`class ImagesManagerSync`

Attributes

Methods

`call()`

`iter()`

`docker()`

`get_image_by_tag()`

`get_image_by_uuid()`

`get_images_list()`

`image_by_data()`

`import_from()`

`import_image()`

`iter_images()`

`oci()`

`parse_ref()`

`podman()`

`pull_by_oci()`

`pull_image_by_oci()`

`use()`

`use_image()`