generated.proto 48 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117
  1. /*
  2. Copyright The Kubernetes Authors.
  3. Licensed under the Apache License, Version 2.0 (the "License");
  4. you may not use this file except in compliance with the License.
  5. You may obtain a copy of the License at
  6. http://www.apache.org/licenses/LICENSE-2.0
  7. Unless required by applicable law or agreed to in writing, software
  8. distributed under the License is distributed on an "AS IS" BASIS,
  9. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  10. See the License for the specific language governing permissions and
  11. limitations under the License.
  12. */
  13. // This file was autogenerated by go-to-protobuf. Do not edit it manually!
  14. syntax = "proto2";
  15. package k8s.io.apimachinery.pkg.apis.meta.v1;
  16. import "k8s.io/apimachinery/pkg/runtime/generated.proto";
  17. import "k8s.io/apimachinery/pkg/runtime/schema/generated.proto";
  18. // Package-wide variables from generator "generated".
  19. option go_package = "v1";
  20. // APIGroup contains the name, the supported versions, and the preferred version
  21. // of a group.
  22. message APIGroup {
  23. // name is the name of the group.
  24. optional string name = 1;
  25. // versions are the versions supported in this group.
  26. repeated GroupVersionForDiscovery versions = 2;
  27. // preferredVersion is the version preferred by the API server, which
  28. // probably is the storage version.
  29. // +optional
  30. optional GroupVersionForDiscovery preferredVersion = 3;
  31. // a map of client CIDR to server address that is serving this group.
  32. // This is to help clients reach servers in the most network-efficient way possible.
  33. // Clients can use the appropriate server address as per the CIDR that they match.
  34. // In case of multiple matches, clients should use the longest matching CIDR.
  35. // The server returns only those CIDRs that it thinks that the client can match.
  36. // For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP.
  37. // Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP.
  38. // +optional
  39. repeated ServerAddressByClientCIDR serverAddressByClientCIDRs = 4;
  40. }
  41. // APIGroupList is a list of APIGroup, to allow clients to discover the API at
  42. // /apis.
  43. message APIGroupList {
  44. // groups is a list of APIGroup.
  45. repeated APIGroup groups = 1;
  46. }
  47. // APIResource specifies the name of a resource and whether it is namespaced.
  48. message APIResource {
  49. // name is the plural name of the resource.
  50. optional string name = 1;
  51. // singularName is the singular name of the resource. This allows clients to handle plural and singular opaquely.
  52. // The singularName is more correct for reporting status on a single item and both singular and plural are allowed
  53. // from the kubectl CLI interface.
  54. optional string singularName = 6;
  55. // namespaced indicates if a resource is namespaced or not.
  56. optional bool namespaced = 2;
  57. // group is the preferred group of the resource. Empty implies the group of the containing resource list.
  58. // For subresources, this may have a different value, for example: Scale".
  59. optional string group = 8;
  60. // version is the preferred version of the resource. Empty implies the version of the containing resource list
  61. // For subresources, this may have a different value, for example: v1 (while inside a v1beta1 version of the core resource's group)".
  62. optional string version = 9;
  63. // kind is the kind for the resource (e.g. 'Foo' is the kind for a resource 'foo')
  64. optional string kind = 3;
  65. // verbs is a list of supported kube verbs (this includes get, list, watch, create,
  66. // update, patch, delete, deletecollection, and proxy)
  67. optional Verbs verbs = 4;
  68. // shortNames is a list of suggested short names of the resource.
  69. repeated string shortNames = 5;
  70. // categories is a list of the grouped resources this resource belongs to (e.g. 'all')
  71. repeated string categories = 7;
  72. // The hash value of the storage version, the version this resource is
  73. // converted to when written to the data store. Value must be treated
  74. // as opaque by clients. Only equality comparison on the value is valid.
  75. // This is an alpha feature and may change or be removed in the future.
  76. // The field is populated by the apiserver only if the
  77. // StorageVersionHash feature gate is enabled.
  78. // This field will remain optional even if it graduates.
  79. // +optional
  80. optional string storageVersionHash = 10;
  81. }
  82. // APIResourceList is a list of APIResource, it is used to expose the name of the
  83. // resources supported in a specific group and version, and if the resource
  84. // is namespaced.
  85. message APIResourceList {
  86. // groupVersion is the group and version this APIResourceList is for.
  87. optional string groupVersion = 1;
  88. // resources contains the name of the resources and if they are namespaced.
  89. repeated APIResource resources = 2;
  90. }
  91. // APIVersions lists the versions that are available, to allow clients to
  92. // discover the API at /api, which is the root path of the legacy v1 API.
  93. //
  94. // +protobuf.options.(gogoproto.goproto_stringer)=false
  95. // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
  96. message APIVersions {
  97. // versions are the api versions that are available.
  98. repeated string versions = 1;
  99. // a map of client CIDR to server address that is serving this group.
  100. // This is to help clients reach servers in the most network-efficient way possible.
  101. // Clients can use the appropriate server address as per the CIDR that they match.
  102. // In case of multiple matches, clients should use the longest matching CIDR.
  103. // The server returns only those CIDRs that it thinks that the client can match.
  104. // For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP.
  105. // Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP.
  106. repeated ServerAddressByClientCIDR serverAddressByClientCIDRs = 2;
  107. }
  108. // ApplyOptions may be provided when applying an API object.
  109. // FieldManager is required for apply requests.
  110. // ApplyOptions is equivalent to PatchOptions. It is provided as a convenience with documentation
  111. // that speaks specifically to how the options fields relate to apply.
  112. message ApplyOptions {
  113. // When present, indicates that modifications should not be
  114. // persisted. An invalid or unrecognized dryRun directive will
  115. // result in an error response and no further processing of the
  116. // request. Valid values are:
  117. // - All: all dry run stages will be processed
  118. // +optional
  119. repeated string dryRun = 1;
  120. // Force is going to "force" Apply requests. It means user will
  121. // re-acquire conflicting fields owned by other people.
  122. optional bool force = 2;
  123. // fieldManager is a name associated with the actor or entity
  124. // that is making these changes. The value must be less than or
  125. // 128 characters long, and only contain printable characters,
  126. // as defined by https://golang.org/pkg/unicode/#IsPrint. This
  127. // field is required.
  128. optional string fieldManager = 3;
  129. }
  130. // Condition contains details for one aspect of the current state of this API Resource.
  131. // ---
  132. // This struct is intended for direct use as an array at the field path .status.conditions. For example,
  133. // type FooStatus struct{
  134. // // Represents the observations of a foo's current state.
  135. // // Known .status.conditions.type are: "Available", "Progressing", and "Degraded"
  136. // // +patchMergeKey=type
  137. // // +patchStrategy=merge
  138. // // +listType=map
  139. // // +listMapKey=type
  140. // Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"`
  141. //
  142. // // other fields
  143. // }
  144. message Condition {
  145. // type of condition in CamelCase or in foo.example.com/CamelCase.
  146. // ---
  147. // Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be
  148. // useful (see .node.status.conditions), the ability to deconflict is important.
  149. // The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)
  150. // +required
  151. // +kubebuilder:validation:Required
  152. // +kubebuilder:validation:Pattern=`^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$`
  153. // +kubebuilder:validation:MaxLength=316
  154. optional string type = 1;
  155. // status of the condition, one of True, False, Unknown.
  156. // +required
  157. // +kubebuilder:validation:Required
  158. // +kubebuilder:validation:Enum=True;False;Unknown
  159. optional string status = 2;
  160. // observedGeneration represents the .metadata.generation that the condition was set based upon.
  161. // For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
  162. // with respect to the current state of the instance.
  163. // +optional
  164. // +kubebuilder:validation:Minimum=0
  165. optional int64 observedGeneration = 3;
  166. // lastTransitionTime is the last time the condition transitioned from one status to another.
  167. // This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
  168. // +required
  169. // +kubebuilder:validation:Required
  170. // +kubebuilder:validation:Type=string
  171. // +kubebuilder:validation:Format=date-time
  172. optional Time lastTransitionTime = 4;
  173. // reason contains a programmatic identifier indicating the reason for the condition's last transition.
  174. // Producers of specific condition types may define expected values and meanings for this field,
  175. // and whether the values are considered a guaranteed API.
  176. // The value should be a CamelCase string.
  177. // This field may not be empty.
  178. // +required
  179. // +kubebuilder:validation:Required
  180. // +kubebuilder:validation:MaxLength=1024
  181. // +kubebuilder:validation:MinLength=1
  182. // +kubebuilder:validation:Pattern=`^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$`
  183. optional string reason = 5;
  184. // message is a human readable message indicating details about the transition.
  185. // This may be an empty string.
  186. // +required
  187. // +kubebuilder:validation:Required
  188. // +kubebuilder:validation:MaxLength=32768
  189. optional string message = 6;
  190. }
  191. // CreateOptions may be provided when creating an API object.
  192. message CreateOptions {
  193. // When present, indicates that modifications should not be
  194. // persisted. An invalid or unrecognized dryRun directive will
  195. // result in an error response and no further processing of the
  196. // request. Valid values are:
  197. // - All: all dry run stages will be processed
  198. // +optional
  199. repeated string dryRun = 1;
  200. // fieldManager is a name associated with the actor or entity
  201. // that is making these changes. The value must be less than or
  202. // 128 characters long, and only contain printable characters,
  203. // as defined by https://golang.org/pkg/unicode/#IsPrint.
  204. // +optional
  205. optional string fieldManager = 3;
  206. }
  207. // DeleteOptions may be provided when deleting an API object.
  208. message DeleteOptions {
  209. // The duration in seconds before the object should be deleted. Value must be non-negative integer.
  210. // The value zero indicates delete immediately. If this value is nil, the default grace period for the
  211. // specified type will be used.
  212. // Defaults to a per object value if not specified. zero means delete immediately.
  213. // +optional
  214. optional int64 gracePeriodSeconds = 1;
  215. // Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be
  216. // returned.
  217. // +k8s:conversion-gen=false
  218. // +optional
  219. optional Preconditions preconditions = 2;
  220. // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7.
  221. // Should the dependent objects be orphaned. If true/false, the "orphan"
  222. // finalizer will be added to/removed from the object's finalizers list.
  223. // Either this field or PropagationPolicy may be set, but not both.
  224. // +optional
  225. optional bool orphanDependents = 3;
  226. // Whether and how garbage collection will be performed.
  227. // Either this field or OrphanDependents may be set, but not both.
  228. // The default policy is decided by the existing finalizer set in the
  229. // metadata.finalizers and the resource-specific default policy.
  230. // Acceptable values are: 'Orphan' - orphan the dependents; 'Background' -
  231. // allow the garbage collector to delete the dependents in the background;
  232. // 'Foreground' - a cascading policy that deletes all dependents in the
  233. // foreground.
  234. // +optional
  235. optional string propagationPolicy = 4;
  236. // When present, indicates that modifications should not be
  237. // persisted. An invalid or unrecognized dryRun directive will
  238. // result in an error response and no further processing of the
  239. // request. Valid values are:
  240. // - All: all dry run stages will be processed
  241. // +optional
  242. repeated string dryRun = 5;
  243. }
  244. // Duration is a wrapper around time.Duration which supports correct
  245. // marshaling to YAML and JSON. In particular, it marshals into strings, which
  246. // can be used as map keys in json.
  247. message Duration {
  248. optional int64 duration = 1;
  249. }
  250. // FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format.
  251. //
  252. // Each key is either a '.' representing the field itself, and will always map to an empty set,
  253. // or a string representing a sub-field or item. The string will follow one of these four formats:
  254. // 'f:<name>', where <name> is the name of a field in a struct, or key in a map
  255. // 'v:<value>', where <value> is the exact json formatted value of a list item
  256. // 'i:<index>', where <index> is position of a item in a list
  257. // 'k:<keys>', where <keys> is a map of a list item's key fields to their unique values
  258. // If a key maps to an empty Fields value, the field that key represents is part of the set.
  259. //
  260. // The exact format is defined in sigs.k8s.io/structured-merge-diff
  261. // +protobuf.options.(gogoproto.goproto_stringer)=false
  262. message FieldsV1 {
  263. // Raw is the underlying serialization of this object.
  264. optional bytes Raw = 1;
  265. }
  266. // GetOptions is the standard query options to the standard REST get call.
  267. message GetOptions {
  268. // resourceVersion sets a constraint on what resource versions a request may be served from.
  269. // See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for
  270. // details.
  271. //
  272. // Defaults to unset
  273. // +optional
  274. optional string resourceVersion = 1;
  275. }
  276. // GroupKind specifies a Group and a Kind, but does not force a version. This is useful for identifying
  277. // concepts during lookup stages without having partially valid types
  278. //
  279. // +protobuf.options.(gogoproto.goproto_stringer)=false
  280. message GroupKind {
  281. optional string group = 1;
  282. optional string kind = 2;
  283. }
  284. // GroupResource specifies a Group and a Resource, but does not force a version. This is useful for identifying
  285. // concepts during lookup stages without having partially valid types
  286. //
  287. // +protobuf.options.(gogoproto.goproto_stringer)=false
  288. message GroupResource {
  289. optional string group = 1;
  290. optional string resource = 2;
  291. }
  292. // GroupVersion contains the "group" and the "version", which uniquely identifies the API.
  293. //
  294. // +protobuf.options.(gogoproto.goproto_stringer)=false
  295. message GroupVersion {
  296. optional string group = 1;
  297. optional string version = 2;
  298. }
  299. // GroupVersion contains the "group/version" and "version" string of a version.
  300. // It is made a struct to keep extensibility.
  301. message GroupVersionForDiscovery {
  302. // groupVersion specifies the API group and version in the form "group/version"
  303. optional string groupVersion = 1;
  304. // version specifies the version in the form of "version". This is to save
  305. // the clients the trouble of splitting the GroupVersion.
  306. optional string version = 2;
  307. }
  308. // GroupVersionKind unambiguously identifies a kind. It doesn't anonymously include GroupVersion
  309. // to avoid automatic coersion. It doesn't use a GroupVersion to avoid custom marshalling
  310. //
  311. // +protobuf.options.(gogoproto.goproto_stringer)=false
  312. message GroupVersionKind {
  313. optional string group = 1;
  314. optional string version = 2;
  315. optional string kind = 3;
  316. }
  317. // GroupVersionResource unambiguously identifies a resource. It doesn't anonymously include GroupVersion
  318. // to avoid automatic coersion. It doesn't use a GroupVersion to avoid custom marshalling
  319. //
  320. // +protobuf.options.(gogoproto.goproto_stringer)=false
  321. message GroupVersionResource {
  322. optional string group = 1;
  323. optional string version = 2;
  324. optional string resource = 3;
  325. }
  326. // A label selector is a label query over a set of resources. The result of matchLabels and
  327. // matchExpressions are ANDed. An empty label selector matches all objects. A null
  328. // label selector matches no objects.
  329. // +structType=atomic
  330. message LabelSelector {
  331. // matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
  332. // map is equivalent to an element of matchExpressions, whose key field is "key", the
  333. // operator is "In", and the values array contains only "value". The requirements are ANDed.
  334. // +optional
  335. map<string, string> matchLabels = 1;
  336. // matchExpressions is a list of label selector requirements. The requirements are ANDed.
  337. // +optional
  338. repeated LabelSelectorRequirement matchExpressions = 2;
  339. }
  340. // A label selector requirement is a selector that contains values, a key, and an operator that
  341. // relates the key and values.
  342. message LabelSelectorRequirement {
  343. // key is the label key that the selector applies to.
  344. // +patchMergeKey=key
  345. // +patchStrategy=merge
  346. optional string key = 1;
  347. // operator represents a key's relationship to a set of values.
  348. // Valid operators are In, NotIn, Exists and DoesNotExist.
  349. optional string operator = 2;
  350. // values is an array of string values. If the operator is In or NotIn,
  351. // the values array must be non-empty. If the operator is Exists or DoesNotExist,
  352. // the values array must be empty. This array is replaced during a strategic
  353. // merge patch.
  354. // +optional
  355. repeated string values = 3;
  356. }
  357. // List holds a list of objects, which may not be known by the server.
  358. message List {
  359. // Standard list metadata.
  360. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
  361. // +optional
  362. optional ListMeta metadata = 1;
  363. // List of objects
  364. repeated k8s.io.apimachinery.pkg.runtime.RawExtension items = 2;
  365. }
  366. // ListMeta describes metadata that synthetic resources must have, including lists and
  367. // various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
  368. message ListMeta {
  369. // selfLink is a URL representing this object.
  370. // Populated by the system.
  371. // Read-only.
  372. //
  373. // DEPRECATED
  374. // Kubernetes will stop propagating this field in 1.20 release and the field is planned
  375. // to be removed in 1.21 release.
  376. // +optional
  377. optional string selfLink = 1;
  378. // String that identifies the server's internal version of this object that
  379. // can be used by clients to determine when objects have changed.
  380. // Value must be treated as opaque by clients and passed unmodified back to the server.
  381. // Populated by the system.
  382. // Read-only.
  383. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
  384. // +optional
  385. optional string resourceVersion = 2;
  386. // continue may be set if the user set a limit on the number of items returned, and indicates that
  387. // the server has more data available. The value is opaque and may be used to issue another request
  388. // to the endpoint that served this list to retrieve the next set of available objects. Continuing a
  389. // consistent list may not be possible if the server configuration has changed or more than a few
  390. // minutes have passed. The resourceVersion field returned when using this continue value will be
  391. // identical to the value in the first response, unless you have received this token from an error
  392. // message.
  393. optional string continue = 3;
  394. // remainingItemCount is the number of subsequent items in the list which are not included in this
  395. // list response. If the list request contained label or field selectors, then the number of
  396. // remaining items is unknown and the field will be left unset and omitted during serialization.
  397. // If the list is complete (either because it is not chunking or because this is the last chunk),
  398. // then there are no more remaining items and this field will be left unset and omitted during
  399. // serialization.
  400. // Servers older than v1.15 do not set this field.
  401. // The intended use of the remainingItemCount is *estimating* the size of a collection. Clients
  402. // should not rely on the remainingItemCount to be set or to be exact.
  403. // +optional
  404. optional int64 remainingItemCount = 4;
  405. }
  406. // ListOptions is the query options to a standard REST list call.
  407. message ListOptions {
  408. // A selector to restrict the list of returned objects by their labels.
  409. // Defaults to everything.
  410. // +optional
  411. optional string labelSelector = 1;
  412. // A selector to restrict the list of returned objects by their fields.
  413. // Defaults to everything.
  414. // +optional
  415. optional string fieldSelector = 2;
  416. // Watch for changes to the described resources and return them as a stream of
  417. // add, update, and remove notifications. Specify resourceVersion.
  418. // +optional
  419. optional bool watch = 3;
  420. // allowWatchBookmarks requests watch events with type "BOOKMARK".
  421. // Servers that do not implement bookmarks may ignore this flag and
  422. // bookmarks are sent at the server's discretion. Clients should not
  423. // assume bookmarks are returned at any specific interval, nor may they
  424. // assume the server will send any BOOKMARK event during a session.
  425. // If this is not a watch, this field is ignored.
  426. // If the feature gate WatchBookmarks is not enabled in apiserver,
  427. // this field is ignored.
  428. // +optional
  429. optional bool allowWatchBookmarks = 9;
  430. // resourceVersion sets a constraint on what resource versions a request may be served from.
  431. // See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for
  432. // details.
  433. //
  434. // Defaults to unset
  435. // +optional
  436. optional string resourceVersion = 4;
  437. // resourceVersionMatch determines how resourceVersion is applied to list calls.
  438. // It is highly recommended that resourceVersionMatch be set for list calls where
  439. // resourceVersion is set
  440. // See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for
  441. // details.
  442. //
  443. // Defaults to unset
  444. // +optional
  445. optional string resourceVersionMatch = 10;
  446. // Timeout for the list/watch call.
  447. // This limits the duration of the call, regardless of any activity or inactivity.
  448. // +optional
  449. optional int64 timeoutSeconds = 5;
  450. // limit is a maximum number of responses to return for a list call. If more items exist, the
  451. // server will set the `continue` field on the list metadata to a value that can be used with the
  452. // same initial query to retrieve the next set of results. Setting a limit may return fewer than
  453. // the requested amount of items (up to zero items) in the event all requested objects are
  454. // filtered out and clients should only use the presence of the continue field to determine whether
  455. // more results are available. Servers may choose not to support the limit argument and will return
  456. // all of the available results. If limit is specified and the continue field is empty, clients may
  457. // assume that no more results are available. This field is not supported if watch is true.
  458. //
  459. // The server guarantees that the objects returned when using continue will be identical to issuing
  460. // a single list call without a limit - that is, no objects created, modified, or deleted after the
  461. // first request is issued will be included in any subsequent continued requests. This is sometimes
  462. // referred to as a consistent snapshot, and ensures that a client that is using limit to receive
  463. // smaller chunks of a very large result can ensure they see all possible objects. If objects are
  464. // updated during a chunked list the version of the object that was present at the time the first list
  465. // result was calculated is returned.
  466. optional int64 limit = 7;
  467. // The continue option should be set when retrieving more results from the server. Since this value is
  468. // server defined, clients may only use the continue value from a previous query result with identical
  469. // query parameters (except for the value of continue) and the server may reject a continue value it
  470. // does not recognize. If the specified continue value is no longer valid whether due to expiration
  471. // (generally five to fifteen minutes) or a configuration change on the server, the server will
  472. // respond with a 410 ResourceExpired error together with a continue token. If the client needs a
  473. // consistent list, it must restart their list without the continue field. Otherwise, the client may
  474. // send another list request with the token received with the 410 error, the server will respond with
  475. // a list starting from the next key, but from the latest snapshot, which is inconsistent from the
  476. // previous list results - objects that are created, modified, or deleted after the first list request
  477. // will be included in the response, as long as their keys are after the "next key".
  478. //
  479. // This field is not supported when watch is true. Clients may start a watch from the last
  480. // resourceVersion value returned by the server and not miss any modifications.
  481. optional string continue = 8;
  482. }
  483. // ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource
  484. // that the fieldset applies to.
  485. message ManagedFieldsEntry {
  486. // Manager is an identifier of the workflow managing these fields.
  487. optional string manager = 1;
  488. // Operation is the type of operation which lead to this ManagedFieldsEntry being created.
  489. // The only valid values for this field are 'Apply' and 'Update'.
  490. optional string operation = 2;
  491. // APIVersion defines the version of this resource that this field set
  492. // applies to. The format is "group/version" just like the top-level
  493. // APIVersion field. It is necessary to track the version of a field
  494. // set because it cannot be automatically converted.
  495. optional string apiVersion = 3;
  496. // Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply'
  497. // +optional
  498. optional Time time = 4;
  499. // FieldsType is the discriminator for the different fields format and version.
  500. // There is currently only one possible value: "FieldsV1"
  501. optional string fieldsType = 6;
  502. // FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.
  503. // +optional
  504. optional FieldsV1 fieldsV1 = 7;
  505. }
  506. // MicroTime is version of Time with microsecond level precision.
  507. //
  508. // +protobuf.options.marshal=false
  509. // +protobuf.as=Timestamp
  510. // +protobuf.options.(gogoproto.goproto_stringer)=false
  511. message MicroTime {
  512. // Represents seconds of UTC time since Unix epoch
  513. // 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
  514. // 9999-12-31T23:59:59Z inclusive.
  515. optional int64 seconds = 1;
  516. // Non-negative fractions of a second at nanosecond resolution. Negative
  517. // second values with fractions must still have non-negative nanos values
  518. // that count forward in time. Must be from 0 to 999,999,999
  519. // inclusive. This field may be limited in precision depending on context.
  520. optional int32 nanos = 2;
  521. }
  522. // ObjectMeta is metadata that all persisted resources must have, which includes all objects
  523. // users must create.
  524. message ObjectMeta {
  525. // Name must be unique within a namespace. Is required when creating resources, although
  526. // some resources may allow a client to request the generation of an appropriate name
  527. // automatically. Name is primarily intended for creation idempotence and configuration
  528. // definition.
  529. // Cannot be updated.
  530. // More info: http://kubernetes.io/docs/user-guide/identifiers#names
  531. // +optional
  532. optional string name = 1;
  533. // GenerateName is an optional prefix, used by the server, to generate a unique
  534. // name ONLY IF the Name field has not been provided.
  535. // If this field is used, the name returned to the client will be different
  536. // than the name passed. This value will also be combined with a unique suffix.
  537. // The provided value has the same validation rules as the Name field,
  538. // and may be truncated by the length of the suffix required to make the value
  539. // unique on the server.
  540. //
  541. // If this field is specified and the generated name exists, the server will
  542. // NOT return a 409 - instead, it will either return 201 Created or 500 with Reason
  543. // ServerTimeout indicating a unique name could not be found in the time allotted, and the client
  544. // should retry (optionally after the time indicated in the Retry-After header).
  545. //
  546. // Applied only if Name is not specified.
  547. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
  548. // +optional
  549. optional string generateName = 2;
  550. // Namespace defines the space within which each name must be unique. An empty namespace is
  551. // equivalent to the "default" namespace, but "default" is the canonical representation.
  552. // Not all objects are required to be scoped to a namespace - the value of this field for
  553. // those objects will be empty.
  554. //
  555. // Must be a DNS_LABEL.
  556. // Cannot be updated.
  557. // More info: http://kubernetes.io/docs/user-guide/namespaces
  558. // +optional
  559. optional string namespace = 3;
  560. // SelfLink is a URL representing this object.
  561. // Populated by the system.
  562. // Read-only.
  563. //
  564. // DEPRECATED
  565. // Kubernetes will stop propagating this field in 1.20 release and the field is planned
  566. // to be removed in 1.21 release.
  567. // +optional
  568. optional string selfLink = 4;
  569. // UID is the unique in time and space value for this object. It is typically generated by
  570. // the server on successful creation of a resource and is not allowed to change on PUT
  571. // operations.
  572. //
  573. // Populated by the system.
  574. // Read-only.
  575. // More info: http://kubernetes.io/docs/user-guide/identifiers#uids
  576. // +optional
  577. optional string uid = 5;
  578. // An opaque value that represents the internal version of this object that can
  579. // be used by clients to determine when objects have changed. May be used for optimistic
  580. // concurrency, change detection, and the watch operation on a resource or set of resources.
  581. // Clients must treat these values as opaque and passed unmodified back to the server.
  582. // They may only be valid for a particular resource or set of resources.
  583. //
  584. // Populated by the system.
  585. // Read-only.
  586. // Value must be treated as opaque by clients and .
  587. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
  588. // +optional
  589. optional string resourceVersion = 6;
  590. // A sequence number representing a specific generation of the desired state.
  591. // Populated by the system. Read-only.
  592. // +optional
  593. optional int64 generation = 7;
  594. // CreationTimestamp is a timestamp representing the server time when this object was
  595. // created. It is not guaranteed to be set in happens-before order across separate operations.
  596. // Clients may not set this value. It is represented in RFC3339 form and is in UTC.
  597. //
  598. // Populated by the system.
  599. // Read-only.
  600. // Null for lists.
  601. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
  602. // +optional
  603. optional Time creationTimestamp = 8;
  604. // DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This
  605. // field is set by the server when a graceful deletion is requested by the user, and is not
  606. // directly settable by a client. The resource is expected to be deleted (no longer visible
  607. // from resource lists, and not reachable by name) after the time in this field, once the
  608. // finalizers list is empty. As long as the finalizers list contains items, deletion is blocked.
  609. // Once the deletionTimestamp is set, this value may not be unset or be set further into the
  610. // future, although it may be shortened or the resource may be deleted prior to this time.
  611. // For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react
  612. // by sending a graceful termination signal to the containers in the pod. After that 30 seconds,
  613. // the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,
  614. // remove the pod from the API. In the presence of network partitions, this object may still
  615. // exist after this timestamp, until an administrator or automated process can determine the
  616. // resource is fully terminated.
  617. // If not set, graceful deletion of the object has not been requested.
  618. //
  619. // Populated by the system when a graceful deletion is requested.
  620. // Read-only.
  621. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
  622. // +optional
  623. optional Time deletionTimestamp = 9;
  624. // Number of seconds allowed for this object to gracefully terminate before
  625. // it will be removed from the system. Only set when deletionTimestamp is also set.
  626. // May only be shortened.
  627. // Read-only.
  628. // +optional
  629. optional int64 deletionGracePeriodSeconds = 10;
  630. // Map of string keys and values that can be used to organize and categorize
  631. // (scope and select) objects. May match selectors of replication controllers
  632. // and services.
  633. // More info: http://kubernetes.io/docs/user-guide/labels
  634. // +optional
  635. map<string, string> labels = 11;
  636. // Annotations is an unstructured key value map stored with a resource that may be
  637. // set by external tools to store and retrieve arbitrary metadata. They are not
  638. // queryable and should be preserved when modifying objects.
  639. // More info: http://kubernetes.io/docs/user-guide/annotations
  640. // +optional
  641. map<string, string> annotations = 12;
  642. // List of objects depended by this object. If ALL objects in the list have
  643. // been deleted, this object will be garbage collected. If this object is managed by a controller,
  644. // then an entry in this list will point to this controller, with the controller field set to true.
  645. // There cannot be more than one managing controller.
  646. // +optional
  647. // +patchMergeKey=uid
  648. // +patchStrategy=merge
  649. repeated OwnerReference ownerReferences = 13;
  650. // Must be empty before the object is deleted from the registry. Each entry
  651. // is an identifier for the responsible component that will remove the entry
  652. // from the list. If the deletionTimestamp of the object is non-nil, entries
  653. // in this list can only be removed.
  654. // Finalizers may be processed and removed in any order. Order is NOT enforced
  655. // because it introduces significant risk of stuck finalizers.
  656. // finalizers is a shared field, any actor with permission can reorder it.
  657. // If the finalizer list is processed in order, then this can lead to a situation
  658. // in which the component responsible for the first finalizer in the list is
  659. // waiting for a signal (field value, external system, or other) produced by a
  660. // component responsible for a finalizer later in the list, resulting in a deadlock.
  661. // Without enforced ordering finalizers are free to order amongst themselves and
  662. // are not vulnerable to ordering changes in the list.
  663. // +optional
  664. // +patchStrategy=merge
  665. repeated string finalizers = 14;
  666. // The name of the cluster which the object belongs to.
  667. // This is used to distinguish resources with same name and namespace in different clusters.
  668. // This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.
  669. // +optional
  670. optional string clusterName = 15;
  671. // ManagedFields maps workflow-id and version to the set of fields
  672. // that are managed by that workflow. This is mostly for internal
  673. // housekeeping, and users typically shouldn't need to set or
  674. // understand this field. A workflow can be the user's name, a
  675. // controller's name, or the name of a specific apply path like
  676. // "ci-cd". The set of fields is always in the version that the
  677. // workflow used when modifying the object.
  678. //
  679. // +optional
  680. repeated ManagedFieldsEntry managedFields = 17;
  681. }
  682. // OwnerReference contains enough information to let you identify an owning
  683. // object. An owning object must be in the same namespace as the dependent, or
  684. // be cluster-scoped, so there is no namespace field.
  685. message OwnerReference {
  686. // API version of the referent.
  687. optional string apiVersion = 5;
  688. // Kind of the referent.
  689. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
  690. optional string kind = 1;
  691. // Name of the referent.
  692. // More info: http://kubernetes.io/docs/user-guide/identifiers#names
  693. optional string name = 3;
  694. // UID of the referent.
  695. // More info: http://kubernetes.io/docs/user-guide/identifiers#uids
  696. optional string uid = 4;
  697. // If true, this reference points to the managing controller.
  698. // +optional
  699. optional bool controller = 6;
  700. // If true, AND if the owner has the "foregroundDeletion" finalizer, then
  701. // the owner cannot be deleted from the key-value store until this
  702. // reference is removed.
  703. // Defaults to false.
  704. // To set this field, a user needs "delete" permission of the owner,
  705. // otherwise 422 (Unprocessable Entity) will be returned.
  706. // +optional
  707. optional bool blockOwnerDeletion = 7;
  708. }
  709. // PartialObjectMetadata is a generic representation of any object with ObjectMeta. It allows clients
  710. // to get access to a particular ObjectMeta schema without knowing the details of the version.
  711. // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
  712. message PartialObjectMetadata {
  713. // Standard object's metadata.
  714. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
  715. // +optional
  716. optional ObjectMeta metadata = 1;
  717. }
  718. // PartialObjectMetadataList contains a list of objects containing only their metadata
  719. // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
  720. message PartialObjectMetadataList {
  721. // Standard list metadata.
  722. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
  723. // +optional
  724. optional ListMeta metadata = 1;
  725. // items contains each of the included items.
  726. repeated PartialObjectMetadata items = 2;
  727. }
  728. // Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.
  729. message Patch {
  730. }
  731. // PatchOptions may be provided when patching an API object.
  732. // PatchOptions is meant to be a superset of UpdateOptions.
  733. message PatchOptions {
  734. // When present, indicates that modifications should not be
  735. // persisted. An invalid or unrecognized dryRun directive will
  736. // result in an error response and no further processing of the
  737. // request. Valid values are:
  738. // - All: all dry run stages will be processed
  739. // +optional
  740. repeated string dryRun = 1;
  741. // Force is going to "force" Apply requests. It means user will
  742. // re-acquire conflicting fields owned by other people. Force
  743. // flag must be unset for non-apply patch requests.
  744. // +optional
  745. optional bool force = 2;
  746. // fieldManager is a name associated with the actor or entity
  747. // that is making these changes. The value must be less than or
  748. // 128 characters long, and only contain printable characters,
  749. // as defined by https://golang.org/pkg/unicode/#IsPrint. This
  750. // field is required for apply requests
  751. // (application/apply-patch) but optional for non-apply patch
  752. // types (JsonPatch, MergePatch, StrategicMergePatch).
  753. // +optional
  754. optional string fieldManager = 3;
  755. }
  756. // Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.
  757. message Preconditions {
  758. // Specifies the target UID.
  759. // +optional
  760. optional string uid = 1;
  761. // Specifies the target ResourceVersion
  762. // +optional
  763. optional string resourceVersion = 2;
  764. }
  765. // RootPaths lists the paths available at root.
  766. // For example: "/healthz", "/apis".
  767. message RootPaths {
  768. // paths are the paths available at root.
  769. repeated string paths = 1;
  770. }
  771. // ServerAddressByClientCIDR helps the client to determine the server address that they should use, depending on the clientCIDR that they match.
  772. message ServerAddressByClientCIDR {
  773. // The CIDR with which clients can match their IP to figure out the server address that they should use.
  774. optional string clientCIDR = 1;
  775. // Address of this server, suitable for a client that matches the above CIDR.
  776. // This can be a hostname, hostname:port, IP or IP:port.
  777. optional string serverAddress = 2;
  778. }
  779. // Status is a return value for calls that don't return other objects.
  780. message Status {
  781. // Standard list metadata.
  782. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
  783. // +optional
  784. optional ListMeta metadata = 1;
  785. // Status of the operation.
  786. // One of: "Success" or "Failure".
  787. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
  788. // +optional
  789. optional string status = 2;
  790. // A human-readable description of the status of this operation.
  791. // +optional
  792. optional string message = 3;
  793. // A machine-readable description of why this operation is in the
  794. // "Failure" status. If this value is empty there
  795. // is no information available. A Reason clarifies an HTTP status
  796. // code but does not override it.
  797. // +optional
  798. optional string reason = 4;
  799. // Extended data associated with the reason. Each reason may define its
  800. // own extended details. This field is optional and the data returned
  801. // is not guaranteed to conform to any schema except that defined by
  802. // the reason type.
  803. // +optional
  804. optional StatusDetails details = 5;
  805. // Suggested HTTP return code for this status, 0 if not set.
  806. // +optional
  807. optional int32 code = 6;
  808. }
  809. // StatusCause provides more information about an api.Status failure, including
  810. // cases when multiple errors are encountered.
  811. message StatusCause {
  812. // A machine-readable description of the cause of the error. If this value is
  813. // empty there is no information available.
  814. // +optional
  815. optional string reason = 1;
  816. // A human-readable description of the cause of the error. This field may be
  817. // presented as-is to a reader.
  818. // +optional
  819. optional string message = 2;
  820. // The field of the resource that has caused this error, as named by its JSON
  821. // serialization. May include dot and postfix notation for nested attributes.
  822. // Arrays are zero-indexed. Fields may appear more than once in an array of
  823. // causes due to fields having multiple errors.
  824. // Optional.
  825. //
  826. // Examples:
  827. // "name" - the field "name" on the current resource
  828. // "items[0].name" - the field "name" on the first array entry in "items"
  829. // +optional
  830. optional string field = 3;
  831. }
  832. // StatusDetails is a set of additional properties that MAY be set by the
  833. // server to provide additional information about a response. The Reason
  834. // field of a Status object defines what attributes will be set. Clients
  835. // must ignore fields that do not match the defined type of each attribute,
  836. // and should assume that any attribute may be empty, invalid, or under
  837. // defined.
  838. message StatusDetails {
  839. // The name attribute of the resource associated with the status StatusReason
  840. // (when there is a single name which can be described).
  841. // +optional
  842. optional string name = 1;
  843. // The group attribute of the resource associated with the status StatusReason.
  844. // +optional
  845. optional string group = 2;
  846. // The kind attribute of the resource associated with the status StatusReason.
  847. // On some operations may differ from the requested resource Kind.
  848. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
  849. // +optional
  850. optional string kind = 3;
  851. // UID of the resource.
  852. // (when there is a single resource which can be described).
  853. // More info: http://kubernetes.io/docs/user-guide/identifiers#uids
  854. // +optional
  855. optional string uid = 6;
  856. // The Causes array includes more details associated with the StatusReason
  857. // failure. Not all StatusReasons may provide detailed causes.
  858. // +optional
  859. repeated StatusCause causes = 4;
  860. // If specified, the time in seconds before the operation should be retried. Some errors may indicate
  861. // the client must take an alternate action - for those errors this field may indicate how long to wait
  862. // before taking the alternate action.
  863. // +optional
  864. optional int32 retryAfterSeconds = 5;
  865. }
  866. // TableOptions are used when a Table is requested by the caller.
  867. // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
  868. message TableOptions {
  869. // includeObject decides whether to include each object along with its columnar information.
  870. // Specifying "None" will return no object, specifying "Object" will return the full object contents, and
  871. // specifying "Metadata" (the default) will return the object's metadata in the PartialObjectMetadata kind
  872. // in version v1beta1 of the meta.k8s.io API group.
  873. optional string includeObject = 1;
  874. }
  875. // Time is a wrapper around time.Time which supports correct
  876. // marshaling to YAML and JSON. Wrappers are provided for many
  877. // of the factory methods that the time package offers.
  878. //
  879. // +protobuf.options.marshal=false
  880. // +protobuf.as=Timestamp
  881. // +protobuf.options.(gogoproto.goproto_stringer)=false
  882. message Time {
  883. // Represents seconds of UTC time since Unix epoch
  884. // 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
  885. // 9999-12-31T23:59:59Z inclusive.
  886. optional int64 seconds = 1;
  887. // Non-negative fractions of a second at nanosecond resolution. Negative
  888. // second values with fractions must still have non-negative nanos values
  889. // that count forward in time. Must be from 0 to 999,999,999
  890. // inclusive. This field may be limited in precision depending on context.
  891. optional int32 nanos = 2;
  892. }
  893. // Timestamp is a struct that is equivalent to Time, but intended for
  894. // protobuf marshalling/unmarshalling. It is generated into a serialization
  895. // that matches Time. Do not use in Go structs.
  896. message Timestamp {
  897. // Represents seconds of UTC time since Unix epoch
  898. // 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
  899. // 9999-12-31T23:59:59Z inclusive.
  900. optional int64 seconds = 1;
  901. // Non-negative fractions of a second at nanosecond resolution. Negative
  902. // second values with fractions must still have non-negative nanos values
  903. // that count forward in time. Must be from 0 to 999,999,999
  904. // inclusive. This field may be limited in precision depending on context.
  905. optional int32 nanos = 2;
  906. }
  907. // TypeMeta describes an individual object in an API response or request
  908. // with strings representing the type of the object and its API schema version.
  909. // Structures that are versioned or persisted should inline TypeMeta.
  910. //
  911. // +k8s:deepcopy-gen=false
  912. message TypeMeta {
  913. // Kind is a string value representing the REST resource this object represents.
  914. // Servers may infer this from the endpoint the client submits requests to.
  915. // Cannot be updated.
  916. // In CamelCase.
  917. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
  918. // +optional
  919. optional string kind = 1;
  920. // APIVersion defines the versioned schema of this representation of an object.
  921. // Servers should convert recognized schemas to the latest internal value, and
  922. // may reject unrecognized values.
  923. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
  924. // +optional
  925. optional string apiVersion = 2;
  926. }
  927. // UpdateOptions may be provided when updating an API object.
  928. // All fields in UpdateOptions should also be present in PatchOptions.
  929. message UpdateOptions {
  930. // When present, indicates that modifications should not be
  931. // persisted. An invalid or unrecognized dryRun directive will
  932. // result in an error response and no further processing of the
  933. // request. Valid values are:
  934. // - All: all dry run stages will be processed
  935. // +optional
  936. repeated string dryRun = 1;
  937. // fieldManager is a name associated with the actor or entity
  938. // that is making these changes. The value must be less than or
  939. // 128 characters long, and only contain printable characters,
  940. // as defined by https://golang.org/pkg/unicode/#IsPrint.
  941. // +optional
  942. optional string fieldManager = 2;
  943. }
  944. // Verbs masks the value so protobuf can generate
  945. //
  946. // +protobuf.nullable=true
  947. // +protobuf.options.(gogoproto.goproto_stringer)=false
  948. message Verbs {
  949. // items, if empty, will result in an empty slice
  950. repeated string items = 1;
  951. }
  952. // Event represents a single event to a watched resource.
  953. //
  954. // +protobuf=true
  955. // +k8s:deepcopy-gen=true
  956. // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
  957. message WatchEvent {
  958. optional string type = 1;
  959. // Object is:
  960. // * If Type is Added or Modified: the new state of the object.
  961. // * If Type is Deleted: the state of the object immediately before deletion.
  962. // * If Type is Error: *Status is recommended; other types may make sense
  963. // depending on context.
  964. optional k8s.io.apimachinery.pkg.runtime.RawExtension object = 2;
  965. }