roboto.image_registry

Submodules

Package Contents

ContainerCredentials

class roboto.image_registry.ContainerCredentials(/, **data)#

Bases: pydantic.BaseModel

Credentials used by a container

Parameters

data Any

Attributes

ContainerCredentials.expiration

expiration datetime.datetime #

ContainerCredentials.is_expired()

is_expired()#

Return type

bool

Attributes

ContainerCredentials.password

password str #

ContainerCredentials.registry_url

registry_url str #

ContainerCredentials.to_dict()

to_dict()#

Return type

dict[str, Any]

Attributes

ContainerCredentials.username

username str #

ContainerImageRecord

class roboto.image_registry.ContainerImageRecord(/, **data)#

Bases: pydantic.BaseModel

A wire-transmissible representation of a container image.

Parameters

data Any

Attributes

ContainerImageRecord.image_tag

image_tag str #

ContainerImageRecord.image_uri

image_uri str #

ContainerImageRecord.org_id

org_id str #

ContainerImageRecord.repository_name

repository_name str #

ContainerImageRepositoryRecord

class roboto.image_registry.ContainerImageRepositoryRecord(/, **data)#

Bases: pydantic.BaseModel

A wire-transmissible representation of a container image repository.

Parameters

data Any

Attributes

ContainerImageRepositoryRecord.arn

arn str #

ContainerImageRepositoryRecord.org_id

org_id str #

ContainerImageRepositoryRecord.repository_name

repository_name str #

ContainerImageRepositoryRecord.repository_uri

repository_uri str #

ContainerUploadCredentials

class roboto.image_registry.ContainerUploadCredentials(/, **data)#

Bases: pydantic.BaseModel

Container upload credentials

Parameters

data Any

Attributes

ContainerUploadCredentials.image_uri

image_uri str #

ContainerUploadCredentials.password

password str #

ContainerUploadCredentials.registry_url

registry_url str #

ContainerUploadCredentials.username

username str #

CreateImageRepositoryRequest

class roboto.image_registry.CreateImageRepositoryRequest(/, **data)#

Bases: pydantic.BaseModel

Request payload to create an image repository

Parameters

data Any

Attributes

CreateImageRepositoryRequest.immutable_image_tags

immutable_image_tags bool #

CreateImageRepositoryRequest.repository_name

repository_name str #

CreateImageRepositoryResponse

class roboto.image_registry.CreateImageRepositoryResponse(/, **data)#

Bases: pydantic.BaseModel

Response payload to create an image repository

Parameters

data Any

Attributes

CreateImageRepositoryResponse.repository_name

repository_name str #

CreateImageRepositoryResponse.repository_uri

repository_uri str #

DeleteImageRepositoryRequest

class roboto.image_registry.DeleteImageRepositoryRequest(/, **data)#

Bases: pydantic.BaseModel

Request payload to delete an image repository

Parameters

data Any

Attributes

DeleteImageRepositoryRequest.force

force bool = False #

Delete all images in the repository before deleting the repository if the repository is not empty.

DeleteImageRepositoryRequest.repository_name

repository_name str #

The name of the repository to delete.

DeleteImageRequest

class roboto.image_registry.DeleteImageRequest(/, **data)#

Bases: pydantic.BaseModel

Request payload to delete an image

Parameters

data Any

Attributes

DeleteImageRequest.image_uri

image_uri str #

ImageRegistry

class roboto.image_registry.ImageRegistry(roboto_client)#

Parameters

roboto_client roboto.http.RobotoClient

ImageRegistry.create_repository()

create_repository(repository_name, immutable_image_tags=False, org_id=None)#

Create a repository for a container image in Roboto’s private image registry. Images with different tags can be pushed to the same repository.

Parameters

repository_name str

The name of the repository to create.

immutable_image_tags bool

Whether to allow image tags to be overwritten. If set to True, then any attempt to overwrite an existing image tag will error.

org_id Optional[str]

Returns

ImageRepository

A dictionary contains the repository_name and ``repository_uri` of the created repository.

ImageRegistry.delete_image()

delete_image(image_uri, org_id=None)#

Delete a container image from Roboto’s private registry.

Parameters

image_uri str

The full URI of the image to delete.

org_id Optional[str]

ID of organization owning the provided image.

Return type

None

ImageRegistry.delete_repository()

delete_repository(repository_name, org_id=None, force=False)#

Delete a container image from Roboto’s private registry.

Parameters

repository_name str

The name of the repository to delete.

org_id Optional[str]

ID of organization owning the provided image.

force bool

Delete all images in the repository before deleting the repository if the repository is not empty.

Return type

None

ImageRegistry.get_container_image_record()

get_container_image_record(org_id, image_uri)#

Parameters

org_id str

image_uri str

Return type

roboto.image_registry.record.ContainerImageRecord

ImageRegistry.get_temporary_credentials()

get_temporary_credentials(repository_uri, permissions=Permissions.ReadOnly, org_id=None)#

Parameters

repository_uri str

permissions roboto.auth.Permissions

org_id Optional[str]

Return type

ContainerCredentials

ImageRegistry.list_images()

list_images(repository_name=None, page_token=None, org_id=None)#

Parameters

repository_name Optional[str]

page_token Optional[str]

org_id Optional[str]

Return type

roboto.http.PaginatedList[roboto.image_registry.record.ContainerImageRecord]

ImageRegistry.list_repositories()

list_repositories(page_token=None, org_id=None)#

Parameters

page_token Optional[str]

org_id Optional[str]

Return type

roboto.http.PaginatedList[roboto.image_registry.record.ContainerImageRepositoryRecord]

ImageRegistry.repository_contains_image()

repository_contains_image(repository_name, image_tag, org_id=None)#

Parameters

repository_name str

image_tag str

org_id Optional[str]

Return type

bool

ImageRepository

class roboto.image_registry.ImageRepository#

Bases: TypedDict

Image repository details

Attributes

ImageRepository.repository_name

repository_name str #

ImageRepository.repository_uri

repository_uri str #

RepositoryContainsImageResponse

class roboto.image_registry.RepositoryContainsImageResponse(/, **data)#

Bases: pydantic.BaseModel

Response payload to repository contains image

Parameters

data Any

Attributes

RepositoryContainsImageResponse.contains_image

contains_image bool #

RepositoryPurpose

class roboto.image_registry.RepositoryPurpose(*args, **kwds)#

Bases: enum.Enum

Repository purpose enum

Attributes

RepositoryPurpose.Executor

Executor = 'executor' #

RepositoryTag

class roboto.image_registry.RepositoryTag(*args, **kwds)#

Bases: enum.Enum

Repository tag enum

Attributes

RepositoryTag.CreatedBy

CreatedBy = 'created_by' #

RepositoryTag.OrgId

OrgId = 'org_id' #

RepositoryTag.Purpose

Purpose = 'purpose' #

SetImageRepositoryImmutableTagsRequest

class roboto.image_registry.SetImageRepositoryImmutableTagsRequest(/, **data)#

Bases: pydantic.BaseModel

Request payload to set image repository tags

Parameters

data Any

Attributes

SetImageRepositoryImmutableTagsRequest.immutable_image_tags

immutable_image_tags bool #

SetImageRepositoryImmutableTagsRequest.repository_name

repository_name str #