| 1 | /**
|
| 2 | * Class reprensenting a plugin
|
| 3 | */
|
| 4 | declare class Plugin {
|
| 5 | modem: any;
|
| 6 | id: any;
|
| 7 | /**
|
| 8 | * Creates a new plugin
|
| 9 | * @param {Modem} modem Modem to connect to the remote service
|
| 10 | * @param {string} id Id of the plugin (optional)
|
| 11 | */
|
| 12 | constructor(modem: any, id?: any);
|
| 13 | /**
|
| 14 | * Get the list of plugins
|
| 15 | * https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/list-plugins
|
| 16 | * @param {Object} opts Query params in the request (optional)
|
| 17 | * {Promise} Promise returning the result as a list of plugins
|
| 18 | */
|
| 19 | list(opts: any): Promise<{}>;
|
| 20 | /**
|
| 21 | * upgrade a plugin
|
| 22 | * https://docs.docker.com/engine/api/v1.26/#operation/PluginUpgrade
|
| 23 | * @param {Object} opts Query params in the request (optional)
|
| 24 | * @return {Promise} Promise return the new plugin
|
| 25 | */
|
| 26 | upgrade(opts: any): Promise<{}>;
|
| 27 | /**
|
| 28 | * Create a plugin
|
| 29 | * https://docs.docker.com/engine/api/v1.25/#operation/PluginCreate
|
| 30 | * @param {Object} opts Query params in the request (optional)
|
| 31 | * @return {Promise} Promise return the new plugin
|
| 32 | */
|
| 33 | create(opts: any): Promise<{}>;
|
| 34 | /**
|
| 35 | * install a plugin
|
| 36 | * https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/install-a-plugin
|
| 37 | * @param {Object} opts Query params in the request (optional)
|
| 38 | * @return {Promise} Promise return the new plugin
|
| 39 | */
|
| 40 | install(opts: any): Promise<{}>;
|
| 41 | /**
|
| 42 | * Get low-level information on a plugin
|
| 43 | * https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/inspect-a-plugin
|
| 44 | * The reason why this module isn't called inspect is because that interferes with the inspect utility of node.
|
| 45 | * @param {Object} opts Query params in the request (optional)
|
| 46 | * @param {String} id ID of the plugin to inspect, if it's not set, use the id of the object (optional)
|
| 47 | * @return {Promise} Promise return the plugin
|
| 48 | */
|
| 49 | status(opts: any, id: any): Promise<{}>;
|
| 50 | /**
|
| 51 | * Remove a plugin
|
| 52 | * https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/remove-a-plugin
|
| 53 | * @param {Object} opts Query params in the request (optional)
|
| 54 | * @param {String} id ID of the plugin to inspect, if it's not set, use the id of the object (optional)
|
| 55 | * @return {Promise} Promise return the result
|
| 56 | */
|
| 57 | remove(opts: any, id: any): Promise<{}>;
|
| 58 | /**
|
| 59 | * push a plugin
|
| 60 | * https://docs.docker.com/engine/api/v1.26/#operation/PluginPush
|
| 61 | * @param {Object} opts Query params in the request (optional)
|
| 62 | * @param {String} id ID of the plugin, if it's not set, use the id of the object (optional)
|
| 63 | * @return {Promise} Promise return the plugin
|
| 64 | */
|
| 65 | push(opts: any, id: any): Promise<{}>;
|
| 66 | /**
|
| 67 | * Set a plugin configuration
|
| 68 | * https://docs.docker.com/engine/api/v1.25/#operation/PluginSet
|
| 69 | * @param {Object} opts Query params in the request (optional)
|
| 70 | * @param {String} id ID of the plugin, if it's not set, use the id of the object (optional)
|
| 71 | * @return {Promise} Promise return the plugin
|
| 72 | */
|
| 73 | set(opts: any, id: any): Promise<{}>;
|
| 74 | /**
|
| 75 | * Enable a plugin
|
| 76 | * https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/enable-a-plugin
|
| 77 | * @param {Object} opts Query params in the request (optional)
|
| 78 | * @param {String} id ID of the plugin, if it's not set, use the id of the object (optional)
|
| 79 | * @return {Promise} Promise return the plugin
|
| 80 | */
|
| 81 | enable(opts: any, id: any): Promise<{}>;
|
| 82 | /**
|
| 83 | * Disable a plugin
|
| 84 | * https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/disable-a-plugin
|
| 85 | * @param {Object} opts Query params in the request (optional)
|
| 86 | * @param {String} id ID of the plugin, if it's not set, use the id of the object (optional)
|
| 87 | * @return {Promise} Promise return the plugin
|
| 88 | */
|
| 89 | disable(opts: any, id: any): Promise<{}>;
|
| 90 | __processArguments(opts: any, id?: any): any[];
|
| 91 | }
|
| 92 | export default Plugin;
|