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

    Interface ExecRequestBuilder

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

    interface ExecRequestBuilder {
        get(
            requestConfiguration?: RequestConfiguration<
                ExecRequestBuilderGetQueryParameters,
            >,
        ): Promise<undefined | Apps_get_exec_response>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<
                ExecRequestBuilderGetQueryParameters,
            >,
        ): RequestInformation;
        withUrl(rawUrl: string): ExecRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    get toGetRequestInformation withUrl

    Methods

    • Returns a websocket URL that allows sending/receiving console input and output to a component of the specified deployment if one exists. Optionally, the instance_name parameter can be provided to retrieve the exec URL for a specific instance. Note that instances are ephemeral; therefore, we recommended to avoid making persistent changes or such scripting around them.

      Parameters

      Returns Promise<undefined | Apps_get_exec_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

    • Returns a websocket URL that allows sending/receiving console input and output to a component of the specified deployment if one exists. Optionally, the instance_name parameter can be provided to retrieve the exec URL for a specific instance. Note that instances are ephemeral; therefore, we recommended to avoid making persistent changes or such scripting around them.

      Parameters

      Returns RequestInformation

    • Parameters

      • rawUrl: string

      Returns ExecRequestBuilder

    Settings

    Member Visibility

    On This Page

    Methods