@dagger.io/dagger 0.8.8 → 0.9.0

package/dist/api/client.gen.js

@@ -157,13 +157,11 @@ export class Container extends BaseClient {
     /**
      * Constructor is used for internal usage only, do not create object from it.
      */
-    constructor(parent, _id, _endpoint, _envVariable, _export, _hostname, _imageRef, _label, _platform, _publish, _shellEndpoint, _stderr, _stdout, _sync, _user, _workdir) {
+    constructor(parent, _id, _envVariable, _export, _imageRef, _label, _platform, _publish, _shellEndpoint, _stderr, _stdout, _sync, _user, _workdir) {
         super(parent);
         this._id = undefined;
-        this._endpoint = undefined;
         this._envVariable = undefined;
         this._export = undefined;
-        this._hostname = undefined;
         this._imageRef = undefined;
         this._label = undefined;
         this._platform = undefined;
@@ -175,10 +173,8 @@ export class Container extends BaseClient {
         this._user = undefined;
         this._workdir = undefined;
         this._id = _id;
-        this._endpoint = _endpoint;
         this._envVariable = _envVariable;
         this._export = _export;
-        this._hostname = _hostname;
         this._imageRef = _imageRef;
         this._label = _label;
         this._platform = _platform;
@@ -207,6 +203,53 @@ export class Container extends BaseClient {
             return response;
         });
     }
+    /**
+     * Turn the container into a Service.
+     *
+     * Be sure to set any exposed ports before this conversion.
+     */
+    asService() {
+        return new Service({
+            queryTree: [
+                ...this._queryTree,
+                {
+                    operation: "asService",
+                },
+            ],
+            host: this.clientHost,
+            sessionToken: this.sessionToken,
+        });
+    }
+    /**
+     * Returns a File representing the container serialized to a tarball.
+     * @param opts.platformVariants Identifiers for other platform specific containers.
+     * Used for multi-platform image.
+     * @param opts.forcedCompression Force each layer of the image to use the specified compression algorithm.
+     * If this is unset, then if a layer already has a compressed blob in the engine's
+     * cache, that will be used (this can result in a mix of compression algorithms for
+     * different layers). If this is unset and a layer has no compressed blob in the
+     * engine's cache, then it will be compressed using Gzip.
+     * @param opts.mediaTypes Use the specified media types for the image's layers. Defaults to OCI, which
+     * is largely compatible with most recent container runtimes, but Docker may be needed
+     * for older runtimes without OCI support.
+     */
+    asTarball(opts) {
+        const metadata = {
+            forcedCompression: { is_enum: true },
+            mediaTypes: { is_enum: true },
+        };
+        return new File({
+            queryTree: [
+                ...this._queryTree,
+                {
+                    operation: "asTarball",
+                    args: Object.assign(Object.assign({}, opts), { __metadata: metadata }),
+                },
+            ],
+            host: this.clientHost,
+            sessionToken: this.sessionToken,
+        });
+    }
     /**
      * Initializes this container from a Dockerfile build.
      * @param context Directory context used by the Dockerfile.
@@ -269,32 +312,6 @@ export class Container extends BaseClient {
             sessionToken: this.sessionToken,
         });
     }
-    /**
-     * Retrieves an endpoint that clients can use to reach this container.
-     *
-     * If no port is specified, the first exposed port is used. If none exist an error is returned.
-     *
-     * If a scheme is specified, a URL is returned. Otherwise, a host:port pair is returned.
-     *
-     * Currently experimental; set _EXPERIMENTAL_DAGGER_SERVICES_DNS=0 to disable.
-     * @param opts.port The exposed port number for the endpoint
-     * @param opts.scheme Return a URL with the given scheme, eg. http for http://
-     */
-    endpoint(opts) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (this._endpoint) {
-                return this._endpoint;
-            }
-            const response = yield computeQuery([
-                ...this._queryTree,
-                {
-                    operation: "endpoint",
-                    args: Object.assign({}, opts),
-                },
-            ], this.client);
-            return response;
-        });
-    }
     /**
      * Retrieves entrypoint to be prepended to the arguments of all commands.
      */
@@ -391,8 +408,6 @@ export class Container extends BaseClient {
      *
      * This includes ports already exposed by the image, even if not
      * explicitly added with dagger.
-     *
-     * Currently experimental; set _EXPERIMENTAL_DAGGER_SERVICES_DNS=0 to disable.
      */
     exposedPorts() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -450,25 +465,6 @@ export class Container extends BaseClient {
             sessionToken: this.sessionToken,
         });
     }
