cloudflare/resources/logpush/edge.d.ts

The official TypeScript library for the Cloudflare API

import * as Core from 'cloudflare/core';
import { APIResource } from 'cloudflare/resource';
import * as EdgeAPI from 'cloudflare/resources/logpush/edge';
export declare class Edge extends APIResource {
    /**
     * Creates a new Instant Logs job for a zone.
     */
    create(params: EdgeCreateParams, options?: Core.RequestOptions): Core.APIPromise<InstantLogpushJob | null>;
    /**
     * Lists Instant Logs jobs for a zone.
     */
    get(params: EdgeGetParams, options?: Core.RequestOptions): Core.APIPromise<EdgeGetResponse>;
}
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 type EdgeGetResponse = Array<InstantLogpushJob | null>;
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 import InstantLogpushJob = EdgeAPI.InstantLogpushJob;
    export import EdgeGetResponse = EdgeAPI.EdgeGetResponse;
    export import EdgeCreateParams = EdgeAPI.EdgeCreateParams;
    export import EdgeGetParams = EdgeAPI.EdgeGetParams;
}
//# sourceMappingURL=edge.d.ts.map