kubernetes-models
Version:
49 lines (48 loc) • 2.39 kB
TypeScript
import { ModelData, Model } from "@kubernetes-models/base";
/**
* ObjectReference contains enough information to let you inspect or modify the referred object.
*/
export interface IObjectReference {
/**
* API version of the referent.
*/
"apiVersion"?: string;
/**
* If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.
*/
"fieldPath"?: string;
/**
* Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
*/
"kind"?: string;
/**
* Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
*/
"name"?: string;
/**
* Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
*/
"namespace"?: string;
/**
* Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
*/
"resourceVersion"?: string;
/**
* UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
*/
"uid"?: string;
}
/**
* ObjectReference contains enough information to let you inspect or modify the referred object.
*/
export declare class ObjectReference extends Model<IObjectReference> implements IObjectReference {
"apiVersion"?: IObjectReference["apiVersion"];
"fieldPath"?: string;
"kind"?: IObjectReference["kind"];
"name"?: string;
"namespace"?: string;
"resourceVersion"?: string;
"uid"?: string;
constructor(data?: ModelData<IObjectReference>);
}
export { IObjectReference as IIoK8sApiCoreV1ObjectReference, ObjectReference as IoK8sApiCoreV1ObjectReference };