generated.proto 53 KB

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