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

    Interface WithLogsink_ItemRequestBuilder

    Builds and executes requests for operations under /v2/databases/{database_cluster_uuid}/logsink/{logsink_id}

    interface WithLogsink_ItemRequestBuilder {
        delete(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | ArrayBuffer>;
        get(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | WithLogsink_GetResponse>;
        put(
            body: Logsink_update,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | ArrayBuffer>;
        toDeleteRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toPutRequestInformation(
            body: Logsink_update,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): WithLogsink_ItemRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    delete get put toDeleteRequestInformation toGetRequestInformation toPutRequestInformation withUrl

    Methods

    • To delete a logsink for a database cluster, send a DELETE request to/v2/databases/$DATABASE_ID/logsink/$LOGSINK_ID.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns Promise<undefined | ArrayBuffer>

      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

    • To get a logsink for a database cluster, send a GET request to/v2/databases/$DATABASE_ID/logsink/$LOGSINK_ID.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns Promise<undefined | WithLogsink_GetResponse>

      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

    • To update a logsink for a database cluster, send a PUT request to/v2/databases/$DATABASE_ID/logsink/$LOGSINK_ID.

      Parameters

      • body: Logsink_update

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns Promise<undefined | ArrayBuffer>

      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

    • To delete a logsink for a database cluster, send a DELETE request to/v2/databases/$DATABASE_ID/logsink/$LOGSINK_ID.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns RequestInformation

    • To get a logsink for a database cluster, send a GET request to/v2/databases/$DATABASE_ID/logsink/$LOGSINK_ID.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns RequestInformation

    • To update a logsink for a database cluster, send a PUT request to/v2/databases/$DATABASE_ID/logsink/$LOGSINK_ID.

      Parameters

      • body: Logsink_update

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns RequestInformation

    Settings

    Member Visibility

    On This Page

    Methods