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

    Interface WithIndex_nameItemRequestBuilder

    Builds and executes requests for operations under /v2/databases/{database_cluster_uuid}/indexes/{index_name}

    interface WithIndex_nameItemRequestBuilder {
        delete(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<void>;
        toDeleteRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): WithIndex_nameItemRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    delete toDeleteRequestInformation withUrl

    Methods

    • To delete a single index within OpenSearch cluster, send a DELETE requestto /v2/databases/$DATABASE_ID/indexes/$INDEX_NAME.A status of 204 will be given. This indicates that the request wasprocessed successfully, but that no response body is needed.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<void>

      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 single index within OpenSearch cluster, send a DELETE requestto /v2/databases/$DATABASE_ID/indexes/$INDEX_NAME.A status of 204 will be given. This indicates that the request wasprocessed successfully, but that no response body is needed.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    Settings

    Member Visibility

    On This Page

    Methods