cloudflare/resources/r2/buckets/metrics.d.mts

The official TypeScript library for the Cloudflare API

import { APIResource } from "../../../core/resource.mjs";
import { APIPromise } from "../../../core/api-promise.mjs";
import { RequestOptions } from "../../../internal/request-options.mjs";
export declare class BaseMetrics extends APIResource {
    static readonly _key: readonly ['r2', 'buckets', 'metrics'];
    /**
     * Get Storage/Object Count Metrics across all buckets in your account. Note that
     * Account-Level Metrics may not immediately reflect the latest data.
     *
     * @example
     * ```ts
     * const metrics = await client.r2.buckets.metrics.list({
     *   account_id: '023e105f4ecef8ad9ca31a8372d0c353',
     * });
     * ```
     */
    list(params: MetricListParams, options?: RequestOptions): APIPromise<MetricListResponse>;
}
export declare class Metrics extends BaseMetrics {
}
/**
 * Metrics based on the class they belong to.
 */
export interface MetricListResponse {
    /**
     * Metrics based on what state they are in(uploaded or published).
     */
    infrequentAccess?: MetricListResponse.InfrequentAccess;
    /**
     * Metrics based on what state they are in(uploaded or published).
     */
    standard?: MetricListResponse.Standard;
}
export declare namespace MetricListResponse {
    /**
     * Metrics based on what state they are in(uploaded or published).
     */
    interface InfrequentAccess {
        /**
         * Metrics on number of objects/amount of storage used.
         */
        published?: InfrequentAccess.Published;
        /**
         * Metrics on number of objects/amount of storage used.
         */
        uploaded?: InfrequentAccess.Uploaded;
    }
    namespace InfrequentAccess {
        /**
         * Metrics on number of objects/amount of storage used.
         */
        interface Published {
            /**
             * Amount of.
             */
            metadataSize?: number;
            /**
             * Number of objects stored.
             */
            objects?: number;
            /**
             * Amount of storage used by object data.
             */
            payloadSize?: number;
        }
        /**
         * Metrics on number of objects/amount of storage used.
         */
        interface Uploaded {
            /**
             * Amount of.
             */
            metadataSize?: number;
            /**
             * Number of objects stored.
             */
            objects?: number;
            /**
             * Amount of storage used by object data.
             */
            payloadSize?: number;
        }
    }
    /**
     * Metrics based on what state they are in(uploaded or published).
     */
    interface Standard {
        /**
         * Metrics on number of objects/amount of storage used.
         */
        published?: Standard.Published;
        /**
         * Metrics on number of objects/amount of storage used.
         */
        uploaded?: Standard.Uploaded;
    }
    namespace Standard {
        /**
         * Metrics on number of objects/amount of storage used.
         */
        interface Published {
            /**
             * Amount of.
             */
            metadataSize?: number;
            /**
             * Number of objects stored.
             */
            objects?: number;
            /**
             * Amount of storage used by object data.
             */
            payloadSize?: number;
        }
        /**
         * Metrics on number of objects/amount of storage used.
         */
        interface Uploaded {
            /**
             * Amount of.
             */
            metadataSize?: number;
            /**
             * Number of objects stored.
             */
            objects?: number;
            /**
             * Amount of storage used by object data.
             */
            payloadSize?: number;
        }
    }
}
export interface MetricListParams {
    /**
     * Cloudflare account ID that owns the R2 resource.
     */
    account_id: string;
}
export declare namespace Metrics {
    export { type MetricListResponse as MetricListResponse, type MetricListParams as MetricListParams };
}
//# sourceMappingURL=metrics.d.mts.map