PHP Class Docker\API\Resource\MiscResource

Inheritance: extends Joli\Jane\OpenApi\Client\Resource
Afficher le fichier Open project: docker-php/docker-php Class Usage Examples

Méthodes publiques

Méthode Description
checkAuthentication ( Docker\API\Model\AuthConfig $authConfig, array $parameters = [], string $fetch = self::FETCH_OBJECT ) : Psr\Http\Message\ResponseInterface | AuthResult Check auth configuration.
getEvents ( array $parameters = [], string $fetch = self::FETCH_OBJECT ) : Psr\Http\Message\ResponseInterface Get container events from docker, either in real time via streaming, or via polling (using since).
getSystemInformation ( array $parameters = [], string $fetch = self::FETCH_OBJECT ) : Psr\Http\Message\ResponseInterface | SystemInformation Display system-wide information.
getVersion ( array $parameters = [], string $fetch = self::FETCH_OBJECT ) : Psr\Http\Message\ResponseInterface | Docker\API\Model\Version Show the docker version information.
ping ( array $parameters = [], string $fetch = self::FETCH_OBJECT ) : Psr\Http\Message\ResponseInterface Ping the docker server.

Method Details

checkAuthentication() public méthode

Check auth configuration.
public checkAuthentication ( Docker\API\Model\AuthConfig $authConfig, array $parameters = [], string $fetch = self::FETCH_OBJECT ) : Psr\Http\Message\ResponseInterface | AuthResult
$authConfig Docker\API\Model\AuthConfig Authentication to check
$parameters array List of parameters
$fetch string Fetch mode (object or response)
Résultat Psr\Http\Message\ResponseInterface | Docker\API\Model\AuthResult

getEvents() public méthode

Get container events from docker, either in real time via streaming, or via polling (using since).
public getEvents ( array $parameters = [], string $fetch = self::FETCH_OBJECT ) : Psr\Http\Message\ResponseInterface
$parameters array { @var int $since Timestamp used for polling @var int $until Timestamp used for polling @var string $filters A json encoded value of the filters (a map[string][]string) to process on the event list. }
$fetch string Fetch mode (object or response)
Résultat Psr\Http\Message\ResponseInterface

getSystemInformation() public méthode

Display system-wide information.
public getSystemInformation ( array $parameters = [], string $fetch = self::FETCH_OBJECT ) : Psr\Http\Message\ResponseInterface | SystemInformation
$parameters array List of parameters
$fetch string Fetch mode (object or response)
Résultat Psr\Http\Message\ResponseInterface | Docker\API\Model\SystemInformation

getVersion() public méthode

Show the docker version information.
public getVersion ( array $parameters = [], string $fetch = self::FETCH_OBJECT ) : Psr\Http\Message\ResponseInterface | Docker\API\Model\Version
$parameters array List of parameters
$fetch string Fetch mode (object or response)
Résultat Psr\Http\Message\ResponseInterface | Docker\API\Model\Version

ping() public méthode

Ping the docker server.
public ping ( array $parameters = [], string $fetch = self::FETCH_OBJECT ) : Psr\Http\Message\ResponseInterface
$parameters array List of parameters
$fetch string Fetch mode (object or response)
Résultat Psr\Http\Message\ResponseInterface