103 lines
3.8 KiB
TypeScript
103 lines
3.8 KiB
TypeScript
import { APIResource } from "../../resource.js";
|
|
import * as Core from "../../core.js";
|
|
export declare class TieredCaching extends APIResource {
|
|
/**
|
|
* Tiered Cache works by dividing Cloudflare's data centers into a hierarchy of
|
|
* lower-tiers and upper-tiers. If content is not cached in lower-tier data centers
|
|
* (generally the ones closest to a visitor), the lower-tier must ask an upper-tier
|
|
* to see if it has the content. If the upper-tier does not have the content, only
|
|
* the upper-tier can ask the origin for content. This practice improves bandwidth
|
|
* efficiency by limiting the number of data centers that can ask the origin for
|
|
* content, which reduces origin load and makes websites more cost-effective to
|
|
* operate. Additionally, Tiered Cache concentrates connections to origin servers
|
|
* so they come from a small number of data centers rather than the full set of
|
|
* network locations. This results in fewer open connections using server
|
|
* resources.
|
|
*
|
|
* @example
|
|
* ```ts
|
|
* const response = await client.argo.tieredCaching.edit({
|
|
* zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
|
|
* value: 'on',
|
|
* });
|
|
* ```
|
|
*/
|
|
edit(params: TieredCachingEditParams, options?: Core.RequestOptions): Core.APIPromise<TieredCachingEditResponse>;
|
|
/**
|
|
* Tiered Cache works by dividing Cloudflare's data centers into a hierarchy of
|
|
* lower-tiers and upper-tiers. If content is not cached in lower-tier data centers
|
|
* (generally the ones closest to a visitor), the lower-tier must ask an upper-tier
|
|
* to see if it has the content. If the upper-tier does not have the content, only
|
|
* the upper-tier can ask the origin for content. This practice improves bandwidth
|
|
* efficiency by limiting the number of data centers that can ask the origin for
|
|
* content, which reduces origin load and makes websites more cost-effective to
|
|
* operate. Additionally, Tiered Cache concentrates connections to origin servers
|
|
* so they come from a small number of data centers rather than the full set of
|
|
* network locations. This results in fewer open connections using server
|
|
* resources.
|
|
*
|
|
* @example
|
|
* ```ts
|
|
* const tieredCaching = await client.argo.tieredCaching.get({
|
|
* zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
|
|
* });
|
|
* ```
|
|
*/
|
|
get(params: TieredCachingGetParams, options?: Core.RequestOptions): Core.APIPromise<TieredCachingGetResponse>;
|
|
}
|
|
export interface TieredCachingEditResponse {
|
|
/**
|
|
* ID of the zone setting.
|
|
*/
|
|
id: 'tiered_caching';
|
|
/**
|
|
* Whether the setting is editable
|
|
*/
|
|
editable: boolean;
|
|
/**
|
|
* The value of the feature
|
|
*/
|
|
value: 'on' | 'off';
|
|
/**
|
|
* Last time this setting was modified.
|
|
*/
|
|
modified_on?: string | null;
|
|
}
|
|
export interface TieredCachingGetResponse {
|
|
/**
|
|
* ID of the zone setting.
|
|
*/
|
|
id: 'tiered_caching';
|
|
/**
|
|
* Whether the setting is editable
|
|
*/
|
|
editable: boolean;
|
|
/**
|
|
* The value of the feature
|
|
*/
|
|
value: 'on' | 'off';
|
|
/**
|
|
* Last time this setting was modified.
|
|
*/
|
|
modified_on?: string | null;
|
|
}
|
|
export interface TieredCachingEditParams {
|
|
/**
|
|
* Path param: Identifier
|
|
*/
|
|
zone_id: string;
|
|
/**
|
|
* Body param: Enables Tiered Caching.
|
|
*/
|
|
value: 'on' | 'off';
|
|
}
|
|
export interface TieredCachingGetParams {
|
|
/**
|
|
* Identifier
|
|
*/
|
|
zone_id: string;
|
|
}
|
|
export declare namespace TieredCaching {
|
|
export { type TieredCachingEditResponse as TieredCachingEditResponse, type TieredCachingGetResponse as TieredCachingGetResponse, type TieredCachingEditParams as TieredCachingEditParams, type TieredCachingGetParams as TieredCachingGetParams, };
|
|
}
|
|
//# sourceMappingURL=tiered-caching.d.ts.map
|