-    /**
-     * Retrieves a hostname which can be used by clients to reach this container.
-     *
-     * Currently experimental; set _EXPERIMENTAL_DAGGER_SERVICES_DNS=0 to disable.
-     */
-    hostname() {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (this._hostname) {
-                return this._hostname;
-            }
-            const response = yield computeQuery([
-                ...this._queryTree,
-                {
-                    operation: "hostname",
-                },
-            ], this.client);
-            return response;
-        });
-    }
     /**
      * The unique image reference which can only be retrieved immediately after the 'Container.From' call.
      */
@@ -857,8 +853,6 @@ export class Container extends BaseClient {
      * Exposed ports serve two purposes:
      *   - For health checks and introspection, when running services
      *   - For setting the EXPOSE OCI field when publishing the container
-     *
-     * Currently experimental; set _EXPERIMENTAL_DAGGER_SERVICES_DNS=0 to disable.
      * @param port Port number to expose
      * @param opts.protocol Transport layer network protocol
      * @param opts.description Optional port description
@@ -1150,8 +1144,6 @@ export class Container extends BaseClient {
      * The service will be reachable from the container via the provided hostname alias.
      *
      * The service dependency will also convey to any files or directories produced by the container.
-     *
-     * Currently experimental; set _EXPERIMENTAL_DAGGER_SERVICES_DNS=0 to disable.
      * @param alias A name that can be used to reach the service from the container
      * @param service Identifier of the service container
      */
@@ -1244,8 +1236,6 @@ export class Container extends BaseClient {
     }
     /**
      * Unexpose a previously exposed port.
-     *
-     * Currently experimental; set _EXPERIMENTAL_DAGGER_SERVICES_DNS=0 to disable.
      * @param port Port number to unexpose
      * @param opts.protocol Port protocol to unexpose
      */
@@ -1423,10 +1413,6 @@ export class Directory extends BaseClient {
      *
      * If not set, the module source code is loaded from the root of the
      * directory.
-     * @param opts.runtime A pre-built runtime container to use instead of building one from the
-     * source code. This is useful for bootstrapping.
-     *
-     * You should ignore this unless you're building a Dagger SDK.
      */
     asModule(opts) {
         return new Module_({
@@ -2027,14 +2013,14 @@ export class Function_ extends BaseClient {
                     operation: "args",
                 },
                 {
-                    operation: "defaultValue description name",
+                    operation: "id",
                 },
             ], this.client);
             return response.map((r) => new FunctionArg({
                 queryTree: this.queryTree,
                 host: this.clientHost,
                 sessionToken: this.sessionToken,
-            }, r.defaultValue, r.description, r.name));
+            }, r.id));
         });
     }
     /**
@@ -2165,15 +2151,34 @@ export class FunctionArg extends BaseClient {
     /**
      * Constructor is used for internal usage only, do not create object from it.
      */
-    constructor(parent, _defaultValue, _description, _name) {
+    constructor(parent, _id, _defaultValue, _description, _name) {
         super(parent);
+        this._id = undefined;
         this._defaultValue = undefined;
         this._description = undefined;
         this._name = undefined;
+        this._id = _id;
         this._defaultValue = _defaultValue;
         this._description = _description;
         this._name = _name;
     }
+    /**
+     * The ID of the argument
+     */
+    id() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this._id) {
+                return this._id;
+            }
+            const response = yield computeQuery([
+                ...this._queryTree,
+                {
+                    operation: "id",
+                },
+            ], this.client);
+            return response;
+        });
+    }
     /**
      * A default value to use for this argument when not explicitly set by the caller, if any
      */
@@ -2462,22 +2467,6 @@ export class GeneratedCode extends BaseClient {
             return response;
         });
     }
-    /**
-     * Set the directory containing the generated code
-     */
-    withCode(code) {
-        return new GeneratedCode({
-            queryTree: [
-                ...this._queryTree,
-                {
-                    operation: "withCode",
-                    args: { code },
-                },
-            ],
-            host: this.clientHost,
-            sessionToken: this.sessionToken,
-        });
-    }
     /**
      * Set the list of paths to mark generated in version control
      */
@@ -2654,6 +2643,29 @@ export class Host extends BaseClient {
             sessionToken: this.sessionToken,
         });
     }
