zio-k8s-client/com.coralogix.zio.k8s.model.scheduling.v1/PriorityClass

PriorityClass

case
class PriorityClass(description: Optional[String], globalDefault: Optional[Boolean], metadata: Optional[ObjectMeta], preemptionPolicy: Optional[String], value: Int)

PriorityClass defines mapping from a priority class name to the priority integer value. The value can be any valid integer.

Value Params
description

description is an arbitrary string that usually provides guidelines on when this priority class should be used.

globalDefault

globalDefault specifies whether this PriorityClass should be considered as the default priority for pods that do not have any priority class. Only one PriorityClass can be marked as globalDefault. However, if more than one PriorityClasses exists with their globalDefault field set to true, the smallest value of such global default PriorityClasses will be used as the default priority.

preemptionPolicy

PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is beta-level, gated by the NonPreemptingPriority feature-gate.

value

The value of this priority class. This is the actual priority that pods receive when they have the name of this class in their pod spec.

Companion
object
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Value members

Concrete methods

def getDescription: IO[K8sFailure, String]

description is an arbitrary string that usually provides guidelines on when this priority class should be used.

description is an arbitrary string that usually provides guidelines on when this priority class should be used.

If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

def getGlobalDefault: IO[K8sFailure, Boolean]

globalDefault specifies whether this PriorityClass should be considered as the default priority for pods that do not have any priority class. Only one PriorityClass can be marked as globalDefault. However, if more than one PriorityClasses exists with their globalDefault field set to true, the smallest value of such global default PriorityClasses will be used as the default priority.

globalDefault specifies whether this PriorityClass should be considered as the default priority for pods that do not have any priority class. Only one PriorityClass can be marked as globalDefault. However, if more than one PriorityClasses exists with their globalDefault field set to true, the smallest value of such global default PriorityClasses will be used as the default priority.

If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

def getMetadata: IO[K8sFailure, ObjectMeta]

Gets metadata.

Gets metadata.

If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

def getPreemptionPolicy: IO[K8sFailure, String]

PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is beta-level, gated by the NonPreemptingPriority feature-gate.

PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is beta-level, gated by the NonPreemptingPriority feature-gate.

If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

def getValue: IO[K8sFailure, Int]

The value of this priority class. This is the actual priority that pods receive when they have the name of this class in their pod spec.

The value of this priority class. This is the actual priority that pods receive when they have the name of this class in their pod spec.

This effect always succeeds, it is safe to use the field value directly.

Inherited methods

def attachOwner(ownerName: String, ownerUid: String, ownerType: K8sResourceType): PriorityClass
Implicitly added by Ops

Attach another resource as the owner of this one

Attach another resource as the owner of this one

Value Params
ownerName

Owner's name

ownerType

Owner's resource type metadata

ownerUid

Owner's UID

Returns

Object with the attached owner described in its metadata

Inherited from
K8sObjectOps
def generation: Long
Implicitly added by Ops

Gets the geneation of the object or 0 if it is new

Gets the geneation of the object or 0 if it is new

Inherited from
K8sObjectOps
def getMetadata: IO[K8sFailure, ObjectMeta]
Implicitly added by Ops

Gets the metadata of the object and fail with com.coralogix.zio.k8s.client.UndefinedField if it is not present

Gets the metadata of the object and fail with com.coralogix.zio.k8s.client.UndefinedField if it is not present

Inherited from
K8sObjectOps
def getName: IO[K8sFailure, String]
Implicitly added by Ops

Gets the name of the object and fail with com.coralogix.zio.k8s.client.UndefinedField if it is not present

Gets the name of the object and fail with com.coralogix.zio.k8s.client.UndefinedField if it is not present

Inherited from
K8sObjectOps
def getUid: IO[K8sFailure, String]
Implicitly added by Ops

Gets the UID of the object and fail with com.coralogix.zio.k8s.client.UndefinedField if it is not present

Gets the UID of the object and fail with com.coralogix.zio.k8s.client.UndefinedField if it is not present

Inherited from
K8sObjectOps
def isOwnedBy[OwnerT : ResourceMetadata](owner: OwnerT): Boolean
Implicitly added by Ops

Verifies ownership between the resources

Verifies ownership between the resources

Type Params
OwnerT

Type of the owner resource

Value Params
owner

Possible owner of this resource

Returns

True if owner owns this resource

Inherited from
K8sObjectOps
def mapMetadata(f: ObjectMeta => ObjectMeta): PriorityClass
Implicitly added by Ops

Creates a new object with its metadata modified by the given function f

Creates a new object with its metadata modified by the given function f

Value Params
f

Function to modify the object's metadata with

Returns

Object with modified metadata

Inherited from
K8sObjectOps
def metadata: Optional[ObjectMeta]
Implicitly added by Ops

Gets the metadata of the object

Gets the metadata of the object

Inherited from
K8sObjectOps
def productElementNames: Iterator[String]
Inherited from
Product
def productIterator: Iterator[Any]
Inherited from
Product
def tryAttachOwner[OwnerT : ResourceMetadata](owner: OwnerT): IO[K8sFailure, PriorityClass]
Implicitly added by Ops

Tries to attach another resource as the owner of this one. Can fail with com.coralogix.zio.k8s.client.UndefinedField if the owner does not have all the required metadata.

Tries to attach another resource as the owner of this one. Can fail with com.coralogix.zio.k8s.client.UndefinedField if the owner does not have all the required metadata.

Type Params
OwnerT

Type of the owner

Value Params
owner

Owner resource

Returns

Object with the attached owner described in its metadata

Inherited from
K8sObjectOps

Concrete fields

override protected
val impl: K8sObject[PriorityClass]
Implicitly added by Ops
protected
val obj: PriorityClass
Implicitly added by Ops