View Source Dagger.Service (dagger v0.14.0)
A content-addressed service providing TCP connectivity.
Summary
Functions
Retrieves an endpoint that clients can use to reach this container.
Retrieves a hostname which can be used by clients to reach this container.
A unique identifier for this Service.
Retrieves the list of ports provided by the service.
Start the service and wait for its health checks to succeed.
Stop the service.
Creates a tunnel that forwards traffic from the caller's network to this service.
Configures a hostname which can be used by clients within the session to reach this container.
Types
Functions
@spec endpoint(t(), port: integer() | nil, scheme: String.t() | nil) :: {:ok, String.t()} | {:error, term()}
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.
Retrieves a hostname which can be used by clients to reach this container.
@spec id(t()) :: {:ok, Dagger.ServiceID.t()} | {:error, term()}
A unique identifier for this Service.
@spec ports(t()) :: {:ok, [Dagger.Port.t()]} | {:error, term()}
Retrieves the list of ports provided by the 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 the service.
@spec up(t(), ports: [Dagger.PortForward.t()], random: boolean() | nil) :: :ok | {:error, term()}
Creates a tunnel that forwards traffic from the caller's network to this service.
Configures a hostname which can be used by clients within the session to reach this container.