+    /**
+     * Creates a service that forwards traffic to a specified address via the host.
+     * @param ports Ports to expose via the service, forwarding through the host network.
+     *
+     * If a port's frontend is unspecified or 0, it defaults to the same as the
+     * backend port.
+     *
+     * An empty set of ports is not valid; an error will be returned.
+     * @param opts.host Upstream host to forward traffic to.
+     */
+    service(ports, opts) {
+        return new Service({
+            queryTree: [
+                ...this._queryTree,
+                {
+                    operation: "service",
+                    args: Object.assign({ ports }, opts),
+                },
+            ],
+            host: this.clientHost,
+            sessionToken: this.sessionToken,
+        });
+    }
     /**
      * Sets a secret given a user-defined name and the file path on the host, and returns the secret.
      * The file is limited to a size of 512000 bytes.
@@ -2673,6 +2685,37 @@ export class Host extends BaseClient {
             sessionToken: this.sessionToken,
         });
     }
+    /**
+     * Creates a tunnel that forwards traffic from the host to a service.
+     * @param service Service to send traffic from the tunnel.
+     * @param opts.native Map each service port to the same port on the host, as if the service were
+     * running natively.
+     *
+     * Note: enabling may result in port conflicts.
+     * @param opts.ports Configure explicit port forwarding rules for the tunnel.
+     *
+     * If a port's frontend is unspecified or 0, a random port will be chosen by
+     * the host.
+     *
+     * If no ports are given, all of the service's ports are forwarded. If native
+     * is true, each port maps to the same port on the host. If native is false,
+     * each port maps to a random port chosen by the host.
+     *
+     * If ports are given and native is true, the ports are additive.
+     */
+    tunnel(service, opts) {
+        return new Service({
+            queryTree: [
+                ...this._queryTree,
+                {
+                    operation: "tunnel",
+                    args: Object.assign({ service }, opts),
+                },
+            ],
+            host: this.clientHost,
+            sessionToken: this.sessionToken,
+        });
+    }
     /**
      * Accesses a Unix socket on the host.
      * @param path Location of the Unix socket (e.g., "/var/run/docker.sock").
@@ -2770,20 +2813,18 @@ export class Module_ extends BaseClient {
     /**
      * Constructor is used for internal usage only, do not create object from it.
      */
-    constructor(parent, _id, _description, _name, _sdk, _sdkRuntime, _serve, _sourceDirectorySubPath) {
+    constructor(parent, _id, _description, _name, _sdk, _serve, _sourceDirectorySubPath) {
         super(parent);
         this._id = undefined;
         this._description = undefined;
         this._name = undefined;
         this._sdk = undefined;
-        this._sdkRuntime = undefined;
         this._serve = undefined;
         this._sourceDirectorySubPath = undefined;
         this._id = _id;
         this._description = _description;
         this._name = _name;
         this._sdk = _sdk;
-        this._sdkRuntime = _sdkRuntime;
         this._serve = _serve;
         this._sourceDirectorySubPath = _sourceDirectorySubPath;
     }
@@ -2910,7 +2951,7 @@ export class Module_ extends BaseClient {
         });
     }
     /**
-     * The SDK used by this module
+     * The SDK used by this module. Either a name of a builtin SDK or a module ref pointing to the SDK's implementation.
      */
     sdk() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -2926,29 +2967,12 @@ export class Module_ extends BaseClient {
             return response;
         });
     }
-    /**
-     * The SDK runtime module image ref.
-     */
-    sdkRuntime() {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (this._sdkRuntime) {
-                return this._sdkRuntime;
-            }
-            const response = yield computeQuery([
-                ...this._queryTree,
-                {
-                    operation: "sdkRuntime",
-                },
-            ], this.client);
-            return response;
-        });
-    }
     /**
      * Serve a module's API in the current session.
      *     Note: this can only be called once per session.
      *     In the future, it could return a stream or service to remove the side effect.
      */
