kubernetes-models
Version:
57 lines (56 loc) • 4.08 kB
TypeScript
import { IIoK8sApiextensionsApiserverPkgApisApiextensionsV1beta1CustomResourceColumnDefinition } from "./CustomResourceColumnDefinition";
import { IIoK8sApiextensionsApiserverPkgApisApiextensionsV1beta1CustomResourceValidation } from "./CustomResourceValidation";
import { IIoK8sApiextensionsApiserverPkgApisApiextensionsV1beta1CustomResourceSubresources } from "./CustomResourceSubresources";
import { ModelData, Model } from "@kubernetes-models/base";
/**
* CustomResourceDefinitionVersion describes a version for CRD.
*/
export interface ICustomResourceDefinitionVersion {
/**
* additionalPrinterColumns specifies additional columns returned in Table output. See https://kubernetes.io/docs/reference/using-api/api-concepts/#receiving-resources-as-tables for details. Top-level and per-version columns are mutually exclusive. Per-version columns must not all be set to identical values (top-level columns should be used instead). If no top-level or per-version columns are specified, a single column displaying the age of the custom resource is used.
*/
"additionalPrinterColumns"?: Array<IIoK8sApiextensionsApiserverPkgApisApiextensionsV1beta1CustomResourceColumnDefinition>;
/**
* deprecated indicates this version of the custom resource API is deprecated. When set to true, API requests to this version receive a warning header in the server response. Defaults to false.
*/
"deprecated"?: boolean;
/**
* deprecationWarning overrides the default warning returned to API clients. May only be set when `deprecated` is true. The default warning indicates this version is deprecated and recommends use of the newest served version of equal or greater stability, if one exists.
*/
"deprecationWarning"?: string;
/**
* name is the version name, e.g. “v1”, “v2beta1”, etc. The custom resources are served under this version at `/apis/<group>/<version>/...` if `served` is true.
*/
"name": string;
/**
* schema describes the schema used for validation and pruning of this version of the custom resource. Top-level and per-version schemas are mutually exclusive. Per-version schemas must not all be set to identical values (top-level validation schema should be used instead).
*/
"schema"?: IIoK8sApiextensionsApiserverPkgApisApiextensionsV1beta1CustomResourceValidation;
/**
* served is a flag enabling/disabling this version from being served via REST APIs
*/
"served": boolean;
/**
* storage indicates this version should be used when persisting custom resources to storage. There must be exactly one version with storage=true.
*/
"storage": boolean;
/**
* subresources specify what subresources this version of the defined custom resource have. Top-level and per-version subresources are mutually exclusive. Per-version subresources must not all be set to identical values (top-level subresources should be used instead).
*/
"subresources"?: IIoK8sApiextensionsApiserverPkgApisApiextensionsV1beta1CustomResourceSubresources;
}
/**
* CustomResourceDefinitionVersion describes a version for CRD.
*/
export declare class CustomResourceDefinitionVersion extends Model<ICustomResourceDefinitionVersion> implements ICustomResourceDefinitionVersion {
"additionalPrinterColumns"?: Array<IIoK8sApiextensionsApiserverPkgApisApiextensionsV1beta1CustomResourceColumnDefinition>;
"deprecated"?: boolean;
"deprecationWarning"?: string;
"name": string;
"schema"?: IIoK8sApiextensionsApiserverPkgApisApiextensionsV1beta1CustomResourceValidation;
"served": boolean;
"storage": boolean;
"subresources"?: IIoK8sApiextensionsApiserverPkgApisApiextensionsV1beta1CustomResourceSubresources;
constructor(data?: ModelData<ICustomResourceDefinitionVersion>);
}
export { ICustomResourceDefinitionVersion as IIoK8sApiextensionsApiserverPkgApisApiextensionsV1beta1CustomResourceDefinitionVersion, CustomResourceDefinitionVersion as IoK8sApiextensionsApiserverPkgApisApiextensionsV1beta1CustomResourceDefinitionVersion };