Show / Hide Table of Contents

Class V1alpha2PodGroupSpec

PodGroupSpec defines the desired state of a PodGroup.

Inheritance
object
V1alpha2PodGroupSpec
Implements
IEquatable<V1alpha2PodGroupSpec>
Inherited Members
object.GetType()
object.MemberwiseClone()
object.Equals(object, object)
object.ReferenceEquals(object, object)
Namespace: k8s.Models
Assembly: KubernetesClient.dll
Syntax
public record V1alpha2PodGroupSpec : IEquatable<V1alpha2PodGroupSpec>

Constructors

V1alpha2PodGroupSpec()

Declaration
public V1alpha2PodGroupSpec()

V1alpha2PodGroupSpec(V1alpha2PodGroupSpec)

Declaration
protected V1alpha2PodGroupSpec(V1alpha2PodGroupSpec original)
Parameters
Type Name Description
V1alpha2PodGroupSpec original

Properties

DisruptionMode

DisruptionMode defines the mode in which a given PodGroup can be disrupted. Controllers are expected to fill this field by copying it from a PodGroupTemplate. One of Pod, PodGroup. Defaults to Pod if unset. This field is immutable. This field is available only when the WorkloadAwarePreemption feature gate is enabled.

Declaration
[JsonPropertyName("disruptionMode")]
public string DisruptionMode { get; set; }
Property Value
Type Description
string

EqualityContract

Declaration
protected virtual Type EqualityContract { get; }
Property Value
Type Description
Type

PodGroupTemplateRef

PodGroupTemplateRef references an optional PodGroup template within other object (e.g. Workload) that was used to create the PodGroup. This field is immutable.

Declaration
[JsonPropertyName("podGroupTemplateRef")]
public V1alpha2PodGroupTemplateReference PodGroupTemplateRef { get; set; }
Property Value
Type Description
V1alpha2PodGroupTemplateReference

Priority

Priority is the value of priority of this pod group. Various system components use this field to find the priority of the pod group. When Priority Admission Controller is enabled, it prevents users from setting this field. The admission controller populates this field from PriorityClassName. The higher the value, the higher the priority. This field is immutable. This field is available only when the WorkloadAwarePreemption feature gate is enabled.

Declaration
[JsonPropertyName("priority")]
public int? Priority { get; set; }
Property Value
Type Description
int?

PriorityClassName

PriorityClassName defines the priority that should be considered when scheduling this pod group. Controllers are expected to fill this field by copying it from a PodGroupTemplate. Otherwise, it is validated and resolved similarly to the PriorityClassName on PodGroupTemplate (i.e. if no priority class is specified, admission control can set this to the global default priority class if it exists. Otherwise, the pod group's priority will be zero). This field is immutable. This field is available only when the WorkloadAwarePreemption feature gate is enabled.

Declaration
[JsonPropertyName("priorityClassName")]
public string PriorityClassName { get; set; }
Property Value
Type Description
string

ResourceClaims

ResourceClaims defines which ResourceClaims may be shared among Pods in the group. Pods consume the devices allocated to a PodGroup's claim by defining a claim in its own Spec.ResourceClaims that matches the PodGroup's claim exactly. The claim must have the same name and refer to the same ResourceClaim or ResourceClaimTemplate.

This is an alpha-level field and requires that the DRAWorkloadResourceClaims feature gate is enabled.

This field is immutable.

Declaration
[JsonPropertyName("resourceClaims")]
public IList<V1alpha2PodGroupResourceClaim> ResourceClaims { get; set; }
Property Value
Type Description
IList<V1alpha2PodGroupResourceClaim>

SchedulingConstraints

SchedulingConstraints defines optional scheduling constraints (e.g. topology) for this PodGroup. Controllers are expected to fill this field by copying it from a PodGroupTemplate. This field is immutable. This field is only available when the TopologyAwareWorkloadScheduling feature gate is enabled.

Declaration
[JsonPropertyName("schedulingConstraints")]
public V1alpha2PodGroupSchedulingConstraints SchedulingConstraints { get; set; }
Property Value
Type Description
V1alpha2PodGroupSchedulingConstraints

SchedulingPolicy

SchedulingPolicy defines the scheduling policy for this instance of the PodGroup. Controllers are expected to fill this field by copying it from a PodGroupTemplate. This field is immutable.

Declaration
[JsonPropertyName("schedulingPolicy")]
public V1alpha2PodGroupSchedulingPolicy SchedulingPolicy { get; set; }
Property Value
Type Description
V1alpha2PodGroupSchedulingPolicy

Methods

Equals(object?)

Declaration
public override bool Equals(object? obj)
Parameters
Type Name Description
object obj
Returns
Type Description
bool
Overrides
object.Equals(object)

Equals(V1alpha2PodGroupSpec?)

Declaration
public virtual bool Equals(V1alpha2PodGroupSpec? other)
Parameters
Type Name Description
V1alpha2PodGroupSpec other
Returns
Type Description
bool

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
int
Overrides
object.GetHashCode()

PrintMembers(StringBuilder)

Declaration
protected virtual bool PrintMembers(StringBuilder builder)
Parameters
Type Name Description
StringBuilder builder
Returns
Type Description
bool

ToString()

Declaration
public override string ToString()
Returns
Type Description
string
Overrides
object.ToString()

Operators

operator ==(V1alpha2PodGroupSpec?, V1alpha2PodGroupSpec?)

Declaration
public static bool operator ==(V1alpha2PodGroupSpec? left, V1alpha2PodGroupSpec? right)
Parameters
Type Name Description
V1alpha2PodGroupSpec left
V1alpha2PodGroupSpec right
Returns
Type Description
bool

operator !=(V1alpha2PodGroupSpec?, V1alpha2PodGroupSpec?)

Declaration
public static bool operator !=(V1alpha2PodGroupSpec? left, V1alpha2PodGroupSpec? right)
Parameters
Type Name Description
V1alpha2PodGroupSpec left
V1alpha2PodGroupSpec right
Returns
Type Description
bool

Implements

IEquatable<T>
In this article
Back to top Generated by DocFX