-    serve(opts) {
+    serve() {
         return __awaiter(this, void 0, void 0, function* () {
             if (this._serve) {
                 return this._serve;
@@ -2957,7 +2981,6 @@ export class Module_ extends BaseClient {
                 ...this._queryTree,
                 {
                     operation: "serve",
-                    args: Object.assign({}, opts),
                 },
             ], this.client);
             return response;
@@ -3020,6 +3043,116 @@ export class Module_ extends BaseClient {
         return arg(this);
     }
 }
+/**
+ * Static configuration for a module (e.g. parsed contents of dagger.json)
+ */
+export class ModuleConfig extends BaseClient {
+    /**
+     * Constructor is used for internal usage only, do not create object from it.
+     */
+    constructor(parent, _name, _root, _sdk) {
+        super(parent);
+        this._name = undefined;
+        this._root = undefined;
+        this._sdk = undefined;
+        this._name = _name;
+        this._root = _root;
+        this._sdk = _sdk;
+    }
+    /**
+     * Modules that this module depends on.
+     */
+    dependencies() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield computeQuery([
+                ...this._queryTree,
+                {
+                    operation: "dependencies",
+                },
+            ], this.client);
+            return response;
+        });
+    }
+    /**
+     * Exclude these file globs when loading the module root.
+     */
+    exclude() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield computeQuery([
+                ...this._queryTree,
+                {
+                    operation: "exclude",
+                },
+            ], this.client);
+            return response;
+        });
+    }
+    /**
+     * Include only these file globs when loading the module root.
+     */
+    include() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield computeQuery([
+                ...this._queryTree,
+                {
+                    operation: "include",
+                },
+            ], this.client);
+            return response;
+        });
+    }
+    /**
+     * The name of the module.
+     */
+    name() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this._name) {
+                return this._name;
+            }
+            const response = yield computeQuery([
+                ...this._queryTree,
+                {
+                    operation: "name",
+                },
+            ], this.client);
+            return response;
+        });
+    }
+    /**
+     * The root directory of the module's project, which may be above the module source code.
+     */
+    root() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this._root) {
+                return this._root;
+            }
+            const response = yield computeQuery([
+                ...this._queryTree,
+                {
+                    operation: "root",
+                },
+            ], this.client);
+            return response;
+        });
+    }
+    /**
+     * Either the name of a built-in SDK ('go', 'python', etc.) OR a module reference pointing to the SDK's module implementation.
+     */
+    sdk() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this._sdk) {
+                return this._sdk;
+            }
+            const response = yield computeQuery([
+                ...this._queryTree,
+                {
+                    operation: "sdk",
+                },
+            ], this.client);
+            return response;
+        });
+    }
+}
 /**
  * A definition of a custom object defined in a Module.
  */
