cloudflare/resources/load-balancers/searches.d.ts

The official TypeScript library for the Cloudflare API

import { APIResource } from "../../resource.js";
import * as Core from "../../core.js";
import { V4PagePagination, type V4PagePaginationParams } from "../../pagination.js";
export declare class Searches extends APIResource {
    /**
     * Search for Load Balancing resources.
     */
    list(params: SearchListParams, options?: Core.RequestOptions): Core.PagePromise<SearchListResponsesV4PagePagination, SearchListResponse>;
}
export declare class SearchListResponsesV4PagePagination extends V4PagePagination<SearchListResponse> {
}
export interface SearchListResponse {
    /**
     * A list of resources matching the search query.
     */
    resources?: Array<SearchListResponse.Resource>;
}
export declare namespace SearchListResponse {
    /**
     * A reference to a load balancer resource.
     */
    interface Resource {
        /**
         * When listed as a reference, the type (direction) of the reference.
         */
        reference_type?: 'referral' | 'referrer';
        /**
         * A list of references to (referrer) or from (referral) this resource.
         */
        references?: Array<unknown>;
        resource_id?: string;
        /**
         * The human-identifiable name of the resource.
         */
        resource_name?: string;
        /**
         * The type of the resource.
         */
        resource_type?: 'load_balancer' | 'monitor' | 'pool';
    }
}
export interface SearchListParams extends V4PagePaginationParams {
    /**
     * Path param: Identifier
     */
    account_id: string;
    /**
     * Query param:
     */
    search_params?: SearchListParams.SearchParams;
}
export declare namespace SearchListParams {
    interface SearchParams {
        /**
         * Search query term.
         */
        query?: string;
        /**
         * The type of references to include ("\*" for all).
         */
        references?: '' | '*' | 'referral' | 'referrer';
    }
}
export declare namespace Searches {
    export { type SearchListResponse as SearchListResponse, SearchListResponsesV4PagePagination as SearchListResponsesV4PagePagination, type SearchListParams as SearchListParams, };
}
//# sourceMappingURL=searches.d.ts.map