Show / Hide Table of Contents

Class V1SuccessPolicyRule

SuccessPolicyRule describes rule for declaring a Job as succeeded. Each rule must have at least one of the "succeededIndexes" or "succeededCount" specified.

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

Constructors

View Source

V1SuccessPolicyRule()

Declaration
public V1SuccessPolicyRule()
View Source

V1SuccessPolicyRule(V1SuccessPolicyRule)

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

Properties

View Source

EqualityContract

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

SucceededCount

succeededCount specifies the minimal required size of the actual set of the succeeded indexes for the Job. When succeededCount is used along with succeededIndexes, the check is constrained only to the set of indexes specified by succeededIndexes. For example, given that succeededIndexes is "1-4", succeededCount is "3", and completed indexes are "1", "3", and "5", the Job isn't declared as succeeded because only "1" and "3" indexes are considered in that rules. When this field is null, this doesn't default to any value and is never evaluated at any time. When specified it needs to be a positive integer.

Declaration
[JsonPropertyName("succeededCount")]
public int? SucceededCount { get; set; }
Property Value
Type Description
int?
View Source

SucceededIndexes

succeededIndexes specifies the set of indexes which need to be contained in the actual set of the succeeded indexes for the Job. The list of indexes must be within 0 to ".spec.completions-1" and must not contain duplicates. At least one element is required. The indexes are represented as intervals separated by commas. The intervals can be a decimal integer or a pair of decimal integers separated by a hyphen. The number are listed in represented by the first and last element of the series, separated by a hyphen. For example, if the completed indexes are 1, 3, 4, 5 and 7, they are represented as "1,3-5,7". When this field is null, this field doesn't default to any value and is never evaluated at any time.

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

Methods

View Source

Equals(object?)

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

Equals(V1SuccessPolicyRule?)

Declaration
public virtual bool Equals(V1SuccessPolicyRule? other)
Parameters
Type Name Description
V1SuccessPolicyRule other
Returns
Type Description
bool
View Source

GetHashCode()

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

PrintMembers(StringBuilder)

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

ToString()

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

Operators

View Source

operator ==(V1SuccessPolicyRule?, V1SuccessPolicyRule?)

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

operator !=(V1SuccessPolicyRule?, V1SuccessPolicyRule?)

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

Implements

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