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