2 Copyright The Kubernetes Authors.
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
8 http://www.apache.org/licenses/LICENSE-2.0
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.
18 // This file was autogenerated by go-to-protobuf. Do not edit it manually!
22 package k8s.io.apimachinery.pkg.apis.meta.v1;
24 import "k8s.io/apimachinery/pkg/runtime/generated.proto";
25 import "k8s.io/apimachinery/pkg/runtime/schema/generated.proto";
27 // Package-wide variables from generator "generated".
28 option go_package = "v1";
30 // APIGroup contains the name, the supported versions, and the preferred version
33 // name is the name of the group.
34 optional string name = 1;
36 // versions are the versions supported in this group.
37 repeated GroupVersionForDiscovery versions = 2;
39 // preferredVersion is the version preferred by the API server, which
40 // probably is the storage version.
42 optional GroupVersionForDiscovery preferredVersion = 3;
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.
52 repeated ServerAddressByClientCIDR serverAddressByClientCIDRs = 4;
55 // APIGroupList is a list of APIGroup, to allow clients to discover the API at
57 message APIGroupList {
58 // groups is a list of APIGroup.
59 repeated APIGroup groups = 1;
62 // APIResource specifies the name of a resource and whether it is namespaced.
64 // name is the plural name of the resource.
65 optional string name = 1;
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;
72 // namespaced indicates if a resource is namespaced or not.
73 optional bool namespaced = 2;
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;
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;
83 // kind is the kind for the resource (e.g. 'Foo' is the kind for a resource 'foo')
84 optional string kind = 3;
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;
90 // shortNames is a list of suggested short names of the resource.
91 repeated string shortNames = 5;
93 // categories is a list of the grouped resources this resource belongs to (e.g. 'all')
94 repeated string categories = 7;
97 // APIResourceList is a list of APIResource, it is used to expose the name of the
98 // resources supported in a specific group and version, and if the resource
100 message APIResourceList {
101 // groupVersion is the group and version this APIResourceList is for.
102 optional string groupVersion = 1;
104 // resources contains the name of the resources and if they are namespaced.
105 repeated APIResource resources = 2;
108 // APIVersions lists the versions that are available, to allow clients to
109 // discover the API at /api, which is the root path of the legacy v1 API.
111 // +protobuf.options.(gogoproto.goproto_stringer)=false
112 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
113 message APIVersions {
114 // versions are the api versions that are available.
115 repeated string versions = 1;
117 // a map of client CIDR to server address that is serving this group.
118 // This is to help clients reach servers in the most network-efficient way possible.
119 // Clients can use the appropriate server address as per the CIDR that they match.
120 // In case of multiple matches, clients should use the longest matching CIDR.
121 // The server returns only those CIDRs that it thinks that the client can match.
122 // For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP.
123 // Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP.
124 repeated ServerAddressByClientCIDR serverAddressByClientCIDRs = 2;
127 // CreateOptions may be provided when creating an API object.
128 message CreateOptions {
129 // When present, indicates that modifications should not be
130 // persisted. An invalid or unrecognized dryRun directive will
131 // result in an error response and no further processing of the
132 // request. Valid values are:
133 // - All: all dry run stages will be processed
135 repeated string dryRun = 1;
137 // If IncludeUninitialized is specified, the object may be
138 // returned without completing initialization.
139 optional bool includeUninitialized = 2;
142 // DeleteOptions may be provided when deleting an API object.
143 message DeleteOptions {
144 // The duration in seconds before the object should be deleted. Value must be non-negative integer.
145 // The value zero indicates delete immediately. If this value is nil, the default grace period for the
146 // specified type will be used.
147 // Defaults to a per object value if not specified. zero means delete immediately.
149 optional int64 gracePeriodSeconds = 1;
151 // Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be
154 optional Preconditions preconditions = 2;
156 // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7.
157 // Should the dependent objects be orphaned. If true/false, the "orphan"
158 // finalizer will be added to/removed from the object's finalizers list.
159 // Either this field or PropagationPolicy may be set, but not both.
161 optional bool orphanDependents = 3;
163 // Whether and how garbage collection will be performed.
164 // Either this field or OrphanDependents may be set, but not both.
165 // The default policy is decided by the existing finalizer set in the
166 // metadata.finalizers and the resource-specific default policy.
167 // Acceptable values are: 'Orphan' - orphan the dependents; 'Background' -
168 // allow the garbage collector to delete the dependents in the background;
169 // 'Foreground' - a cascading policy that deletes all dependents in the
172 optional string propagationPolicy = 4;
174 // When present, indicates that modifications should not be
175 // persisted. An invalid or unrecognized dryRun directive will
176 // result in an error response and no further processing of the
177 // request. Valid values are:
178 // - All: all dry run stages will be processed
180 repeated string dryRun = 5;
183 // Duration is a wrapper around time.Duration which supports correct
184 // marshaling to YAML and JSON. In particular, it marshals into strings, which
185 // can be used as map keys in json.
187 optional int64 duration = 1;
190 // ExportOptions is the query options to the standard REST get call.
191 message ExportOptions {
192 // Should this value be exported. Export strips fields that a user can not specify.
193 optional bool export = 1;
195 // Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
196 optional bool exact = 2;
199 // GetOptions is the standard query options to the standard REST get call.
202 // - if unset, then the result is returned from remote storage based on quorum-read flag;
203 // - if it's 0, then we simply return what we currently have in cache, no guarantee;
204 // - if set to non zero, then the result is at least as fresh as given rv.
205 optional string resourceVersion = 1;
207 // If true, partially initialized resources are included in the response.
209 optional bool includeUninitialized = 2;
212 // GroupKind specifies a Group and a Kind, but does not force a version. This is useful for identifying
213 // concepts during lookup stages without having partially valid types
215 // +protobuf.options.(gogoproto.goproto_stringer)=false
217 optional string group = 1;
219 optional string kind = 2;
222 // GroupResource specifies a Group and a Resource, but does not force a version. This is useful for identifying
223 // concepts during lookup stages without having partially valid types
225 // +protobuf.options.(gogoproto.goproto_stringer)=false
226 message GroupResource {
227 optional string group = 1;
229 optional string resource = 2;
232 // GroupVersion contains the "group" and the "version", which uniquely identifies the API.
234 // +protobuf.options.(gogoproto.goproto_stringer)=false
235 message GroupVersion {
236 optional string group = 1;
238 optional string version = 2;
241 // GroupVersion contains the "group/version" and "version" string of a version.
242 // It is made a struct to keep extensibility.
243 message GroupVersionForDiscovery {
244 // groupVersion specifies the API group and version in the form "group/version"
245 optional string groupVersion = 1;
247 // version specifies the version in the form of "version". This is to save
248 // the clients the trouble of splitting the GroupVersion.
249 optional string version = 2;
252 // GroupVersionKind unambiguously identifies a kind. It doesn't anonymously include GroupVersion
253 // to avoid automatic coersion. It doesn't use a GroupVersion to avoid custom marshalling
255 // +protobuf.options.(gogoproto.goproto_stringer)=false
256 message GroupVersionKind {
257 optional string group = 1;
259 optional string version = 2;
261 optional string kind = 3;
264 // GroupVersionResource unambiguously identifies a resource. It doesn't anonymously include GroupVersion
265 // to avoid automatic coersion. It doesn't use a GroupVersion to avoid custom marshalling
267 // +protobuf.options.(gogoproto.goproto_stringer)=false
268 message GroupVersionResource {
269 optional string group = 1;
271 optional string version = 2;
273 optional string resource = 3;
276 // Initializer is information about an initializer that has not yet completed.
277 message Initializer {
278 // name of the process that is responsible for initializing this object.
279 optional string name = 1;
282 // Initializers tracks the progress of initialization.
283 message Initializers {
284 // Pending is a list of initializers that must execute in order before this object is visible.
285 // When the last pending initializer is removed, and no failing result is set, the initializers
286 // struct will be set to nil and the object is considered as initialized and visible to all
288 // +patchMergeKey=name
289 // +patchStrategy=merge
290 repeated Initializer pending = 1;
292 // If result is set with the Failure field, the object will be persisted to storage and then deleted,
293 // ensuring that other clients can observe the deletion.
294 optional Status result = 2;
297 // A label selector is a label query over a set of resources. The result of matchLabels and
298 // matchExpressions are ANDed. An empty label selector matches all objects. A null
299 // label selector matches no objects.
300 message LabelSelector {
301 // matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
302 // map is equivalent to an element of matchExpressions, whose key field is "key", the
303 // operator is "In", and the values array contains only "value". The requirements are ANDed.
305 map<string, string> matchLabels = 1;
307 // matchExpressions is a list of label selector requirements. The requirements are ANDed.
309 repeated LabelSelectorRequirement matchExpressions = 2;
312 // A label selector requirement is a selector that contains values, a key, and an operator that
313 // relates the key and values.
314 message LabelSelectorRequirement {
315 // key is the label key that the selector applies to.
316 // +patchMergeKey=key
317 // +patchStrategy=merge
318 optional string key = 1;
320 // operator represents a key's relationship to a set of values.
321 // Valid operators are In, NotIn, Exists and DoesNotExist.
322 optional string operator = 2;
324 // values is an array of string values. If the operator is In or NotIn,
325 // the values array must be non-empty. If the operator is Exists or DoesNotExist,
326 // the values array must be empty. This array is replaced during a strategic
329 repeated string values = 3;
332 // List holds a list of objects, which may not be known by the server.
334 // Standard list metadata.
335 // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
337 optional ListMeta metadata = 1;
340 repeated k8s.io.apimachinery.pkg.runtime.RawExtension items = 2;
343 // ListMeta describes metadata that synthetic resources must have, including lists and
344 // various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
346 // selfLink is a URL representing this object.
347 // Populated by the system.
350 optional string selfLink = 1;
352 // String that identifies the server's internal version of this object that
353 // can be used by clients to determine when objects have changed.
354 // Value must be treated as opaque by clients and passed unmodified back to the server.
355 // Populated by the system.
357 // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
359 optional string resourceVersion = 2;
361 // continue may be set if the user set a limit on the number of items returned, and indicates that
362 // the server has more data available. The value is opaque and may be used to issue another request
363 // to the endpoint that served this list to retrieve the next set of available objects. Continuing a
364 // consistent list may not be possible if the server configuration has changed or more than a few
365 // minutes have passed. The resourceVersion field returned when using this continue value will be
366 // identical to the value in the first response, unless you have received this token from an error
368 optional string continue = 3;
371 // ListOptions is the query options to a standard REST list call.
372 message ListOptions {
373 // A selector to restrict the list of returned objects by their labels.
374 // Defaults to everything.
376 optional string labelSelector = 1;
378 // A selector to restrict the list of returned objects by their fields.
379 // Defaults to everything.
381 optional string fieldSelector = 2;
383 // If true, partially initialized resources are included in the response.
385 optional bool includeUninitialized = 6;
387 // Watch for changes to the described resources and return them as a stream of
388 // add, update, and remove notifications. Specify resourceVersion.
390 optional bool watch = 3;
392 // When specified with a watch call, shows changes that occur after that particular version of a resource.
393 // Defaults to changes from the beginning of history.
394 // When specified for list:
395 // - if unset, then the result is returned from remote storage based on quorum-read flag;
396 // - if it's 0, then we simply return what we currently have in cache, no guarantee;
397 // - if set to non zero, then the result is at least as fresh as given rv.
399 optional string resourceVersion = 4;
401 // Timeout for the list/watch call.
402 // This limits the duration of the call, regardless of any activity or inactivity.
404 optional int64 timeoutSeconds = 5;
406 // limit is a maximum number of responses to return for a list call. If more items exist, the
407 // server will set the `continue` field on the list metadata to a value that can be used with the
408 // same initial query to retrieve the next set of results. Setting a limit may return fewer than
409 // the requested amount of items (up to zero items) in the event all requested objects are
410 // filtered out and clients should only use the presence of the continue field to determine whether
411 // more results are available. Servers may choose not to support the limit argument and will return
412 // all of the available results. If limit is specified and the continue field is empty, clients may
413 // assume that no more results are available. This field is not supported if watch is true.
415 // The server guarantees that the objects returned when using continue will be identical to issuing
416 // a single list call without a limit - that is, no objects created, modified, or deleted after the
417 // first request is issued will be included in any subsequent continued requests. This is sometimes
418 // referred to as a consistent snapshot, and ensures that a client that is using limit to receive
419 // smaller chunks of a very large result can ensure they see all possible objects. If objects are
420 // updated during a chunked list the version of the object that was present at the time the first list
421 // result was calculated is returned.
422 optional int64 limit = 7;
424 // The continue option should be set when retrieving more results from the server. Since this value is
425 // server defined, clients may only use the continue value from a previous query result with identical
426 // query parameters (except for the value of continue) and the server may reject a continue value it
427 // does not recognize. If the specified continue value is no longer valid whether due to expiration
428 // (generally five to fifteen minutes) or a configuration change on the server, the server will
429 // respond with a 410 ResourceExpired error together with a continue token. If the client needs a
430 // consistent list, it must restart their list without the continue field. Otherwise, the client may
431 // send another list request with the token received with the 410 error, the server will respond with
432 // a list starting from the next key, but from the latest snapshot, which is inconsistent from the
433 // previous list results - objects that are created, modified, or deleted after the first list request
434 // will be included in the response, as long as their keys are after the "next key".
436 // This field is not supported when watch is true. Clients may start a watch from the last
437 // resourceVersion value returned by the server and not miss any modifications.
438 optional string continue = 8;
441 // MicroTime is version of Time with microsecond level precision.
443 // +protobuf.options.marshal=false
444 // +protobuf.as=Timestamp
445 // +protobuf.options.(gogoproto.goproto_stringer)=false
447 // Represents seconds of UTC time since Unix epoch
448 // 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
449 // 9999-12-31T23:59:59Z inclusive.
450 optional int64 seconds = 1;
452 // Non-negative fractions of a second at nanosecond resolution. Negative
453 // second values with fractions must still have non-negative nanos values
454 // that count forward in time. Must be from 0 to 999,999,999
455 // inclusive. This field may be limited in precision depending on context.
456 optional int32 nanos = 2;
459 // ObjectMeta is metadata that all persisted resources must have, which includes all objects
460 // users must create.
462 // Name must be unique within a namespace. Is required when creating resources, although
463 // some resources may allow a client to request the generation of an appropriate name
464 // automatically. Name is primarily intended for creation idempotence and configuration
466 // Cannot be updated.
467 // More info: http://kubernetes.io/docs/user-guide/identifiers#names
469 optional string name = 1;
471 // GenerateName is an optional prefix, used by the server, to generate a unique
472 // name ONLY IF the Name field has not been provided.
473 // If this field is used, the name returned to the client will be different
474 // than the name passed. This value will also be combined with a unique suffix.
475 // The provided value has the same validation rules as the Name field,
476 // and may be truncated by the length of the suffix required to make the value
477 // unique on the server.
479 // If this field is specified and the generated name exists, the server will
480 // NOT return a 409 - instead, it will either return 201 Created or 500 with Reason
481 // ServerTimeout indicating a unique name could not be found in the time allotted, and the client
482 // should retry (optionally after the time indicated in the Retry-After header).
484 // Applied only if Name is not specified.
485 // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency
487 optional string generateName = 2;
489 // Namespace defines the space within each name must be unique. An empty namespace is
490 // equivalent to the "default" namespace, but "default" is the canonical representation.
491 // Not all objects are required to be scoped to a namespace - the value of this field for
492 // those objects will be empty.
494 // Must be a DNS_LABEL.
495 // Cannot be updated.
496 // More info: http://kubernetes.io/docs/user-guide/namespaces
498 optional string namespace = 3;
500 // SelfLink is a URL representing this object.
501 // Populated by the system.
504 optional string selfLink = 4;
506 // UID is the unique in time and space value for this object. It is typically generated by
507 // the server on successful creation of a resource and is not allowed to change on PUT
510 // Populated by the system.
512 // More info: http://kubernetes.io/docs/user-guide/identifiers#uids
514 optional string uid = 5;
516 // An opaque value that represents the internal version of this object that can
517 // be used by clients to determine when objects have changed. May be used for optimistic
518 // concurrency, change detection, and the watch operation on a resource or set of resources.
519 // Clients must treat these values as opaque and passed unmodified back to the server.
520 // They may only be valid for a particular resource or set of resources.
522 // Populated by the system.
524 // Value must be treated as opaque by clients and .
525 // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
527 optional string resourceVersion = 6;
529 // A sequence number representing a specific generation of the desired state.
530 // Populated by the system. Read-only.
532 optional int64 generation = 7;
534 // CreationTimestamp is a timestamp representing the server time when this object was
535 // created. It is not guaranteed to be set in happens-before order across separate operations.
536 // Clients may not set this value. It is represented in RFC3339 form and is in UTC.
538 // Populated by the system.
541 // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
543 optional Time creationTimestamp = 8;
545 // DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This
546 // field is set by the server when a graceful deletion is requested by the user, and is not
547 // directly settable by a client. The resource is expected to be deleted (no longer visible
548 // from resource lists, and not reachable by name) after the time in this field, once the
549 // finalizers list is empty. As long as the finalizers list contains items, deletion is blocked.
550 // Once the deletionTimestamp is set, this value may not be unset or be set further into the
551 // future, although it may be shortened or the resource may be deleted prior to this time.
552 // For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react
553 // by sending a graceful termination signal to the containers in the pod. After that 30 seconds,
554 // the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,
555 // remove the pod from the API. In the presence of network partitions, this object may still
556 // exist after this timestamp, until an administrator or automated process can determine the
557 // resource is fully terminated.
558 // If not set, graceful deletion of the object has not been requested.
560 // Populated by the system when a graceful deletion is requested.
562 // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
564 optional Time deletionTimestamp = 9;
566 // Number of seconds allowed for this object to gracefully terminate before
567 // it will be removed from the system. Only set when deletionTimestamp is also set.
568 // May only be shortened.
571 optional int64 deletionGracePeriodSeconds = 10;
573 // Map of string keys and values that can be used to organize and categorize
574 // (scope and select) objects. May match selectors of replication controllers
576 // More info: http://kubernetes.io/docs/user-guide/labels
578 map<string, string> labels = 11;
580 // Annotations is an unstructured key value map stored with a resource that may be
581 // set by external tools to store and retrieve arbitrary metadata. They are not
582 // queryable and should be preserved when modifying objects.
583 // More info: http://kubernetes.io/docs/user-guide/annotations
585 map<string, string> annotations = 12;
587 // List of objects depended by this object. If ALL objects in the list have
588 // been deleted, this object will be garbage collected. If this object is managed by a controller,
589 // then an entry in this list will point to this controller, with the controller field set to true.
590 // There cannot be more than one managing controller.
592 // +patchMergeKey=uid
593 // +patchStrategy=merge
594 repeated OwnerReference ownerReferences = 13;
596 // An initializer is a controller which enforces some system invariant at object creation time.
597 // This field is a list of initializers that have not yet acted on this object. If nil or empty,
598 // this object has been completely initialized. Otherwise, the object is considered uninitialized
599 // and is hidden (in list/watch and get calls) from clients that haven't explicitly asked to
600 // observe uninitialized objects.
602 // When an object is created, the system will populate this list with the current set of initializers.
603 // Only privileged users may set or modify this list. Once it is empty, it may not be modified further
605 optional Initializers initializers = 16;
607 // Must be empty before the object is deleted from the registry. Each entry
608 // is an identifier for the responsible component that will remove the entry
609 // from the list. If the deletionTimestamp of the object is non-nil, entries
610 // in this list can only be removed.
612 // +patchStrategy=merge
613 repeated string finalizers = 14;
615 // The name of the cluster which the object belongs to.
616 // This is used to distinguish resources with same name and namespace in different clusters.
617 // This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.
619 optional string clusterName = 15;
622 // OwnerReference contains enough information to let you identify an owning
623 // object. An owning object must be in the same namespace as the dependent, or
624 // be cluster-scoped, so there is no namespace field.
625 message OwnerReference {
626 // API version of the referent.
627 optional string apiVersion = 5;
629 // Kind of the referent.
630 // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
631 optional string kind = 1;
633 // Name of the referent.
634 // More info: http://kubernetes.io/docs/user-guide/identifiers#names
635 optional string name = 3;
637 // UID of the referent.
638 // More info: http://kubernetes.io/docs/user-guide/identifiers#uids
639 optional string uid = 4;
641 // If true, this reference points to the managing controller.
643 optional bool controller = 6;
645 // If true, AND if the owner has the "foregroundDeletion" finalizer, then
646 // the owner cannot be deleted from the key-value store until this
647 // reference is removed.
648 // Defaults to false.
649 // To set this field, a user needs "delete" permission of the owner,
650 // otherwise 422 (Unprocessable Entity) will be returned.
652 optional bool blockOwnerDeletion = 7;
655 // Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.
659 // Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.
660 message Preconditions {
661 // Specifies the target UID.
663 optional string uid = 1;
666 // RootPaths lists the paths available at root.
667 // For example: "/healthz", "/apis".
669 // paths are the paths available at root.
670 repeated string paths = 1;
673 // ServerAddressByClientCIDR helps the client to determine the server address that they should use, depending on the clientCIDR that they match.
674 message ServerAddressByClientCIDR {
675 // The CIDR with which clients can match their IP to figure out the server address that they should use.
676 optional string clientCIDR = 1;
678 // Address of this server, suitable for a client that matches the above CIDR.
679 // This can be a hostname, hostname:port, IP or IP:port.
680 optional string serverAddress = 2;
683 // Status is a return value for calls that don't return other objects.
685 // Standard list metadata.
686 // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
688 optional ListMeta metadata = 1;
690 // Status of the operation.
691 // One of: "Success" or "Failure".
692 // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
694 optional string status = 2;
696 // A human-readable description of the status of this operation.
698 optional string message = 3;
700 // A machine-readable description of why this operation is in the
701 // "Failure" status. If this value is empty there
702 // is no information available. A Reason clarifies an HTTP status
703 // code but does not override it.
705 optional string reason = 4;
707 // Extended data associated with the reason. Each reason may define its
708 // own extended details. This field is optional and the data returned
709 // is not guaranteed to conform to any schema except that defined by
712 optional StatusDetails details = 5;
714 // Suggested HTTP return code for this status, 0 if not set.
716 optional int32 code = 6;
719 // StatusCause provides more information about an api.Status failure, including
720 // cases when multiple errors are encountered.
721 message StatusCause {
722 // A machine-readable description of the cause of the error. If this value is
723 // empty there is no information available.
725 optional string reason = 1;
727 // A human-readable description of the cause of the error. This field may be
728 // presented as-is to a reader.
730 optional string message = 2;
732 // The field of the resource that has caused this error, as named by its JSON
733 // serialization. May include dot and postfix notation for nested attributes.
734 // Arrays are zero-indexed. Fields may appear more than once in an array of
735 // causes due to fields having multiple errors.
739 // "name" - the field "name" on the current resource
740 // "items[0].name" - the field "name" on the first array entry in "items"
742 optional string field = 3;
745 // StatusDetails is a set of additional properties that MAY be set by the
746 // server to provide additional information about a response. The Reason
747 // field of a Status object defines what attributes will be set. Clients
748 // must ignore fields that do not match the defined type of each attribute,
749 // and should assume that any attribute may be empty, invalid, or under
751 message StatusDetails {
752 // The name attribute of the resource associated with the status StatusReason
753 // (when there is a single name which can be described).
755 optional string name = 1;
757 // The group attribute of the resource associated with the status StatusReason.
759 optional string group = 2;
761 // The kind attribute of the resource associated with the status StatusReason.
762 // On some operations may differ from the requested resource Kind.
763 // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
765 optional string kind = 3;
767 // UID of the resource.
768 // (when there is a single resource which can be described).
769 // More info: http://kubernetes.io/docs/user-guide/identifiers#uids
771 optional string uid = 6;
773 // The Causes array includes more details associated with the StatusReason
774 // failure. Not all StatusReasons may provide detailed causes.
776 repeated StatusCause causes = 4;
778 // If specified, the time in seconds before the operation should be retried. Some errors may indicate
779 // the client must take an alternate action - for those errors this field may indicate how long to wait
780 // before taking the alternate action.
782 optional int32 retryAfterSeconds = 5;
785 // Time is a wrapper around time.Time which supports correct
786 // marshaling to YAML and JSON. Wrappers are provided for many
787 // of the factory methods that the time package offers.
789 // +protobuf.options.marshal=false
790 // +protobuf.as=Timestamp
791 // +protobuf.options.(gogoproto.goproto_stringer)=false
793 // Represents seconds of UTC time since Unix epoch
794 // 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
795 // 9999-12-31T23:59:59Z inclusive.
796 optional int64 seconds = 1;
798 // Non-negative fractions of a second at nanosecond resolution. Negative
799 // second values with fractions must still have non-negative nanos values
800 // that count forward in time. Must be from 0 to 999,999,999
801 // inclusive. This field may be limited in precision depending on context.
802 optional int32 nanos = 2;
805 // Timestamp is a struct that is equivalent to Time, but intended for
806 // protobuf marshalling/unmarshalling. It is generated into a serialization
807 // that matches Time. Do not use in Go structs.
809 // Represents seconds of UTC time since Unix epoch
810 // 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
811 // 9999-12-31T23:59:59Z inclusive.
812 optional int64 seconds = 1;
814 // Non-negative fractions of a second at nanosecond resolution. Negative
815 // second values with fractions must still have non-negative nanos values
816 // that count forward in time. Must be from 0 to 999,999,999
817 // inclusive. This field may be limited in precision depending on context.
818 optional int32 nanos = 2;
821 // TypeMeta describes an individual object in an API response or request
822 // with strings representing the type of the object and its API schema version.
823 // Structures that are versioned or persisted should inline TypeMeta.
825 // +k8s:deepcopy-gen=false
827 // Kind is a string value representing the REST resource this object represents.
828 // Servers may infer this from the endpoint the client submits requests to.
829 // Cannot be updated.
831 // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
833 optional string kind = 1;
835 // APIVersion defines the versioned schema of this representation of an object.
836 // Servers should convert recognized schemas to the latest internal value, and
837 // may reject unrecognized values.
838 // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
840 optional string apiVersion = 2;
843 // UpdateOptions may be provided when updating an API object.
844 message UpdateOptions {
845 // When present, indicates that modifications should not be
846 // persisted. An invalid or unrecognized dryRun directive will
847 // result in an error response and no further processing of the
848 // request. Valid values are:
849 // - All: all dry run stages will be processed
851 repeated string dryRun = 1;
854 // Verbs masks the value so protobuf can generate
856 // +protobuf.nullable=true
857 // +protobuf.options.(gogoproto.goproto_stringer)=false
859 // items, if empty, will result in an empty slice
861 repeated string items = 1;
864 // Event represents a single event to a watched resource.
867 // +k8s:deepcopy-gen=true
868 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
870 optional string type = 1;
873 // * If Type is Added or Modified: the new state of the object.
874 // * If Type is Deleted: the state of the object immediately before deletion.
875 // * If Type is Error: *Status is recommended; other types may make sense
876 // depending on context.
877 optional k8s.io.apimachinery.pkg.runtime.RawExtension object = 2;