dagger_gleam - v0.1.0

dagger/dsl/service

Types

Opts

</> 
pub type Opts {
  Opts(
    port: option.Option(Int),
    scheme: option.Option(String),
    kill: option.Option(Bool),
    cmd: option.Option(List(String)),
    ports: option.Option(List(types.PortForward)),
    random: option.Option(Bool),
  )
}

Constructors

Values

cmd

</> 
pub fn cmd(opts: Opts, val: List(String)) -> Opts

endpoint

</> 
pub fn endpoint(
  parent: types.Service,
  with with_fn: fn(Opts) -> Opts,
  client client: types.Client,
  then handler: fn(Result(String, types.QueryError)) -> a,
) -> a

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.

hostname

</> 
pub fn hostname(
  parent: types.Service,
  client client: types.Client,
  then handler: fn(Result(String, types.QueryError)) -> a,
) -> a

Retrieves a hostname which can be used by clients to reach this container.

id

</> 
pub fn id(parent: types.Service) -> types.Service

A unique identifier for this Service.

kill

</> 
pub fn kill(opts: Opts, val: Bool) -> Opts

none

</> 
pub fn none(opts: Opts) -> Opts

opt_ports

</> 
pub fn opt_ports(
  opts: Opts,
  val: List(types.PortForward),
) -> Opts

port

</> 
pub fn port(opts: Opts, val: Int) -> Opts

ports

</> 
pub fn ports(
  parent: types.Service,
  select select: fn(types.Port) -> List(types.Field),
  client client: types.Client,
  then handler: fn(Result(List(types.Port), types.QueryError)) -> a,
) -> a

Retrieves the list of ports provided by the service.

random

</> 
pub fn random(opts: Opts, val: Bool) -> Opts

scheme

</> 
pub fn scheme(opts: Opts, val: String) -> Opts

service

</> 
pub fn service(id id: types.Service) -> types.Service

start

</> 
pub fn start(parent: types.Service) -> types.Service

Start the service and wait for its health checks to succeed. Services bound to a Container do not need to be manually started.

stop

</> 
pub fn stop(
  parent: types.Service,
  with with_fn: fn(Opts) -> Opts,
) -> types.Service

Stop the service.

sync

</> 
pub fn sync(parent: types.Service) -> types.Service

Forces evaluation of the pipeline in the engine.

terminal

</> 
pub fn terminal(
  parent: types.Service,
  with with_fn: fn(Opts) -> Opts,
) -> types.Service

up

</> 
pub fn up(
  parent: types.Service,
  with with_fn: fn(Opts) -> Opts,
  client client: types.Client,
  then handler: fn(Result(Nil, types.QueryError)) -> a,
) -> a

Creates a tunnel that forwards traffic from the caller’s network to this service.

with_hostname

</> 
pub fn with_hostname(
  parent: types.Service,
  hostname hostname: String,
) -> types.Service

Configures a hostname which can be used by clients within the session to reach this container.

✨ Search Document