kubernetes-models/resource.k8s.io/v1/CapacityRequestPolicyRange.d.ts

Kubernetes models

import { IIoK8sApimachineryPkgApiResourceQuantity } from "@kubernetes-models/apimachinery/api/resource/Quantity";
import { ModelData, Model } from "@kubernetes-models/base";
/**
 * CapacityRequestPolicyRange defines a valid range for consumable capacity values.
 *
 *   - If the requested amount is less than Min, it is rounded up to the Min value.
 *   - If Step is set and the requested amount is between Min and Max but not aligned with Step,
 *     it will be rounded up to the next value equal to Min + (n \* Step).
 *   - If Step is not set, the requested amount is used as-is if it falls within the range Min to Max (if set).
 *   - If the requested or rounded amount exceeds Max (if set), the request does not satisfy the policy,
 *     and the device cannot be allocated.
 */
export interface ICapacityRequestPolicyRange {
    /**
     * Max defines the upper limit for capacity that can be requested.
     *
     * Max must be less than or equal to the capacity value. Min and requestPolicy.default must be less than or equal to the maximum.
     */
    "max"?: IIoK8sApimachineryPkgApiResourceQuantity;
    /**
     * Min specifies the minimum capacity allowed for a consumption request.
     *
     * Min must be greater than or equal to zero, and less than or equal to the capacity value. requestPolicy.default must be more than or equal to the minimum.
     */
    "min": IIoK8sApimachineryPkgApiResourceQuantity;
    /**
     * Step defines the step size between valid capacity amounts within the range.
     *
     * Max (if set) and requestPolicy.default must be a multiple of Step. Min + Step must be less than or equal to the capacity value.
     */
    "step"?: IIoK8sApimachineryPkgApiResourceQuantity;
}
/**
 * CapacityRequestPolicyRange defines a valid range for consumable capacity values.
 *
 *   - If the requested amount is less than Min, it is rounded up to the Min value.
 *   - If Step is set and the requested amount is between Min and Max but not aligned with Step,
 *     it will be rounded up to the next value equal to Min + (n \* Step).
 *   - If Step is not set, the requested amount is used as-is if it falls within the range Min to Max (if set).
 *   - If the requested or rounded amount exceeds Max (if set), the request does not satisfy the policy,
 *     and the device cannot be allocated.
 */
export declare class CapacityRequestPolicyRange extends Model<ICapacityRequestPolicyRange> implements ICapacityRequestPolicyRange {
    "max"?: IIoK8sApimachineryPkgApiResourceQuantity;
    "min": IIoK8sApimachineryPkgApiResourceQuantity;
    "step"?: IIoK8sApimachineryPkgApiResourceQuantity;
    constructor(data?: ModelData<ICapacityRequestPolicyRange>);
}
export type { ICapacityRequestPolicyRange as IIoK8sApiResourceV1CapacityRequestPolicyRange, CapacityRequestPolicyRange as IoK8sApiResourceV1CapacityRequestPolicyRange };