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

    Interface IndexesRequestBuilder

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

    interface IndexesRequestBuilder {
        byIndex_name(index_name: string): WithIndex_nameItemRequestBuilder;
        get(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | IndexesGetResponse>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): IndexesRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    byIndex_name get toGetRequestInformation withUrl

    Methods

    • To list all of a OpenSearch cluster's indexes, send a GET request to/v2/databases/$DATABASE_ID/indexes.The result will be a JSON object with a indexes key.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | IndexesGetResponse>

      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 list all of a OpenSearch cluster's indexes, send a GET request to/v2/databases/$DATABASE_ID/indexes.The result will be a JSON object with a indexes key.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • Parameters

      • rawUrl: string

      Returns IndexesRequestBuilder

    Settings

    Member Visibility

    On This Page

    Methods