docs/static/reference/php/Dagger/Service.html
class Service extends AbstractObject implements IdAble
A content-addressed service providing TCP connectivity.
| | $lastQuery | | from AbstractObject |
__construct(AbstractClient $client, QueryBuilderChain $queryBuilderChain)
No description
from AbstractObject
null|array|string|int|float|bool
queryLeaf(QueryBuilder $leafQueryBuilder, string $leafKey)
No description
from AbstractObject
string
endpoint(int|null $port = null, string|null $scheme = '')
Retrieves an endpoint that clients can use to reach this container.
string
hostname()
Retrieves a hostname which can be used by clients to reach this container.
id()
A unique identifier for this Service.
array
ports()
Retrieves the list of ports provided by the service.
start()
Start the service and wait for its health checks to succeed.
stop(bool|null $kill = false)
Stop the service.
sync()
Forces evaluation of the pipeline in the engine.
terminal(array|null $cmd = null)
No description
void
up(array|null $ports = null, bool|null $random = false)
Creates a tunnel that forwards traffic from the caller's network to this service.
withHostname(string $hostname)
Configures a hostname which can be used by clients within the session to reach this container.
__construct(AbstractClient $client, QueryBuilderChain $queryBuilderChain) No description
| AbstractClient | $client | | | QueryBuilderChain | $queryBuilderChain | |
protected null|array|string|int|float|bool queryLeaf(QueryBuilder $leafQueryBuilder, string $leafKey)No description
| QueryBuilder | $leafQueryBuilder | | | string | $leafKey | |
| null|array|string|int|float|bool | |
string endpoint(int|null $port = null, string|null $scheme = '')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.
| int|null | $port | | | string|null | $scheme | |
| string | |
string hostname()Retrieves a hostname which can be used by clients to reach this container.
| string | |
AbstractId id()A unique identifier for this Service.
| AbstractId | |
array ports()Retrieves the list of ports provided by the service.
| array | |
ServiceId start()Start the service and wait for its health checks to succeed.
Services bound to a Container do not need to be manually started.
| ServiceId | |
ServiceId stop(bool|null $kill = false)Stop the service.
| bool|null | $kill | |
| ServiceId | |
ServiceId sync()Forces evaluation of the pipeline in the engine.
| ServiceId | |
Service terminal(array|null $cmd = null)No description
| array|null | $cmd | |
| Service | |
void up(array|null $ports = null, bool|null $random = false)Creates a tunnel that forwards traffic from the caller's network to this service.
| array|null | $ports | | | bool|null | $random | |
| void | |
Service withHostname(string $hostname)Configures a hostname which can be used by clients within the session to reach this container.
| string | $hostname | |
| Service | |
Generated by Doctum, a API Documentation generator and fork of Sami.