Files
OpenLLM/typings/docker/api/secret.pyi
Aaron Pham c7f4dc7bb2 feat(test): snapshot testing (#107)
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2023-07-10 17:23:19 -04:00

61 lines
1.7 KiB
Python
Generated

"""This type stub file was generated by pyright."""
from .. import utils
class SecretApiMixin:
@utils.minimum_version("1.25")
def create_secret(self, name, data, labels=..., driver=...):
"""Create a secret.
Args:
name (string): Name of the secret
data (bytes): Secret data to be stored
labels (dict): A mapping of labels to assign to the secret
driver (DriverConfig): A custom driver configuration. If
unspecified, the default ``internal`` driver will be used
Returns (dict): ID of the newly created secret
"""
...
@utils.minimum_version("1.25")
@utils.check_resource("id")
def inspect_secret(self, id):
"""Retrieve secret metadata.
Args:
id (string): Full ID of the secret to inspect
Returns (dict): A dictionary of metadata
Raises:
:py:class:`docker.errors.NotFound`
if no secret with that ID exists
"""
...
@utils.minimum_version("1.25")
@utils.check_resource("id")
def remove_secret(self, id): # -> Literal[True]:
"""Remove a secret.
Args:
id (string): Full ID of the secret to remove
Returns (boolean): True if successful
Raises:
:py:class:`docker.errors.NotFound`
if no secret with that ID exists
"""
...
@utils.minimum_version("1.25")
def secrets(self, filters=...):
"""List secrets.
Args:
filters (dict): A map of filters to process on the secrets
list. Available filters: ``names``
Returns (list): A list of secrets
"""
...