generated.proto
Package : k8s.io.apimachinery.pkg.apis.meta.v1
generated.proto
Table of Contents
- APIGroup
- APIGroupList
- APIResource
- APIResourceList
- APIVersions
- CreateOptions
- DeleteOptions
- Duration
- ExportOptions
- FieldsV1
- GetOptions
- GroupKind
- GroupResource
- GroupVersion
- GroupVersionForDiscovery
- GroupVersionKind
- GroupVersionResource
- LabelSelector
- LabelSelector.MatchLabelsEntry
- LabelSelectorRequirement
- List
- ListMeta
- ListOptions
- ManagedFieldsEntry
- MicroTime
- ObjectMeta
- ObjectMeta.AnnotationsEntry
- ObjectMeta.LabelsEntry
- OwnerReference
- PartialObjectMetadata
- PartialObjectMetadataList
- Patch
- PatchOptions
- Preconditions
- RootPaths
- ServerAddressByClientCIDR
- Status
- StatusCause
- StatusDetails
- TableOptions
- Time
- Timestamp
- TypeMeta
- UpdateOptions
- Verbs
- WatchEvent
APIGroup
Field | Type | Label | Description |
---|---|---|---|
name | string | optional | name is the name of the group. |
versions | []k8s.io.apimachinery.pkg.apis.meta.v1.GroupVersionForDiscovery | repeated | versions are the versions supported in this group. |
preferredVersion | k8s.io.apimachinery.pkg.apis.meta.v1.GroupVersionForDiscovery | optional | preferredVersion is the version preferred by the API server, which probably is the storage version. +optional |
serverAddressByClientCIDRs | []k8s.io.apimachinery.pkg.apis.meta.v1.ServerAddressByClientCIDR | repeated | a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP. +optional |
APIGroupList
Field | Type | Label | Description |
---|---|---|---|
groups | []k8s.io.apimachinery.pkg.apis.meta.v1.APIGroup | repeated | groups is a list of APIGroup. |
APIResource
Field | Type | Label | Description |
---|---|---|---|
name | string | optional | name is the plural name of the resource. |
singularName | string | optional | singularName is the singular name of the resource. This allows clients to handle plural and singular opaquely. The singularName is more correct for reporting status on a single item and both singular and plural are allowed from the kubectl CLI interface. |
namespaced | bool | optional | namespaced indicates if a resource is namespaced or not. |
group | string | optional | group is the preferred group of the resource. Empty implies the group of the containing resource list. For subresources, this may have a different value, for example: Scale”. |
version | string | optional | version is the preferred version of the resource. Empty implies the version of the containing resource list For subresources, this may have a different value, for example: v1 (while inside a v1beta1 version of the core resource's group)". |
kind | string | optional | kind is the kind for the resource (e.g. ‘Foo’ is the kind for a resource ‘foo’) |
verbs | k8s.io.apimachinery.pkg.apis.meta.v1.Verbs | optional | verbs is a list of supported kube verbs (this includes get, list, watch, create, update, patch, delete, deletecollection, and proxy) |
shortNames | []string | repeated | shortNames is a list of suggested short names of the resource. |
categories | []string | repeated | categories is a list of the grouped resources this resource belongs to (e.g. ‘all’) |
storageVersionHash | string | optional | The hash value of the storage version, the version this resource is converted to when written to the data store. Value must be treated as opaque by clients. Only equality comparison on the value is valid. This is an alpha feature and may change or be removed in the future. The field is populated by the apiserver only if the StorageVersionHash feature gate is enabled. This field will remain optional even if it graduates. +optional |
APIResourceList
Field | Type | Label | Description |
---|---|---|---|
groupVersion | string | optional | groupVersion is the group and version this APIResourceList is for. |
resources | []k8s.io.apimachinery.pkg.apis.meta.v1.APIResource | repeated | resources contains the name of the resources and if they are namespaced. |
APIVersions
Field | Type | Label | Description |
---|---|---|---|
versions | []string | repeated | versions are the api versions that are available. |
serverAddressByClientCIDRs | []k8s.io.apimachinery.pkg.apis.meta.v1.ServerAddressByClientCIDR | repeated | a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP. |
CreateOptions
Field | Type | Label | Description |
---|---|---|---|
dryRun | []string | repeated | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +optional |
fieldManager | string | optional | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +optional |
DeleteOptions
Field | Type | Label | Description |
---|---|---|---|
gracePeriodSeconds | int64 | optional | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. +optional |
preconditions | k8s.io.apimachinery.pkg.apis.meta.v1.Preconditions | optional | Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned. +optional |
orphanDependents | bool | optional | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the “orphan” finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. +optional |
propagationPolicy | string | optional | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: ‘Orphan’ - orphan the dependents; ‘Background’ - allow the garbage collector to delete the dependents in the background; ‘Foreground’ - a cascading policy that deletes all dependents in the foreground. +optional |
dryRun | []string | repeated | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +optional |
Duration
Field | Type | Label | Description |
---|---|---|---|
duration | int64 | optional |
ExportOptions
Field | Type | Label | Description |
---|---|---|---|
export | bool | optional | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
exact | bool | optional | Should the export be exact. Exact export maintains cluster-specific fields like ‘Namespace’. Deprecated. Planned for removal in 1.18. |
FieldsV1
Field | Type | Label | Description |
---|---|---|---|
raw | bytes | optional | Raw is the underlying serialization of this object. |
GetOptions
Field | Type | Label | Description |
---|---|---|---|
resourceVersion | string | optional | When specified: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
GroupKind
Field | Type | Label | Description |
---|---|---|---|
group | string | optional | |
kind | string | optional |
GroupResource
Field | Type | Label | Description |
---|---|---|---|
group | string | optional | |
resource | string | optional |
GroupVersion
Field | Type | Label | Description |
---|---|---|---|
group | string | optional | |
version | string | optional |
GroupVersionForDiscovery
Field | Type | Label | Description |
---|---|---|---|
groupVersion | string | optional | groupVersion specifies the API group and version in the form “group/version” |
version | string | optional | version specifies the version in the form of “version”. This is to save the clients the trouble of splitting the GroupVersion. |
GroupVersionKind
Field | Type | Label | Description |
---|---|---|---|
group | string | optional | |
version | string | optional | |
kind | string | optional |
GroupVersionResource
Field | Type | Label | Description |
---|---|---|---|
group | string | optional | |
version | string | optional | |
resource | string | optional |
LabelSelector
Field | Type | Label | Description |
---|---|---|---|
matchLabels | []k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector.MatchLabelsEntry | repeated | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed. +optional |
matchExpressions | []k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement | repeated | matchExpressions is a list of label selector requirements. The requirements are ANDed. +optional |
LabelSelector.MatchLabelsEntry
Field | Type | Label | Description |
---|---|---|---|
key | string | optional | |
value | string | optional |
LabelSelectorRequirement
Field | Type | Label | Description |
---|---|---|---|
key | string | optional | key is the label key that the selector applies to. +patchMergeKey=key +patchStrategy=merge |
operator | string | optional | operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
values | []string | repeated | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. +optional |
List
Field | Type | Label | Description |
---|---|---|---|
metadata | k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta | optional | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds +optional |
items | []k8s.io.apimachinery.pkg.runtime.RawExtension | repeated | List of objects |
ListMeta
Field | Type | Label | Description |
---|---|---|---|
selfLink | string | optional | selfLink is a URL representing this object. Populated by the system. Read-only. DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release. +optional |
resourceVersion | string | optional | String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency +optional |
continue | string | optional | continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message. |
remainingItemCount | int64 | optional | remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is estimating the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact. +optional |
ListOptions
Field | Type | Label | Description |
---|---|---|---|
labelSelector | string | optional | A selector to restrict the list of returned objects by their labels. Defaults to everything. +optional |
fieldSelector | string | optional | A selector to restrict the list of returned objects by their fields. Defaults to everything. +optional |
watch | bool | optional | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +optional |
allowWatchBookmarks | bool | optional | allowWatchBookmarks requests watch events with type “BOOKMARK”. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. This field is beta. +optional |
resourceVersion | string | optional | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. +optional |
timeoutSeconds | int64 | optional | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +optional |
limit | int64 | optional | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
continue | string | optional | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the “next key”. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
ManagedFieldsEntry
Field | Type | Label | Description |
---|---|---|---|
manager | string | optional | Manager is an identifier of the workflow managing these fields. |
operation | string | optional | Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are ‘Apply’ and ‘Update’. |
apiVersion | string | optional | APIVersion defines the version of this resource that this field set applies to. The format is “group/version” just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted. |
time | k8s.io.apimachinery.pkg.apis.meta.v1.Time | optional | Time is timestamp of when these fields were set. It should always be empty if Operation is ‘Apply’ +optional |
fieldsType | string | optional | FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: “FieldsV1” |
fieldsV1 | k8s.io.apimachinery.pkg.apis.meta.v1.FieldsV1 | optional | FieldsV1 holds the first JSON version format as described in the “FieldsV1” type. +optional |
MicroTime
Field | Type | Label | Description |
---|---|---|---|
seconds | int64 | optional | Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive. |
nanos | int32 | optional | Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive. This field may be limited in precision depending on context. |
ObjectMeta
Field | Type | Label | Description |
---|---|---|---|
name | string | optional | Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names +optional |
generateName | string | optional | GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header). Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency +optional |
namespace | string | optional | Namespace defines the space within each name must be unique. An empty namespace is equivalent to the “default” namespace, but “default” is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces +optional |
selfLink | string | optional | SelfLink is a URL representing this object. Populated by the system. Read-only. DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release. +optional |
uid | string | optional | UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids +optional |
resourceVersion | string | optional | An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency +optional |
generation | int64 | optional | A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. +optional |
creationTimestamp | k8s.io.apimachinery.pkg.apis.meta.v1.Time | optional | CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata +optional |
deletionTimestamp | k8s.io.apimachinery.pkg.apis.meta.v1.Time | optional | DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata +optional |
deletionGracePeriodSeconds | int64 | optional | Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. +optional |
labels | []k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta.LabelsEntry | repeated | Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels +optional |
annotations | []k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta.AnnotationsEntry | repeated | Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations +optional |
ownerReferences | []k8s.io.apimachinery.pkg.apis.meta.v1.OwnerReference | repeated | List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. +optional +patchMergeKey=uid +patchStrategy=merge |
finalizers | []string | repeated | Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. +optional +patchStrategy=merge |
clusterName | string | optional | The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request. +optional |
managedFields | []k8s.io.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry | repeated | ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like “ci-cd”. The set of fields is always in the version that the workflow used when modifying the object. This field is alpha and can be changed or removed without notice. +optional |
ObjectMeta.AnnotationsEntry
Field | Type | Label | Description |
---|---|---|---|
key | string | optional | |
value | string | optional |
ObjectMeta.LabelsEntry
Field | Type | Label | Description |
---|---|---|---|
key | string | optional | |
value | string | optional |
OwnerReference
Field | Type | Label | Description |
---|---|---|---|
apiVersion | string | optional | API version of the referent. |
kind | string | optional | Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
name | string | optional | Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names |
uid | string | optional | UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
controller | bool | optional | If true, this reference points to the managing controller. +optional |
blockOwnerDeletion | bool | optional | If true, AND if the owner has the “foregroundDeletion” finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs “delete” permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. +optional |
PartialObjectMetadata
Field | Type | Label | Description |
---|---|---|---|
metadata | k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta | optional | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata +optional |
PartialObjectMetadataList
Field | Type | Label | Description |
---|---|---|---|
metadata | k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta | optional | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds +optional |
items | []k8s.io.apimachinery.pkg.apis.meta.v1.PartialObjectMetadata | repeated | items contains each of the included items. |
Patch
PatchOptions
Field | Type | Label | Description |
---|---|---|---|
dryRun | []string | repeated | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +optional |
force | bool | optional | Force is going to “force” Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. +optional |
fieldManager | string | optional | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). +optional |
Preconditions
Field | Type | Label | Description |
---|---|---|---|
uid | string | optional | Specifies the target UID. +optional |
resourceVersion | string | optional | Specifies the target ResourceVersion +optional |
RootPaths
Field | Type | Label | Description |
---|---|---|---|
paths | []string | repeated | paths are the paths available at root. |
ServerAddressByClientCIDR
Field | Type | Label | Description |
---|---|---|---|
clientCIDR | string | optional | The CIDR with which clients can match their IP to figure out the server address that they should use. |
serverAddress | string | optional | Address of this server, suitable for a client that matches the above CIDR. This can be a hostname, hostname:port, IP or IP:port. |
Status
Field | Type | Label | Description |
---|---|---|---|
metadata | k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta | optional | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds +optional |
status | string | optional | Status of the operation. One of: “Success” or “Failure”. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status +optional |
message | string | optional | A human-readable description of the status of this operation. +optional |
reason | string | optional | A machine-readable description of why this operation is in the “Failure” status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it. +optional |
details | k8s.io.apimachinery.pkg.apis.meta.v1.StatusDetails | optional | Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type. +optional |
code | int32 | optional | Suggested HTTP return code for this status, 0 if not set. +optional |
StatusCause
Field | Type | Label | Description |
---|---|---|---|
reason | string | optional | A machine-readable description of the cause of the error. If this value is empty there is no information available. +optional |
message | string | optional | A human-readable description of the cause of the error. This field may be presented as-is to a reader. +optional |
field | string | optional | The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional. Examples: “name” - the field “name” on the current resource “items[0].name” - the field “name” on the first array entry in “items” +optional |
StatusDetails
Field | Type | Label | Description |
---|---|---|---|
name | string | optional | The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described). +optional |
group | string | optional | The group attribute of the resource associated with the status StatusReason. +optional |
kind | string | optional | The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds +optional |
uid | string | optional | UID of the resource. (when there is a single resource which can be described). More info: http://kubernetes.io/docs/user-guide/identifiers#uids +optional |
causes | []k8s.io.apimachinery.pkg.apis.meta.v1.StatusCause | repeated | The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes. +optional |
retryAfterSeconds | int32 | optional | If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action. +optional |
TableOptions
Field | Type | Label | Description |
---|---|---|---|
includeObject | string | optional | includeObject decides whether to include each object along with its columnar information. Specifying “None” will return no object, specifying “Object” will return the full object contents, and specifying “Metadata” (the default) will return the object's metadata in the PartialObjectMetadata kind in version v1beta1 of the meta.k8s.io API group. |
Time
Field | Type | Label | Description |
---|---|---|---|
seconds | int64 | optional | Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive. |
nanos | int32 | optional | Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive. This field may be limited in precision depending on context. |
Timestamp
Field | Type | Label | Description |
---|---|---|---|
seconds | int64 | optional | Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive. |
nanos | int32 | optional | Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive. This field may be limited in precision depending on context. |
TypeMeta
Field | Type | Label | Description |
---|---|---|---|
kind | string | optional | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds +optional |
apiVersion | string | optional | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources +optional |
UpdateOptions
Field | Type | Label | Description |
---|---|---|---|
dryRun | []string | repeated | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +optional |
fieldManager | string | optional | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +optional |
Verbs
Field | Type | Label | Description |
---|---|---|---|
items | []string | repeated |
WatchEvent
Field | Type | Label | Description |
---|---|---|---|
type | string | optional | |
object | k8s.io.apimachinery.pkg.runtime.RawExtension | optional | Object is: * If Type is Added or Modified: the new state of the object. * If Type is Deleted: the state of the object immediately before deletion. * If Type is Error: *Status is recommended; other types may make sense depending on context. |