Skip to content

Registries

get_registry(id) async

Get a registry.

Parameters:

Name Type Description Default
id int

The ID of the registry

required

Returns:

Type Description
Registry

The registry

create_registry(registry) async

Create a new registry.

Parameters:

Name Type Description Default
registry Registry

The new registry values.

required

Returns:

Type Description
str

The location of the created registry.

update_registry(id, registry) async

Update a registry.

Parameters:

Name Type Description Default
id int

The ID of the registry

required
registry RegistryUpdate

The updated registry values.

required

delete_registry(id, missing_ok=None) async

Delete a registry.

Parameters:

Name Type Description Default
id int

The ID of the registry

required
missing_ok Optional[bool]

DEPRECATED: If True, don't raise an exception if the registry doesn't exist.

None

get_registry_info(id) async

Get the info of a registry.

Parameters:

Name Type Description Default
id int

The ID of the registry

required

Returns:

Type Description
RegistryInfo

The info of a registry

get_registry_adapters(limit=None) async

Get the list of available registry adapters.

Parameters:

Name Type Description Default
limit Optional[int]

The maximum number of results to return.

None

Returns:

Type Description
List[str]

The list of available registry adapters

get_registry_providers() async

Get all registered registry provider information.

Returns:

Type Description
RegistryProviders

An overview of the registered registry providers.

check_registry_status(ping) async

Check the status of the registry.

Parameters:

Name Type Description Default
ping RegistryPing

The ping request

required

get_registries(query=None, sort=None, page=1, page_size=10, limit=None, name=None, **kwargs) async

Get all registries.

Parameters:

Name Type Description Default
query Optional[str]

A query string to filter the registries.

Supported query patterns are:

* exact match(`"k=v"`)
* fuzzy match(`"k=~v"`)
* range(`"k=[min~max]"`)
* list with union releationship(`"k={v1 v2 v3}"`)
* list with intersection relationship(`"k=(v1 v2 v3)"`).

The value of range and list can be:

* string(enclosed by `"` or `'`)
* integer
* time(in format `"2020-04-09 02:36:00"`)

All of these query patterns should be put in the query string and separated by ",". e.g. "k1=v1,k2=~v2,k3=[min~max]"

None
sort Optional[str]

The sort order of the artifacts.

None
page int

The page of results to return

1
page_size int

The number of results to return per page

10
limit Optional[int]

The maximum number of results to return. If not specified, all

None
name Optional[str]

The name of the registry (deprecated, use query instead)

None

Returns:

Type Description
List[Registry]

A list of Registry objects.