cloudflare
Version:
The official TypeScript library for the Cloudflare API
33 lines • 2.25 kB
TypeScript
import { APIResource } from "../../../resource.js";
import * as Core from "../../../core.js";
export declare class Fields extends APIResource {
/**
* Lists all fields available for a dataset. The response result is. an object with
* key-value pairs, where keys are field names, and values are descriptions.
*
* @example
* ```ts
* const field = await client.logpush.datasets.fields.get(
* 'gateway_dns',
* { account_id: 'account_id' },
* );
* ```
*/
get(datasetId: 'access_requests' | 'audit_logs' | 'audit_logs_v2' | 'biso_user_actions' | 'casb_findings' | 'device_posture_results' | 'dlp_forensic_copies' | 'dns_firewall_logs' | 'dns_logs' | 'email_security_alerts' | 'firewall_events' | 'gateway_dns' | 'gateway_http' | 'gateway_network' | 'http_requests' | 'magic_ids_detections' | 'nel_reports' | 'network_analytics_logs' | 'page_shield_events' | 'sinkhole_http_logs' | 'spectrum_events' | 'ssh_logs' | 'workers_trace_events' | 'zaraz_events' | 'zero_trust_network_sessions' | null, params?: FieldGetParams, options?: Core.RequestOptions): Core.APIPromise<FieldGetResponse>;
get(datasetId: 'access_requests' | 'audit_logs' | 'audit_logs_v2' | 'biso_user_actions' | 'casb_findings' | 'device_posture_results' | 'dlp_forensic_copies' | 'dns_firewall_logs' | 'dns_logs' | 'email_security_alerts' | 'firewall_events' | 'gateway_dns' | 'gateway_http' | 'gateway_network' | 'http_requests' | 'magic_ids_detections' | 'nel_reports' | 'network_analytics_logs' | 'page_shield_events' | 'sinkhole_http_logs' | 'spectrum_events' | 'ssh_logs' | 'workers_trace_events' | 'zaraz_events' | 'zero_trust_network_sessions' | null, options?: Core.RequestOptions): Core.APIPromise<FieldGetResponse>;
}
export type FieldGetResponse = unknown;
export interface FieldGetParams {
/**
* The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
*/
account_id?: string;
/**
* The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
*/
zone_id?: string;
}
export declare namespace Fields {
export { type FieldGetResponse as FieldGetResponse, type FieldGetParams as FieldGetParams };
}
//# sourceMappingURL=fields.d.ts.map