Show / Hide Table of Contents

Class V1AuditAnnotation

AuditAnnotation describes how to produce an audit annotation for an API request.

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

Constructors

View Source

V1AuditAnnotation()

Declaration
public V1AuditAnnotation()
View Source

V1AuditAnnotation(V1AuditAnnotation)

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

Properties

View Source

EqualityContract

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

Key

key specifies the audit annotation key. The audit annotation keys of a ValidatingAdmissionPolicy must be unique. The key must be a qualified name ([A-Za-z0-9][-A-Za-z0-9_.]*) no more than 63 bytes in length.

The key is combined with the resource name of the ValidatingAdmissionPolicy to construct an audit annotation key: "{ValidatingAdmissionPolicy name}/{key}".

If an admission webhook uses the same resource name as this ValidatingAdmissionPolicy and the same audit annotation key, the annotation key will be identical. In this case, the first annotation written with the key will be included in the audit event and all subsequent annotations with the same key will be discarded.

Required.

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

ValueExpression

valueExpression represents the expression which is evaluated by CEL to produce an audit annotation value. The expression must evaluate to either a string or null value. If the expression evaluates to a string, the audit annotation is included with the string value. If the expression evaluates to null or empty string the audit annotation will be omitted. The valueExpression may be no longer than 5kb in length. If the result of the valueExpression is more than 10kb in length, it will be truncated to 10kb.

If multiple ValidatingAdmissionPolicyBinding resources match an API request, then the valueExpression will be evaluated for each binding. All unique values produced by the valueExpressions will be joined together in a comma-separated list.

Required.

Declaration
[JsonPropertyName("valueExpression")]
public string ValueExpression { 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(V1AuditAnnotation?)

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

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

operator !=(V1AuditAnnotation?, V1AuditAnnotation?)

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

Implements

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