scala-k8s-objects/io.k8s.apimachinery.pkg.apis.meta.v1

io.k8s.apimachinery.pkg.apis.meta.v1

package io.k8s.apimachinery.pkg.apis.meta.v1

Type members

Classlikes

final case class APIGroup(name: String, versions: Seq[GroupVersionForDiscovery], preferredVersion: Option[GroupVersionForDiscovery], serverAddressByClientCIDRs: Option[Seq[ServerAddressByClientCIDR]]) extends KObject

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.

Source:
APIGroup.scala
final case class APIGroupList(groups: Seq[APIGroup]) extends KObject

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.

Source:
APIGroupList.scala
final case class APIResource(name: String, verbs: Seq[String], namespaced: Boolean, singularName: String, version: Option[String], categories: Option[Seq[String]], shortNames: Option[Seq[String]], storageVersionHash: Option[String], group: Option[String])

APIResource specifies the name of a resource and whether it is namespaced.

APIResource specifies the name of a resource and whether it is namespaced.

Source:
APIResource.scala
final case class APIResourceList(groupVersion: String, resources: Seq[APIResource]) extends KObject

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.

Source:
APIResourceList.scala
final case class APIVersions(serverAddressByClientCIDRs: Seq[ServerAddressByClientCIDR], versions: Seq[String]) extends KObject

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.

Source:
APIVersions.scala
final case class Condition(reason: String, status: String, lastTransitionTime: Time, message: String, `type`: String, observedGeneration: Option[Int])

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.

Source:
Condition.scala
final case class DeleteOptions(kind: String, apiVersion: String, orphanDependents: Option[Boolean], preconditions: Option[Preconditions], propagationPolicy: Option[String], gracePeriodSeconds: Option[Int], dryRun: Option[Seq[String]])

DeleteOptions may be provided when deleting an API object.

DeleteOptions may be provided when deleting an API object.

Companion:
object
Source:
DeleteOptions.scala
object DeleteOptions
Companion:
class
Source:
DeleteOptions.scala
final case class FieldsV1()

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:', where is the name of a field in a struct, or key in a map 'v:', where is the exact json formatted value of a list item 'i:', where is position of a item in a list 'k:', where 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

Companion:
object
Source:
FieldsV1.scala
object FieldsV1
Companion:
class
Source:
FieldsV1.scala
final case class GroupVersionForDiscovery(groupVersion: String, version: String)

GroupVersion contains the "group/version" and "version" string of a version. It is made a struct to keep extensibility.

GroupVersion contains the "group/version" and "version" string of a version. It is made a struct to keep extensibility.

Source:
GroupVersionForDiscovery.scala
final case class LabelSelector(matchExpressions: Option[Seq[LabelSelectorRequirement]], matchLabels: Option[Map[String, String]])

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.

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.

Source:
LabelSelector.scala
final case class LabelSelectorRequirement(key: String, operator: String, values: Option[Seq[String]])

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.

Source:
LabelSelectorRequirement.scala
final case class ListMeta(continue: Option[String], remainingItemCount: Option[Int], resourceVersion: Option[String], selfLink: Option[String])

ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.

ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.

Source:
ListMeta.scala
final case class ManagedFieldsEntry(operation: Option[String], manager: Option[String], fieldsV1: Option[FieldsV1], time: Option[Time], fieldsType: Option[String], subresource: Option[String])

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.

Source:
ManagedFieldsEntry.scala
final case class MicroTime(value: String) extends AnyVal

MicroTime is version of Time with microsecond level precision.

MicroTime is version of Time with microsecond level precision.

Source:
MicroTime.scala
final case class ObjectMeta(name: Option[String], ownerReferences: Option[Seq[OwnerReference]], creationTimestamp: Option[Time], generation: Option[Int], resourceVersion: Option[String], generateName: Option[String], deletionGracePeriodSeconds: Option[Int], selfLink: Option[String], finalizers: Option[Seq[String]], annotations: Option[Map[String, String]], managedFields: Option[Seq[ManagedFieldsEntry]], labels: Option[Map[String, String]], uid: Option[String], namespace: Option[String], deletionTimestamp: Option[Time])

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.

Source:
ObjectMeta.scala
final case class OwnerReference(name: String, uid: String, blockOwnerDeletion: Option[Boolean], controller: Option[Boolean])

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.

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.

Source:
OwnerReference.scala
final case class Patch()

Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.

Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.

Companion:
object
Source:
Patch.scala
object Patch
Companion:
class
Source:
Patch.scala
final case class Preconditions(resourceVersion: Option[String], uid: Option[String])

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.

Source:
Preconditions.scala
final case class ServerAddressByClientCIDR(clientCIDR: String, serverAddress: String)

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.

Source:
ServerAddressByClientCIDR.scala
final case class Status(reason: Option[String], code: Option[Int], status: Option[String], details: Option[StatusDetails], metadata: Option[ListMeta], message: Option[String]) extends KObject

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.

Source:
Status.scala
final case class StatusCause(field: Option[String], message: Option[String], reason: Option[String])

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.

Source:
StatusCause.scala
final case class StatusDetails(name: Option[String], causes: Option[Seq[StatusCause]], uid: Option[String], retryAfterSeconds: Option[Int], group: Option[String])

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.

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.

Source:
StatusDetails.scala
final case class Time(value: String) extends AnyVal

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

Source:
Time.scala
final case class WatchEvent(`object`: RawExtension, `type`: String)

Event represents a single event to a watched resource.

Event represents a single event to a watched resource.

Source:
WatchEvent.scala