View Source Dagger.Service (dagger v0.9.3)
Service
Link to this section 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.
Link to this section Types
Link to this section Functions
@spec endpoint( t(), keyword() ) :: {:ok, Dagger.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.
optional-arguments
Optional Arguments
port
- The exposed port number for the endpointscheme
- Return a URL with the given scheme, eg. http for http://
@spec hostname(t()) :: {:ok, Dagger.String.t()} | {:error, term()}
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.
@spec start(t()) :: {:ok, Dagger.ServiceID.t()} | {:error, term()}
Start the service and wait for its health checks to succeed.
Services bound to a Container do not need to be manually started.
@spec stop(t()) :: {:ok, Dagger.ServiceID.t()} | {:error, term()}
Stop the service.