SWR API¶
The Software Repository for Containers Service Class¶
SoftWare Repository for Container (SWR) high-level interface is
available through the swr
member of a
Connection
object. The swr
member
will only be added if the otcextensions.sdk.register_otc_extensions(conn)
method is called.
Organization Operations¶
- class otcextensions.sdk.swr.v2._proxy.Proxy(session: session.Session, *, service_type: str | None = None, service_name: str | None = None, interface: str | None = None, region_name: str | None = None, endpoint_override: str | None = None, version: str | None = None, auth: plugin.BaseAuthPlugin | None = None, user_agent: str | None = None, connect_retries: int | None = None, logger: logging.Logger | None = None, allow: dict[str, ty.Any] | None = None, additional_headers: collections.abc.MutableMapping[str, str] | None = None, client_name: str | None = None, client_version: str | None = None, allow_version_hack: bool | None = None, global_request_id: str | None = None, min_version: str | None = None, max_version: str | None = None, default_microversion: str | None = None, status_code_retries: int | None = None, retriable_status_codes: list[int] | None = None, raise_exc: bool | None = None, rate_limit: float | None = None, concurrency: int | None = None, connect_retry_delay: float | None = None, status_code_retry_delay: float | None = None, statsd_client: statsd_client.StatsClient | None = None, statsd_prefix: str | None = None, prometheus_counter: prometheus_client.Counter | None = None, prometheus_histogram: prometheus_client.Histogram | None = None, influxdb_config: dict[str, ty.Any] | None = None, influxdb_client: influxdb_client.InfluxDBClient | None = None)
- create_organization(**attrs)
Create a new organization from attributes
- Parameters:
attrs (dict) – Keyword arguments which will be used to create a
Organization
, comprised of the properties on the Organization class.- Returns:
The results of organization creation
- Return type:
- get_organization(*attrs)
Get an organization
- Returns:
One
Organization
- organizations(**query)
Retrieve a generator of organizations
- Returns:
A generator of organization instances
- delete_organization(namespace, ignore_missing=True)
Delete an organization
- Parameters:
namespace – The namespace can be either the name or a
Organization
instanceignore_missing (bool) – When set to
False
ResourceNotFound
will be raised when the load balancer does not exist. When set toTrue
, no exception will be set when attempting to delete a nonexistent organization.
- Returns:
None
- find_organization(name_or_id, ignore_missing=True)
Find a single organization
- Parameters:
name_or_id – The name or ID of an organization
ignore_missing (bool) – When set to
False
ResourceNotFound
will be raised when the organization does not exist. When set toTrue
, no exception will be set when attempting to delete a nonexistent organization.
- Returns:
None
Organization Permissions Operations¶
- class otcextensions.sdk.swr.v2._proxy.Proxy(session: session.Session, *, service_type: str | None = None, service_name: str | None = None, interface: str | None = None, region_name: str | None = None, endpoint_override: str | None = None, version: str | None = None, auth: plugin.BaseAuthPlugin | None = None, user_agent: str | None = None, connect_retries: int | None = None, logger: logging.Logger | None = None, allow: dict[str, ty.Any] | None = None, additional_headers: collections.abc.MutableMapping[str, str] | None = None, client_name: str | None = None, client_version: str | None = None, allow_version_hack: bool | None = None, global_request_id: str | None = None, min_version: str | None = None, max_version: str | None = None, default_microversion: str | None = None, status_code_retries: int | None = None, retriable_status_codes: list[int] | None = None, raise_exc: bool | None = None, rate_limit: float | None = None, concurrency: int | None = None, connect_retry_delay: float | None = None, status_code_retry_delay: float | None = None, statsd_client: statsd_client.StatsClient | None = None, statsd_prefix: str | None = None, prometheus_counter: prometheus_client.Counter | None = None, prometheus_histogram: prometheus_client.Histogram | None = None, influxdb_config: dict[str, ty.Any] | None = None, influxdb_client: influxdb_client.InfluxDBClient | None = None)
- create_organization_permissions(**attrs)
Create a new organization from attributes
- Parameters:
attrs (dict) – Keyword arguments which will be used to create a
Organization
, comprised of the properties on the Organization class.- Returns:
The results of organization creation
- Return type:
- organization_permissions(namespace, **query)
Retrieve a generator of organization permissions
- Returns:
A generator of organization permissions instances
- delete_organization_permissions(namespace, user_ids, ignore_missing=True)
Delete an organization permissions
- Parameters:
user_ids – Users IDs whose permissions need to be deleted.
namespace – The namespace can be either the name or a
Permission
instanceignore_missing (bool) – When set to
False
ResourceNotFound
will be raised when the load balancer does not exist. When set toTrue
, no exception will be set when attempting to delete a nonexistent permission.
- Returns:
None
- update_organization_permissions(**attrs)
Update an organization permissions
- Parameters:
attrs (dict) – The attributes to update on the permissions represented by
permissions
.- Returns:
The updated permissions.
- Return type:
Repository Operations¶
- class otcextensions.sdk.swr.v2._proxy.Proxy(session: session.Session, *, service_type: str | None = None, service_name: str | None = None, interface: str | None = None, region_name: str | None = None, endpoint_override: str | None = None, version: str | None = None, auth: plugin.BaseAuthPlugin | None = None, user_agent: str | None = None, connect_retries: int | None = None, logger: logging.Logger | None = None, allow: dict[str, ty.Any] | None = None, additional_headers: collections.abc.MutableMapping[str, str] | None = None, client_name: str | None = None, client_version: str | None = None, allow_version_hack: bool | None = None, global_request_id: str | None = None, min_version: str | None = None, max_version: str | None = None, default_microversion: str | None = None, status_code_retries: int | None = None, retriable_status_codes: list[int] | None = None, raise_exc: bool | None = None, rate_limit: float | None = None, concurrency: int | None = None, connect_retry_delay: float | None = None, status_code_retry_delay: float | None = None, statsd_client: statsd_client.StatsClient | None = None, statsd_prefix: str | None = None, prometheus_counter: prometheus_client.Counter | None = None, prometheus_histogram: prometheus_client.Histogram | None = None, influxdb_config: dict[str, ty.Any] | None = None, influxdb_client: influxdb_client.InfluxDBClient | None = None)
- create_repository(**attrs)
Create a new image repository from attributes
- Parameters:
attrs (dict) – Keyword arguments which will be used to create a
Repository
, comprised of the properties on the Repository class.- Returns:
The results of organization creation
- Return type:
- delete_repository(namespace, repository, ignore_missing=True)
Delete a repository
- Parameters:
repository – Image repository name need to be deleted.
namespace – The namespace can be either the name or a
Repository
instanceignore_missing (bool) – When set to
False
ResourceNotFound
will be raised when the load balancer does not exist. When set toTrue
, no exception will be set when attempting to delete a nonexistent repository.
- Returns:
None
- get_repository(namespace, repository)
Get a repository
- Returns:
One
Repository
- repositories(**query)
Retrieve a generator of repositories
- Returns:
A generator of repositories instances
- update_repository(**attrs)
Update a repository
- Parameters:
attrs (dict) – The attributes to update on the repository represented by
repository
.- Returns:
The updated repository.
- Return type:
Repository Permissions Operations¶
- class otcextensions.sdk.swr.v2._proxy.Proxy(session: session.Session, *, service_type: str | None = None, service_name: str | None = None, interface: str | None = None, region_name: str | None = None, endpoint_override: str | None = None, version: str | None = None, auth: plugin.BaseAuthPlugin | None = None, user_agent: str | None = None, connect_retries: int | None = None, logger: logging.Logger | None = None, allow: dict[str, ty.Any] | None = None, additional_headers: collections.abc.MutableMapping[str, str] | None = None, client_name: str | None = None, client_version: str | None = None, allow_version_hack: bool | None = None, global_request_id: str | None = None, min_version: str | None = None, max_version: str | None = None, default_microversion: str | None = None, status_code_retries: int | None = None, retriable_status_codes: list[int] | None = None, raise_exc: bool | None = None, rate_limit: float | None = None, concurrency: int | None = None, connect_retry_delay: float | None = None, status_code_retry_delay: float | None = None, statsd_client: statsd_client.StatsClient | None = None, statsd_prefix: str | None = None, prometheus_counter: prometheus_client.Counter | None = None, prometheus_histogram: prometheus_client.Histogram | None = None, influxdb_config: dict[str, ty.Any] | None = None, influxdb_client: influxdb_client.InfluxDBClient | None = None)
- create_repository_permissions(**attrs)
Create a new repository permissions from attributes
- Parameters:
attrs (dict) – Keyword arguments which will be used to create a
Permission
, comprised of the properties on the Permission class.- Returns:
The results of repository permission creation
- Return type:
- repository_permissions(namespace, repository, **query)
Retrieve a generator of repository permissions
- Returns:
A generator of repository permissions instances
- delete_repository_permissions(namespace, repository, user_ids, ignore_missing=True)
Delete a repository permissions
- Parameters:
repository – The repository can be either the name or a
Permission
instanceuser_ids – Users IDs whose permissions need to be deleted.
namespace – The namespace can be either the name or a
Permission
instanceignore_missing (bool) – When set to
False
ResourceNotFound
will be raised when the load balancer does not exist. When set toTrue
, no exception will be set when attempting to delete a nonexistent permission.
- Returns:
None
- update_repository_permissions(**attrs)
Update a repository permissions
- Parameters:
attrs (dict) – The attributes to update on the permissions represented by
permissions
.- Returns:
The updated permissions.
- Return type:
Domain Operations¶
- class otcextensions.sdk.swr.v2._proxy.Proxy(session: session.Session, *, service_type: str | None = None, service_name: str | None = None, interface: str | None = None, region_name: str | None = None, endpoint_override: str | None = None, version: str | None = None, auth: plugin.BaseAuthPlugin | None = None, user_agent: str | None = None, connect_retries: int | None = None, logger: logging.Logger | None = None, allow: dict[str, ty.Any] | None = None, additional_headers: collections.abc.MutableMapping[str, str] | None = None, client_name: str | None = None, client_version: str | None = None, allow_version_hack: bool | None = None, global_request_id: str | None = None, min_version: str | None = None, max_version: str | None = None, default_microversion: str | None = None, status_code_retries: int | None = None, retriable_status_codes: list[int] | None = None, raise_exc: bool | None = None, rate_limit: float | None = None, concurrency: int | None = None, connect_retry_delay: float | None = None, status_code_retry_delay: float | None = None, statsd_client: statsd_client.StatsClient | None = None, statsd_prefix: str | None = None, prometheus_counter: prometheus_client.Counter | None = None, prometheus_histogram: prometheus_client.Histogram | None = None, influxdb_config: dict[str, ty.Any] | None = None, influxdb_client: influxdb_client.InfluxDBClient | None = None)
- create_domain(**attrs)
Create a new image repository from attributes
- Parameters:
attrs (dict) – Keyword arguments which will be used to create a
Domain
, comprised of the properties on the Repository class.- Returns:
The results of organization creation
- Return type:
- delete_domain(namespace, repository, access_domain, ignore_missing=True)
Delete a domain
- Parameters:
access_domain – Name of the account need to be deleted.
repository – Image repository name.
namespace – Organization name.
ignore_missing (bool) – When set to
False
ResourceNotFound
will be raised when the load balancer does not exist. When set toTrue
, no exception will be set when attempting to delete a nonexistent repository.
- Returns:
None
- domains(**query)
Retrieve a generator of domains
- Returns:
A generator of domain instances
- update_domain(**attrs)
Update a domain
- Parameters:
attrs (dict) – The attributes to update on the domain represented by
permissions
.- Returns:
The updated domain.
- Return type:
- get_domain(namespace, repository, access_domain)
Get a domain
- Returns:
One
Domain