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