package v1
- Alphabetic
- Public
- Protected
Type Members
- case class APIGroup(name: String, versions: Seq[GroupVersionForDiscovery], apiVersion: Option[String] = None, kind: Option[String] = None, preferredVersion: Option[GroupVersionForDiscovery] = None, serverAddressByClientCIDRs: Option[Seq[ServerAddressByClientCIDR]] = None) extends Product with Serializable
APIGroup contains the name, the supported versions, and the preferred version of a group.
APIGroup contains the name, the supported versions, and the preferred version of a group.
- name
name is the name of the group.
- versions
versions are the versions supported in this group.
- apiVersion
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/sig-architecture/api-conventions.md#resources
- kind
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/sig-architecture/api-conventions.md#types-kinds
- preferredVersion
preferredVersion is the version preferred by the API server, which probably is the storage version.
- serverAddressByClientCIDRs
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.
- case class APIGroupList(groups: Seq[APIGroup], apiVersion: Option[String] = None, kind: Option[String] = None) extends Product with Serializable
APIGroupList is a list of APIGroup, to allow clients to discover the API at /apis.
APIGroupList is a list of APIGroup, to allow clients to discover the API at /apis.
- groups
groups is a list of APIGroup.
- apiVersion
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/sig-architecture/api-conventions.md#resources
- kind
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/sig-architecture/api-conventions.md#types-kinds
- case class APIResource(name: String, singularName: String, namespaced: Boolean, kind: String, verbs: Seq[String], categories: Option[Seq[String]] = None, group: Option[String] = None, shortNames: Option[Seq[String]] = None, storageVersionHash: Option[String] = None, version: Option[String] = None) extends Product with Serializable
APIResource specifies the name of a resource and whether it is namespaced.
APIResource specifies the name of a resource and whether it is namespaced.
- name
name is the plural name of the resource.
- singularName
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
namespaced indicates if a resource is namespaced or not.
- kind
kind is the kind for the resource (e.g. 'Foo' is the kind for a resource 'foo')
- verbs
verbs is a list of supported kube verbs (this includes get, list, watch, create, update, patch, delete, deletecollection, and proxy)
- categories
categories is a list of the grouped resources this resource belongs to (e.g. 'all')
- group
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".
- shortNames
shortNames is a list of suggested short names of the resource.
- storageVersionHash
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.
- version
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)".
- case class APIResourceList(groupVersion: String, resources: Seq[APIResource], apiVersion: Option[String] = None, kind: Option[String] = None) extends Product with Serializable
APIResourceList is a list of APIResource, it is used to expose the name of the resources supported in a specific group and version, and if the resource is namespaced.
APIResourceList is a list of APIResource, it is used to expose the name of the resources supported in a specific group and version, and if the resource is namespaced.
- groupVersion
groupVersion is the group and version this APIResourceList is for.
- resources
resources contains the name of the resources and if they are namespaced.
- apiVersion
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/sig-architecture/api-conventions.md#resources
- kind
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/sig-architecture/api-conventions.md#types-kinds
- case class APIVersions(versions: Seq[String], serverAddressByClientCIDRs: Seq[ServerAddressByClientCIDR], apiVersion: Option[String] = None, kind: Option[String] = None) extends Product with Serializable
APIVersions lists the versions that are available, to allow clients to discover the API at /api, which is the root path of the legacy v1 API.
APIVersions lists the versions that are available, to allow clients to discover the API at /api, which is the root path of the legacy v1 API.
- versions
versions are the api versions that are available.
- serverAddressByClientCIDRs
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.
- apiVersion
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/sig-architecture/api-conventions.md#resources
- kind
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/sig-architecture/api-conventions.md#types-kinds
- case class Condition(type: String, status: String, lastTransitionTime: Time, reason: String, message: String, observedGeneration: Option[Long] = None) extends Product with Serializable
Condition contains details for one aspect of the current state of this API Resource.
Condition contains details for one aspect of the current state of this API Resource.
- status
status of the condition, one of True, False, Unknown.
- lastTransitionTime
lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
- reason
reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
- message
message is a human readable message indicating details about the transition. This may be an empty string.
- observedGeneration
observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
- case class DeleteOptions(apiVersion: Option[String] = None, dryRun: Option[Seq[String]] = None, gracePeriodSeconds: Option[Long] = None, kind: Option[String] = None, orphanDependents: Option[Boolean] = None, preconditions: Option[Preconditions] = None, propagationPolicy: Option[String] = None) extends Product with Serializable
DeleteOptions may be provided when deleting an API object.
DeleteOptions may be provided when deleting an API object.
- apiVersion
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/sig-architecture/api-conventions.md#resources
- dryRun
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
- gracePeriodSeconds
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.
- kind
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/sig-architecture/api-conventions.md#types-kinds
- orphanDependents
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.
- preconditions
Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.
- propagationPolicy
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
- case class FieldsV1() extends Product with Serializable
FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format.
FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format.
Each key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:<name>', where <name> is the name of a field in a struct, or key in a map 'v:<value>', where <value> is the exact json formatted value of a list item 'i:<index>', where <index> is position of a item in a list 'k:<keys>', where <keys> is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set.
The exact format is defined in sigs.k8s.io/structured-merge-diff
- case class GroupVersionForDiscovery(groupVersion: String, version: String) extends Product with Serializable
GroupVersion contains the "group/version" and "version" string of a version.
GroupVersion contains the "group/version" and "version" string of a version. It is made a struct to keep extensibility.
- groupVersion
groupVersion specifies the API group and version in the form "group/version"
- version
version specifies the version in the form of "version". This is to save the clients the trouble of splitting the GroupVersion.
- case class LabelSelector(matchExpressions: Option[Seq[LabelSelectorRequirement]] = None, matchLabels: Option[Map[String, String]] = None) extends Product with Serializable
A label selector is a label query over a set of resources.
A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
- matchExpressions
matchExpressions is a list of label selector requirements. The requirements are ANDed.
- matchLabels
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.
- case class LabelSelectorRequirement(key: String, operator: String, values: Option[Seq[String]] = None) extends Product with Serializable
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- key
key is the label key that the selector applies to.
- operator
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- values
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.
- case class ListMeta(continue: Option[String] = None, remainingItemCount: Option[Long] = None, resourceVersion: Option[String] = None, selfLink: Option[String] = None) extends Product with Serializable
ListMeta describes metadata that synthetic resources must have, including lists and various status objects.
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- continue
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
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.
- resourceVersion
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/sig-architecture/api-conventions.md#concurrency-control-and-consistency
- selfLink
Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
- case class ManagedFieldsEntry(apiVersion: Option[String] = None, fieldsType: Option[String] = None, fieldsV1: Option[FieldsV1] = None, manager: Option[String] = None, operation: Option[String] = None, subresource: Option[String] = None, time: Option[Time] = None) extends Product with Serializable
ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.
ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.
- apiVersion
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.
- fieldsType
FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"
- fieldsV1
FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.
- manager
Manager is an identifier of the workflow managing these fields.
- operation
Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.
- subresource
Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.
- time
Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.
- final case class MicroTime(value: String) extends AnyVal with Product with Serializable
- case class ObjectMeta(annotations: Option[Map[String, String]] = None, creationTimestamp: Option[Time] = None, deletionGracePeriodSeconds: Option[Long] = None, deletionTimestamp: Option[Time] = None, finalizers: Option[Seq[String]] = None, generateName: Option[String] = None, generation: Option[Long] = None, labels: Option[Map[String, String]] = None, managedFields: Option[Seq[ManagedFieldsEntry]] = None, name: Option[String] = None, namespace: Option[String] = None, ownerReferences: Option[Seq[OwnerReference]] = None, resourceVersion: Option[String] = None, selfLink: Option[String] = None, uid: Option[String] = None) extends Product with Serializable
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
- annotations
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
- creationTimestamp
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/sig-architecture/api-conventions.md#metadata
- deletionGracePeriodSeconds
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.
- deletionTimestamp
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/sig-architecture/api-conventions.md#metadata
- finalizers
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. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.
- generateName
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 return a 409 Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
- generation
A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
- labels
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
- managedFields
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.
- name
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
- namespace
Namespace defines the space within which 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
- ownerReferences
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.
- resourceVersion
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/sig-architecture/api-conventions.md#concurrency-control-and-consistency
- selfLink
Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
- uid
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
- case class OwnerReference(apiVersion: String, kind: String, name: String, uid: String, blockOwnerDeletion: Option[Boolean] = None, controller: Option[Boolean] = None) extends Product with Serializable
OwnerReference contains enough information to let you identify an owning object.
OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.
- apiVersion
API version of the referent.
- kind
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- name
Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names
- uid
UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
- blockOwnerDeletion
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. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.
- controller
If true, this reference points to the managing controller.
- case class Patch() extends Product with Serializable
Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.
- case class Preconditions(resourceVersion: Option[String] = None, uid: Option[String] = None) extends Product with Serializable
Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.
Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.
- resourceVersion
Specifies the target ResourceVersion
- uid
Specifies the target UID.
- case class ServerAddressByClientCIDR(clientCIDR: String, serverAddress: String) extends Product with Serializable
ServerAddressByClientCIDR helps the client to determine the server address that they should use, depending on the clientCIDR that they match.
ServerAddressByClientCIDR helps the client to determine the server address that they should use, depending on the clientCIDR that they match.
- clientCIDR
The CIDR with which clients can match their IP to figure out the server address that they should use.
- serverAddress
Address of this server, suitable for a client that matches the above CIDR. This can be a hostname, hostname:port, IP or IP:port.
- case class Status(apiVersion: Option[String] = None, code: Option[Int] = None, details: Option[StatusDetails] = None, kind: Option[String] = None, message: Option[String] = None, metadata: Option[ListMeta] = None, reason: Option[String] = None, status: Option[String] = None) extends Product with Serializable
Status is a return value for calls that don't return other objects.
Status is a return value for calls that don't return other objects.
- apiVersion
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/sig-architecture/api-conventions.md#resources
- code
Suggested HTTP return code for this status, 0 if not set.
- details
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.
- kind
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/sig-architecture/api-conventions.md#types-kinds
- message
A human-readable description of the status of this operation.
- metadata
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- reason
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.
- status
Status of the operation. One of: "Success" or "Failure". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
- case class StatusCause(field: Option[String] = None, message: Option[String] = None, reason: Option[String] = None) extends Product with Serializable
StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.
StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.
- field
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"
- message
A human-readable description of the cause of the error. This field may be presented as-is to a reader.
- reason
A machine-readable description of the cause of the error. If this value is empty there is no information available.
- case class StatusDetails(causes: Option[Seq[StatusCause]] = None, group: Option[String] = None, kind: Option[String] = None, name: Option[String] = None, retryAfterSeconds: Option[Int] = None, uid: Option[String] = None) extends Product with Serializable
StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response.
StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.
- causes
The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.
- group
The group attribute of the resource associated with the status StatusReason.
- kind
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/sig-architecture/api-conventions.md#types-kinds
- name
The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).
- retryAfterSeconds
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.
- uid
UID of the resource. (when there is a single resource which can be described). More info: http://kubernetes.io/docs/user-guide/identifiers#uids
- final case class Time(value: String) extends AnyVal with Product with Serializable
Value Members
- object APIGroup extends Serializable
- object APIGroupList extends Serializable
- object APIResource extends Serializable
- object APIResourceList extends Serializable
- object APIVersions extends Serializable
- object Condition extends Serializable
- object DeleteOptions extends Serializable
- object FieldsV1 extends Serializable
- object GroupVersionForDiscovery extends Serializable
- object LabelSelector extends Serializable
- object LabelSelectorRequirement extends Serializable
- object ListMeta extends Serializable
- object ManagedFieldsEntry extends Serializable
- object MicroTime extends Serializable
- object ObjectMeta extends Serializable
- object OwnerReference extends Serializable
- object Patch extends Serializable
- object Preconditions extends Serializable
- object ServerAddressByClientCIDR extends Serializable
- object Status extends Serializable
- object StatusCause extends Serializable
- object StatusDetails extends Serializable
- object Time extends Serializable