| 1 | import Modem = require('docker-modem');
|
| 2 | /**
|
| 3 | * Class representing a secret
|
| 4 | */
|
| 5 | export declare class Secret {
|
| 6 | modem: Modem;
|
| 7 | id: String;
|
| 8 | data: Object;
|
| 9 | /**
|
| 10 | * Create a secret
|
| 11 | * @param {Modem} modem Modem to connect to the remote service
|
| 12 | * @param {string} id Id of the secret (optional)
|
| 13 | */
|
| 14 | constructor(modem: Modem, id: String);
|
| 15 | /**
|
| 16 | * Get low-level information on a secret
|
| 17 | * https://docs.docker.com/engine/api/v1.25/#operation/SecretInspect
|
| 18 | * The reason why this module isn't called inspect is because that interferes with the inspect utility of node.
|
| 19 | * @param {Object} opts Query params in the request (optional)
|
| 20 | * {Promise} Promise return the secret
|
| 21 | */
|
| 22 | status(opts?: Object): Promise<Secret>;
|
| 23 | /**
|
| 24 | * Remove a secret
|
| 25 | * https://docs.docker.com/engine/api/v1.25/#operation/SecretDelete
|
| 26 | * @param {Object} opts Query params in the request (optional)
|
| 27 | * @return {Promise} Promise return the result
|
| 28 | */
|
| 29 | remove(opts?: Object): Promise<{}>;
|
| 30 | }
|
| 31 | export default class {
|
| 32 | modem: Modem;
|
| 33 | /**
|
| 34 | * Create a secret
|
| 35 | * @param {Modem} modem Modem to connect to the remote service
|
| 36 | */
|
| 37 | constructor(modem: Modem);
|
| 38 | /**
|
| 39 | * Get a Secret object
|
| 40 | * @param {id} string ID of the secret
|
| 41 | * {Secret}
|
| 42 | */
|
| 43 | get(id: String): Secret;
|
| 44 | /**
|
| 45 | * Get the list of secrets
|
| 46 | * https://docs.docker.com/engine/api/v1.25/#operation/SecretList
|
| 47 | * @param {Object} opts Query params in the request (optional)
|
| 48 | * @return {Promise} Promise returning the result as a list of secrets
|
| 49 | */
|
| 50 | list(opts?: Object): Promise<Array<Secret>>;
|
| 51 | /**
|
| 52 | * Create a secret
|
| 53 | * https://docs.docker.com/engine/api/v1.25/#operation/SecretCreate
|
| 54 | * @param {Object} opts Query params in the request (optional)
|
| 55 | * @return {Promise} Promise return the new secret
|
| 56 | */
|
| 57 | create(opts?: Object): Promise<Secret>;
|
| 58 | }
|