@@ -3224,11 +3357,10 @@ export class Client extends BaseClient {
         });
     }
     /**
-     * Loads a container from ID.
+     * Creates a scratch container or loads one by ID.
      *
-     * Null ID returns an empty container (scratch).
-     * Optional platform argument initializes new containers to execute and publish as that platform.
-     * Platform defaults to that of the builder's host.
+     * Optional platform argument initializes new containers to execute and publish
+     * as that platform. Platform defaults to that of the builder's host.
      */
     container(opts) {
         return new Container({
@@ -3290,7 +3422,7 @@ export class Client extends BaseClient {
         });
     }
     /**
-     * Load a directory by ID. No argument produces an empty directory.
+     * Creates an empty directory or loads one by ID.
      */
     directory(opts) {
         return new Directory({
@@ -3307,6 +3439,7 @@ export class Client extends BaseClient {
     }
     /**
      * Loads a file by ID.
+     * @deprecated Use loadFileFromID instead.
      */
     file(id) {
         return new File({
@@ -3322,15 +3455,15 @@ export class Client extends BaseClient {
         });
     }
     /**
-     * Load a function by ID
+     * Create a function.
      */
-    function_(id) {
+    function_(name, returnType) {
         return new Function_({
             queryTree: [
                 ...this._queryTree,
                 {
                     operation: "function",
-                    args: { id },
+                    args: { name, returnType },
                 },
             ],
             host: this.clientHost,
@@ -3338,15 +3471,16 @@ export class Client extends BaseClient {
         });
     }
     /**
-     * Load GeneratedCode by ID, or create a new one if id is unset.
+     * Create a code generation result, given a directory containing the generated
+     * code.
      */
-    generatedCode(opts) {
+    generatedCode(code) {
         return new GeneratedCode({
             queryTree: [
                 ...this._queryTree,
                 {
                     operation: "generatedCode",
-                    args: Object.assign({}, opts),
+                    args: { code },
                 },
             ],
             host: this.clientHost,
@@ -3408,15 +3542,206 @@ export class Client extends BaseClient {
         });
     }
     /**
-     * Load a module by ID, or create a new one if id is unset.
+     * Load a CacheVolume from its ID.
      */
-    module_(opts) {
+    loadCacheVolumeFromID(id) {
+        return new CacheVolume({
+            queryTree: [
+                ...this._queryTree,
+                {
+                    operation: "loadCacheVolumeFromID",
+                    args: { id },
+                },
+            ],
+            host: this.clientHost,
+            sessionToken: this.sessionToken,
+        });
+    }
+    /**
+     * Loads a container from an ID.
+     */
+    loadContainerFromID(id) {
+        return new Container({
+            queryTree: [
+                ...this._queryTree,
+                {
+                    operation: "loadContainerFromID",
+                    args: { id },
+                },
+            ],
+            host: this.clientHost,
+            sessionToken: this.sessionToken,
+        });
+    }
+    /**
+     * Load a Directory from its ID.
+     */
+    loadDirectoryFromID(id) {
+        return new Directory({
+            queryTree: [
+                ...this._queryTree,
+                {
+                    operation: "loadDirectoryFromID",
+                    args: { id },
+                },
+            ],
+            host: this.clientHost,
+            sessionToken: this.sessionToken,
+        });
+    }
+    /**
+     * Load a File from its ID.
+     */
+    loadFileFromID(id) {
+        return new File({
+            queryTree: [
+                ...this._queryTree,
+                {
+                    operation: "loadFileFromID",
+                    args: { id },
+                },
+            ],
+            host: this.clientHost,
+            sessionToken: this.sessionToken,
+        });
+    }
+    /**
+     * Load a function argument by ID.
+     */
+    loadFunctionArgFromID(id) {
+        return new FunctionArg({
+            queryTree: [
+                ...this._queryTree,
+                {
+                    operation: "loadFunctionArgFromID",
+                    args: { id },
+                },
+            ],
+            host: this.clientHost,
+            sessionToken: this.sessionToken,
+        });
+    }
+    /**
+     * Load a function by ID.
+     */
+    loadFunctionFromID(id) {
+        return new Function_({
+            queryTree: [
+                ...this._queryTree,
+                {
+                    operation: "loadFunctionFromID",
+                    args: { id },
+                },
+            ],
+            host: this.clientHost,
+            sessionToken: this.sessionToken,
+        });
+    }
+    /**
+     * Load a GeneratedCode by ID.
+     */
+    loadGeneratedCodeFromID(id) {
+        return new GeneratedCode({
+            queryTree: [
+                ...this._queryTree,
+                {
+                    operation: "loadGeneratedCodeFromID",
+                    args: { id },
+                },
+            ],
+            host: this.clientHost,
+            sessionToken: this.sessionToken,
+        });
+    }
+    /**
+     * Load a module by ID.
+     */
+    loadModuleFromID(id) {
+        return new Module_({
+            queryTree: [
+                ...this._queryTree,
+                {
+                    operation: "loadModuleFromID",
+                    args: { id },
+                },
+            ],
+            host: this.clientHost,
+            sessionToken: this.sessionToken,
+        });
+    }
+    /**
+     * Load a Secret from its ID.
+     */
+    loadSecretFromID(id) {
+        return new Secret({
+            queryTree: [
+                ...this._queryTree,
+                {
+                    operation: "loadSecretFromID",
+                    args: { id },
+                },
+            ],
+            host: this.clientHost,
+            sessionToken: this.sessionToken,
+        });
+    }
+    /**
+     * Loads a service from ID.
+     */
+    loadServiceFromID(id) {
+        return new Service({
+            queryTree: [
+                ...this._queryTree,
+                {
+                    operation: "loadServiceFromID",
+                    args: { id },
+                },
+            ],
+            host: this.clientHost,
+            sessionToken: this.sessionToken,
+        });
+    }
+    /**
+     * Load a Socket from its ID.
+     */
+    loadSocketFromID(id) {
+        return new Socket({
+            queryTree: [
+                ...this._queryTree,
+                {
+                    operation: "loadSocketFromID",
+                    args: { id },
+                },
+            ],
+            host: this.clientHost,
+            sessionToken: this.sessionToken,
+        });
+    }
+    /**
+     * Load a TypeDef by ID.
+     */
+    loadTypeDefFromID(id) {
+        return new TypeDef({
+            queryTree: [
+                ...this._queryTree,
+                {
+                    operation: "loadTypeDefFromID",
+                    args: { id },
+                },
+            ],
+            host: this.clientHost,
+            sessionToken: this.sessionToken,
+        });
+    }
+    /**
+     * Create a new module.
+     */
+    module_() {
         return new Module_({
             queryTree: [
                 ...this._queryTree,
                 {
                     operation: "module",
-                    args: Object.assign({}, opts),
                 },
             ],
             host: this.clientHost,
@@ -3424,15 +3749,15 @@ export class Client extends BaseClient {
         });
     }
     /**
-     * Create a new function from the provided definition.
+     * Load the static configuration for a module from the given source directory and optional subpath.
      */
-    newFunction(name, returnType) {
-        return new Function_({
+    moduleConfig(sourceDirectory, opts) {
+        return new ModuleConfig({
             queryTree: [
                 ...this._queryTree,
                 {
-                    operation: "newFunction",
-                    args: { name, returnType },
+                    operation: "moduleConfig",
+                    args: Object.assign({ sourceDirectory }, opts),
                 },
             ],
             host: this.clientHost,
@@ -3460,6 +3785,7 @@ export class Client extends BaseClient {
     }
     /**
      * Loads a secret from its ID.
+     * @deprecated Use loadSecretFromID instead
      */
     secret(id) {
         return new Secret({
@@ -3495,6 +3821,7 @@ export class Client extends BaseClient {
     }
     /**
      * Loads a socket by its ID.
+     * @deprecated Use loadSocketFromID instead.
      */
     socket(opts) {
         return new Socket({
@@ -3509,13 +3836,15 @@ export class Client extends BaseClient {
             sessionToken: this.sessionToken,
         });
     }
-    typeDef(opts) {
+    /**
+     * Create a new TypeDef.
+     */
+    typeDef() {
         return new TypeDef({
             queryTree: [
                 ...this._queryTree,
                 {
                     operation: "typeDef",
-                    args: Object.assign({}, opts),
                 },
             ],
             host: this.clientHost,
@@ -3580,6 +3909,133 @@ export class Secret extends BaseClient {
         });
     }
 }
+export class Service extends BaseClient {
+    /**
+     * Constructor is used for internal usage only, do not create object from it.
+     */
+    constructor(parent, _id, _endpoint, _hostname, _start, _stop) {
+        super(parent);
+        this._id = undefined;
+        this._endpoint = undefined;
+        this._hostname = undefined;
+        this._start = undefined;
+        this._stop = undefined;
+        this._id = _id;
+        this._endpoint = _endpoint;
+        this._hostname = _hostname;
+        this._start = _start;
+        this._stop = _stop;
+    }
+    /**
+     * A unique identifier for this service.
+     */
+    id() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this._id) {
+                return this._id;
+            }
+            const response = yield computeQuery([
+                ...this._queryTree,
+                {
+                    operation: "id",
+                },
+            ], this.client);
+            return response;
+        });
+    }
+    /**
+     * Retrieves an endpoint that clients can use to reach this container.
+     *
+     * If no port is specified, the first exposed port is used. If none exist an error is returned.
+     *
+     * If a scheme is specified, a URL is returned. Otherwise, a host:port pair is returned.
+     * @param opts.port The exposed port number for the endpoint
+     * @param opts.scheme Return a URL with the given scheme, eg. http for http://
+     */
+    endpoint(opts) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this._endpoint) {
+                return this._endpoint;
+            }
+            const response = yield computeQuery([
+                ...this._queryTree,
+                {
+                    operation: "endpoint",
+                    args: Object.assign({}, opts),
+                },
+            ], this.client);
+            return response;
+        });
+    }
+    /**
+     * Retrieves a hostname which can be used by clients to reach this container.
+     */
+    hostname() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this._hostname) {
+                return this._hostname;
+            }
+            const response = yield computeQuery([
+                ...this._queryTree,
+                {
+                    operation: "hostname",
+                },
+            ], this.client);
+            return response;
+        });
+    }
+    /**
+     * Retrieves the list of ports provided by the service.
+     */
+    ports() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield computeQuery([
+                ...this._queryTree,
+                {
+                    operation: "ports",
+                },
+                {
+                    operation: "description port protocol",
+                },
+            ], this.client);
+            return response.map((r) => new Port({
+                queryTree: this.queryTree,
+                host: this.clientHost,
+                sessionToken: this.sessionToken,
+            }, r.description, r.port, r.protocol));
+        });
+    }
+    /**
+     * Start the service and wait for its health checks to succeed.
+     *
+     * Services bound to a Container do not need to be manually started.
+     */
+    start() {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield computeQuery([
+                ...this._queryTree,
+                {
+                    operation: "start",
+                },
+            ], this.client);
+            return this;
+        });
+    }
+    /**
+     * Stop the service.
+     */
+    stop() {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield computeQuery([
+                ...this._queryTree,
+                {
+                    operation: "stop",
+                },
+            ], this.client);
+            return this;
+        });
+    }
+}
 export class Socket extends BaseClient {
     /**
      * Constructor is used for internal usage only, do not create object from it.