Logs.php

<?php

namespace AcquiaCloudApi\Endpoints;

use AcquiaCloudApi\Response\LogResponse;
use AcquiaCloudApi\Response\LogsResponse;
use AcquiaCloudApi\Response\LogstreamResponse;
use AcquiaCloudApi\Response\OperationResponse;
use Psr\Http\Message\StreamInterface;

/**
 * Class Logs
 *
 * @package AcquiaCloudApi\CloudApi
 */
class Logs extends CloudApiBase
{
    /**
     * Returns a list of log files available for download.
     *
     * @return LogsResponse<LogResponse>
     */
    public function getAll(string $environmentUuid): LogsResponse
    {
        return new LogsResponse(
            $this->client->request('get', "/environments/$environmentUuid/logs")
        );
    }

    /**
     * Downloads a log file.
     */
    public function download(string $environmentUuid, string $logType): StreamInterface
    {
        return $this->client->stream('get', "/environments/$environmentUuid/logs/$logType");
    }

    /**
     * Returns logstream WSS stream information.
     */
    public function stream(string $environmentUuid): LogstreamResponse
    {
        return new LogstreamResponse(
            $this->client->request('get', "/environments/$environmentUuid/logstream")
        );
    }

    /**
     * Creates a log file snapshot.
     */
    public function snapshot(string $environmentUuid, string $logType): OperationResponse
    {
        return new OperationResponse(
            $this->client->request('post', "/environments/$environmentUuid/logs/$logType")
        );
    }
}