Show / Hide Table of Contents

Class V1alpha3PodGroupSpec

PodGroupSpec defines the desired state of a PodGroup.

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

Constructors

V1alpha3PodGroupSpec()

Declaration
public V1alpha3PodGroupSpec()

V1alpha3PodGroupSpec(V1alpha3PodGroupSpec)

Declaration
protected V1alpha3PodGroupSpec(V1alpha3PodGroupSpec original)
Parameters
Type Name Description
V1alpha3PodGroupSpec 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 Single, All. Defaults to Single if unset. This field is immutable.

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

EqualityContract

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

ParentCompositePodGroupName

parentCompositePodGroupName contains the name of the parent composite pod group within the same namespace as this pod group. If it's nil, then this pod group is a root of a workload's hierarchy. This field is used only when the CompositePodGroup feature gate is enabled. This field is immutable.

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

PreemptionPolicy

preemptionPolicy is the Policy for preempting pods/podgroups with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. When Priority Admission Controller is enabled, it populates this field from PriorityClassName, and defaults to PreemptLowerPriority if value is unset in PriorityClass. This field is immutable. This field is available only when the PodGroupPreemptionPolicy feature gate is enabled.

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

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.

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.

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 a beta-level field and requires that the DRAWorkloadResourceClaims feature gate is enabled.

This field is immutable.

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

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 V1alpha3PodGroupSchedulingConstraints SchedulingConstraints { get; set; }
Property Value
Type Description
V1alpha3PodGroupSchedulingConstraints

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.

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

WorkloadRef

workloadRef references an optional PodGroup template within the Workload object that was used to create the PodGroup. This field is immutable.

Declaration
[JsonPropertyName("workloadRef")]
public V1alpha3WorkloadReference WorkloadRef { get; set; }
Property Value
Type Description
V1alpha3WorkloadReference

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(V1alpha3PodGroupSpec?)

Declaration
public virtual bool Equals(V1alpha3PodGroupSpec? other)
Parameters
Type Name Description
V1alpha3PodGroupSpec 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 ==(V1alpha3PodGroupSpec?, V1alpha3PodGroupSpec?)

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

operator !=(V1alpha3PodGroupSpec?, V1alpha3PodGroupSpec?)

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

Implements

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