cloudflare/resources/logpush/edge.d.ts

The official TypeScript library for the Cloudflare API

import { APIResource } from "../../core/resource.js";
import { APIPromise } from "../../core/api-promise.js";
import { PagePromise, SinglePage } from "../../core/pagination.js";
import { RequestOptions } from "../../internal/request-options.js";
export declare class BaseEdge extends APIResource {
    static readonly _key: readonly ['logpush', 'edge'];
    /**
     * Creates a new Instant Logs job for a zone.
     *
     * @example
     * ```ts
     * const instantLogpushJob = await client.logpush.edge.create({
     *   zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
     * });
     * ```
     */
    create(params: EdgeCreateParams, options?: RequestOptions): APIPromise<InstantLogpushJob | null>;
    /**
     * Lists Instant Logs jobs for a zone.
     *
     * @example
     * ```ts
     * // Automatically fetches more pages as needed.
     * for await (const instantLogpushJob of client.logpush.edge.get(
     *   { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
     * )) {
     *   // ...
     * }
     * ```
     */
    get(params: EdgeGetParams, options?: RequestOptions): PagePromise<InstantLogpushJobsSinglePage, InstantLogpushJob | null>;
}
export declare class Edge extends BaseEdge {
}
export type InstantLogpushJobsSinglePage = SinglePage<InstantLogpushJob | null>;
export interface InstantLogpushJob {
    /**
     * Unique WebSocket address that will receive messages from Cloudflare’s edge.
     */
    destination_conf?: string;
    /**
     * Comma-separated list of fields.
     */
    fields?: string;
    /**
     * Filters to drill down into specific events.
     */
    filter?: string;
    /**
     * The sample parameter is the sample rate of the records set by the client:
     * "sample": 1 is 100% of records "sample": 10 is 10% and so on.
     */
    sample?: number;
    /**
     * Unique session id of the job.
     */
    session_id?: string;
}
export interface EdgeCreateParams {
    /**
     * Path param: Identifier.
     */
    zone_id: string;
    /**
     * Body param: Comma-separated list of fields.
     */
    fields?: string;
    /**
     * Body param: Filters to drill down into specific events.
     */
    filter?: string;
    /**
     * Body param: The sample parameter is the sample rate of the records set by the
     * client: "sample": 1 is 100% of records "sample": 10 is 10% and so on.
     */
    sample?: number;
}
export interface EdgeGetParams {
    /**
     * Identifier.
     */
    zone_id: string;
}
export declare namespace Edge {
    export { type InstantLogpushJob as InstantLogpushJob, type InstantLogpushJobsSinglePage as InstantLogpushJobsSinglePage, type EdgeCreateParams as EdgeCreateParams, type EdgeGetParams as EdgeGetParams, };
}
//# sourceMappingURL=edge.d.ts.map