Service
class Service extends AbstractObject implements IdAble
A content-addressed service providing TCP connectivity.
Properties
| $lastQuery | from AbstractObject |
Methods
No description
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.
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.
Details
in
AbstractObject at line 13
__construct(AbstractClient $client, QueryBuilderChain $queryBuilderChain)
No description
in
AbstractObject at line 19
protected null|array|string|int|float|bool
queryLeaf(QueryBuilder $leafQueryBuilder, string $leafKey)
No description
at line 23
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.
at line 38
string
hostname()
Retrieves a hostname which can be used by clients to reach this container.
at line 47
AbstractId
id()
A unique identifier for this Service.
at line 56
array
ports()
Retrieves the list of ports provided by the service.
at line 67
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.
at line 76
ServiceId
stop(bool|null $kill = false)
Stop the service.
at line 88
void
up(array|null $ports = null, bool|null $random = false)
Creates a tunnel that forwards traffic from the caller's network to this service.
at line 103
Service
withHostname(string $hostname)
Configures a hostname which can be used by clients within the session to reach this container.