Show / Hide Table of Contents

Class V1alpha3CompositePodGroupTemplate

CompositePodGroupTemplate represents a template for a CompositePodGroup with a scheduling policy.

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

Constructors

V1alpha3CompositePodGroupTemplate()

Declaration
public V1alpha3CompositePodGroupTemplate()

V1alpha3CompositePodGroupTemplate(V1alpha3CompositePodGroupTemplate)

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

Properties

CompositePodGroupTemplates

compositePodGroupTemplates is the list of templates for children CompositePodGroups. The maximum number of templates is 8. At least one entry in CompositePodGroupTemplates or PodGroupTemplates must be set.

Declaration
[JsonPropertyName("compositePodGroupTemplates")]
public IList<V1alpha3CompositePodGroupTemplate> CompositePodGroupTemplates { get; set; }
Property Value
Type Description
IList<V1alpha3CompositePodGroupTemplate>

DisruptionMode

disruptionMode defines the mode in which a given CompositePodGroup can be disrupted. One of Single, All. This field is immutable.

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

EqualityContract

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

Name

name is a unique identifier for the CompositePodGroupTemplate within the Workload. It must be a DNS label. This field is required.

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

PodGroupTemplates

podGroupTemplates is the list of templates for children PodGroups. The maximum number of templates is 8. At least one entry in CompositePodGroupTemplates or PodGroupTemplates must be set.

Declaration
[JsonPropertyName("podGroupTemplates")]
public IList<V1alpha3PodGroupTemplate> PodGroupTemplates { get; set; }
Property Value
Type Description
IList<V1alpha3PodGroupTemplate>

PreemptionPolicy

preemptionPolicy is the Policy for preempting pods/podgroups with lower priority. One of Never, PreemptLowerPriority. 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 composite pod groups created from this template. Various system components use this field to find the priority of the composite 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 indicates the priority that should be considered when scheduling a composite pod group created from this template. If no priority class is specified, admission control can set this to the global default priority class if it exists. Otherwise, composite pod groups created from this template will have the priority set to zero. This field is immutable.

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

SchedulingConstraints

schedulingConstraints defines optional scheduling constraints (e.g. topology) for this CompositePodGroupTemplate. This field is immutable.

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

SchedulingPolicy

schedulingPolicy defines the scheduling policy for this template.

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

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

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

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

operator !=(V1alpha3CompositePodGroupTemplate?, V1alpha3CompositePodGroupTemplate?)

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

Implements

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