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:
Return type:

MachineImage

abstractmethod add_image_family(family)
Parameters:

family (MachineImageFamily)

Return type:

MachineImageFamily

abstractmethod add_image_group(family, group)
Parameters:
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:
Return type:

MachineImage

add_image_family(family)
Parameters:

family (MachineImageFamily)

Return type:

MachineImageFamily

add_image_group(family, group)
Parameters:
Return type:

MachineImageGroup

close()
Return type:

None

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:
Return type:

MachineImage

add_image_family(family)
Parameters:

family (MachineImageFamily)

Return type:

MachineImageFamily

add_image_group(family, group)
Parameters:
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:
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