`yellowdog_client.images` – Images

All functionality is accessed via the yellowdog_client.images.ImagesClient.

class yellowdog_client.images.ImagesClient

abstractmethod add_image(group, image)

Parameters:

group (MachineImageGroup)
image (MachineImage)

Return type:

abstractmethod add_image_family(family)

Parameters:: family (MachineImageFamily)
Return type:: MachineImageFamily

abstractmethod add_image_group(family, group)

Parameters:

family (MachineImageFamily)
group (MachineImageGroup)

Return type:

MachineImageGroup

abstractmethod delete_image(image)

Parameters:: image (MachineImage)
Return type:: None

abstractmethod delete_image_family(family)

Parameters:: family (MachineImageFamily)
Return type:: None

abstractmethod delete_image_group(group)

Parameters:: group (MachineImageGroup)
Return type:: None

abstractmethod get_image(image_id)

Parameters:: image_id (str)
Return type:: MachineImage

abstractmethod get_image_families(search)

Parameters:: search (MachineImageFamilySearch)
Return type:: SearchClient[MachineImageFamilySummary]

abstractmethod get_image_family_by_id(family_id)

Parameters:: family_id (str)
Return type:: MachineImageFamily

abstractmethod get_image_family_by_name(namespace, family_name)

Parameters:

namespace (str)
family_name (str)

Return type:

MachineImageFamily

abstractmethod get_image_group_by_id(group_id)

Parameters:: group_id (str)
Return type:: MachineImageGroup

abstractmethod get_image_group_by_name(namespace, family_name, group_name)

Parameters:

namespace (str)
family_name (str)
group_name (str)

Return type:

MachineImageGroup

abstractmethod get_latest_image_group_by_family_id(family_id)

Parameters:: family_id (str)
Return type:: MachineImageGroup

abstractmethod get_latest_image_group_by_family_name(namespace, family_name)

Parameters:

namespace (str)
family_name (str)

Return type:

MachineImageGroup

abstractmethod update_image(image)

Parameters:: image (MachineImage)
Return type:: MachineImage

abstractmethod update_image_family(family)

Parameters:: family (MachineImageFamily)
Return type:: MachineImageFamily

abstractmethod update_image_group(group)

Parameters:: group (MachineImageGroup)
Return type:: MachineImageGroup

class yellowdog_client.images.ImagesClientImpl(service_proxy)

Parameters:: service_proxy (ImagesServiceProxy)

add_image(group, image)

Parameters:

group (MachineImageGroup)
image (MachineImage)

Return type:

add_image_family(family)

Parameters:: family (MachineImageFamily)
Return type:: MachineImageFamily

add_image_group(family, group)

Parameters:

family (MachineImageFamily)
group (MachineImageGroup)

Return type:

MachineImageGroup

close()

delete_image(image)

Parameters:: image (MachineImage)
Return type:: None

delete_image_family(family)

Parameters:: family (MachineImageFamily)
Return type:: None

delete_image_group(group)

Parameters:: group (MachineImageGroup)
Return type:: None

get_image(image_id)

Parameters:: image_id (str)
Return type:: MachineImage

get_image_families(search)

Parameters:: search (MachineImageFamilySearch)
Return type:: SearchClient[MachineImageFamilySummary]

get_image_family_by_id(family_id)

Parameters:: family_id (str)
Return type:: MachineImageFamily

get_image_family_by_name(namespace, family_name)

Parameters:

namespace (str)
family_name (str)

Return type:

MachineImageFamily

get_image_group_by_id(group_id)

Parameters:: group_id (str)
Return type:: MachineImageGroup

get_image_group_by_name(namespace, family_name, group_name)

Parameters:

namespace (str)
family_name (str)
group_name (str)

Return type:

MachineImageGroup

get_latest_image_group_by_family_id(family_id)

Parameters:: family_id (str)
Return type:: MachineImageGroup

get_latest_image_group_by_family_name(namespace, family_name)

Parameters:

namespace (str)
family_name (str)

Return type:

MachineImageGroup

update_image(image)

Parameters:: image (MachineImage)
Return type:: MachineImage

update_image_family(family)

Parameters:: family (MachineImageFamily)
Return type:: MachineImageFamily

update_image_group(group)

Parameters:: group (MachineImageGroup)
Return type:: MachineImageGroup

class yellowdog_client.images.ImagesServiceProxy(proxy)

Parameters:: proxy (Proxy)

add_image(group, image)

Parameters:

group (MachineImageGroup)
image (MachineImage)

Return type:

add_image_family(family)

Parameters:: family (MachineImageFamily)
Return type:: MachineImageFamily

add_image_group(family, group)

Parameters:

family (MachineImageFamily)
group (MachineImageGroup)

Return type:

MachineImageGroup

delete_image(image)

Parameters:: image (MachineImage)
Return type:: None

delete_image_family(family)

Parameters:: family (MachineImageFamily)
Return type:: None

delete_image_group(group)

Parameters:: group (MachineImageGroup)
Return type:: None

get_all_image_families()

Return type:: List[MachineImageFamilySummary]

get_image_by_id(image_id)

Parameters:: image_id (str)
Return type:: MachineImage

get_image_family_by_id(family_id)

Parameters:: family_id (str)
Return type:: MachineImageFamily

get_image_family_by_name(namespace, family_name)

Parameters:

namespace (str)
family_name (str)

Return type:

MachineImageFamily

get_image_group_by_id(group_id)

Parameters:: group_id (str)
Return type:: MachineImageGroup

get_image_group_by_name(namespace, family_name, group_name)

Parameters:

namespace (str)
family_name (str)
group_name (str)

Return type:

MachineImageGroup

get_latest_image_group_by_family_id(family_id)

Parameters:: family_id (str)
Return type:: MachineImageGroup

get_latest_image_group_by_family_name(namespace, family_name)

Parameters:

namespace (str)
family_name (str)

Return type:

MachineImageGroup

search_image_families(search, slice_reference)

Parameters:

search (MachineImageFamilySearch)
slice_reference (SliceReference)

Return type:

Slice[MachineImageFamilySummary]

update_image(image)

Parameters:: image (MachineImage)
Return type:: MachineImage

update_image_family(family)

Parameters:: family (MachineImageFamily)
Return type:: MachineImageFamily

update_image_group(group)

Parameters:: group (MachineImageGroup)
Return type:: MachineImageGroup

class yellowdog_client.images.Page(content, empty, first, last, number, numberOfElements, pageable, size, sort, totalElements, totalPages)

Parameters:

content (List[TypeVar(T)])
empty (bool)
first (bool)
last (bool)
number (int)
numberOfElements (int)
pageable (Pageable)
size (int)
sort (Sort)
totalElements (int)
totalPages (int)

content: List[T]

empty: bool

first: bool

last: bool

number: int

numberOfElements: int

pageable: Pageable

size: int

sort: Sort

totalElements: int

totalPages: int

class yellowdog_client.images.Pageable(paged=False, pageNumber=0, pageSize=0, offset=0, sort=None)

Parameters:

paged (bool)
pageNumber (int)
pageSize (int)
offset (int)
sort (Optional[Sort])

offset: int = 0

pageNumber: int = 0

pageSize: int = 0

paged: bool = False

sort: Sort | None = None

unpaged: bool = None

class yellowdog_client.images.Sort(sorted=False, empty=True)

Parameters:

sorted (bool)
empty (bool)

empty: bool = True

sorted: bool = False

unsorted: bool = None