Show / Hide Table of Contents

Class V1ParamRef

ParamRef describes how to locate the params to be used as input to expressions of rules applied by a policy binding.

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

Constructors

View Source

V1ParamRef()

Declaration
public V1ParamRef()
View Source

V1ParamRef(V1ParamRef)

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

Properties

View Source

EqualityContract

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

Name

name is the name of the resource being referenced.

One of name or selector must be set, but name and selector are mutually exclusive properties. If one is set, the other must be unset.

A single parameter used for all admission requests can be configured by setting the name field, leaving selector blank, and setting namespace if paramKind is namespace-scoped.

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

NamespaceProperty

namespace is the namespace of the referenced resource. Allows limiting the search for params to a specific namespace. Applies to both name and selector fields.

A per-namespace parameter may be used by specifying a namespace-scoped paramKind in the policy and leaving this field empty.

  • If paramKind is cluster-scoped, this field MUST be unset. Setting this field results in a configuration error.

  • If paramKind is namespace-scoped, the namespace of the object being evaluated for admission will be used when this field is left unset. Take care that if this is left empty the binding must not match any cluster-scoped resources, which will result in an error.

Declaration
[JsonPropertyName("namespace")]
public string NamespaceProperty { get; set; }
Property Value
Type Description
string
View Source

ParameterNotFoundAction

parameterNotFoundAction controls the behavior of the binding when the resource exists, and name or selector is valid, but there are no parameters matched by the binding. If the value is set to Allow, then no matched parameters will be treated as successful validation by the binding. If set to Deny, then no matched parameters will be subject to the failurePolicy of the policy.

Allowed values are Allow or Deny

Required

Declaration
[JsonPropertyName("parameterNotFoundAction")]
public string ParameterNotFoundAction { get; set; }
Property Value
Type Description
string
View Source

Selector

selector can be used to match multiple param objects based on their labels. Supply selector: {} to match all resources of the ParamKind.

If multiple params are found, they are all evaluated with the policy expressions and the results are ANDed together.

One of name or selector must be set, but name and selector are mutually exclusive properties. If one is set, the other must be unset.

Declaration
[JsonPropertyName("selector")]
public V1LabelSelector Selector { get; set; }
Property Value
Type Description
V1LabelSelector

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

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

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

operator !=(V1ParamRef?, V1ParamRef?)

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

Implements

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