@digitalocean/dots - v1.0.1
    Preparing search index...

    Interface LogsRequestBuilder

    Builds and executes requests for operations under /v2/apps/{app_-id}/deployments/{deployment_id}/logs

    interface LogsRequestBuilder {
        get(
            requestConfiguration?: RequestConfiguration<
                LogsRequestBuilderGetQueryParameters,
            >,
        ): Promise<undefined | Apps_get_logs_response>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<
                LogsRequestBuilderGetQueryParameters,
            >,
        ): RequestInformation;
        withUrl(rawUrl: string): LogsRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    get toGetRequestInformation withUrl

    Methods

    • Retrieve the logs of a past, in-progress, or active deployment. If a component name is specified, the logs will be limited to only that component. The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment.

      Parameters

      Returns Promise<undefined | Apps_get_logs_response>

      error when the service returns a 401 status code

      error when the service returns a 404 status code

      error when the service returns a 429 status code

      error when the service returns a 500 status code

      error when the service returns a 4XX or 5XX status code

    • Retrieve the logs of a past, in-progress, or active deployment. If a component name is specified, the logs will be limited to only that component. The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment.

      Parameters

      Returns RequestInformation

    • Parameters

      • rawUrl: string

      Returns LogsRequestBuilder

    Settings

    Member Visibility

    On This Page

    Methods