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