Show / Hide Table of Contents

Class V1JSONSchemaProps

JSONSchemaProps is a JSON-Schema following Specification Draft 4 (http://json-schema.org/).

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

Constructors

V1JSONSchemaProps()

Declaration
public V1JSONSchemaProps()

V1JSONSchemaProps(V1JSONSchemaProps)

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

Properties

AdditionalItems

JSONSchemaPropsOrBool represents JSONSchemaProps or a boolean value. Defaults to true for the boolean property.

Declaration
[JsonPropertyName("additionalItems")]
public object AdditionalItems { get; set; }
Property Value
Type Description
object

AdditionalProperties

JSONSchemaPropsOrBool represents JSONSchemaProps or a boolean value. Defaults to true for the boolean property.

Declaration
[JsonPropertyName("additionalProperties")]
public object AdditionalProperties { get; set; }
Property Value
Type Description
object

AllOf

Declaration
[JsonPropertyName("allOf")]
public IList<V1JSONSchemaProps> AllOf { get; set; }
Property Value
Type Description
IList<V1JSONSchemaProps>

AnyOf

Declaration
[JsonPropertyName("anyOf")]
public IList<V1JSONSchemaProps> AnyOf { get; set; }
Property Value
Type Description
IList<V1JSONSchemaProps>

DefaultProperty

default is a default value for undefined object fields. Defaulting is a beta feature under the CustomResourceDefaulting feature gate. Defaulting requires spec.preserveUnknownFields to be false.

Declaration
[JsonPropertyName("default")]
public object DefaultProperty { get; set; }
Property Value
Type Description
object

Definitions

Declaration
[JsonPropertyName("definitions")]
public IDictionary<string, V1JSONSchemaProps> Definitions { get; set; }
Property Value
Type Description
IDictionary<string, V1JSONSchemaProps>

Dependencies

Declaration
[JsonPropertyName("dependencies")]
public IDictionary<string, object> Dependencies { get; set; }
Property Value
Type Description
IDictionary<string, object>

Description

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

EnumProperty

Declaration
[JsonPropertyName("enum")]
public IList<object> EnumProperty { get; set; }
Property Value
Type Description
IList<object>

EqualityContract

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

Example

JSON represents any valid JSON value. These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.

Declaration
[JsonPropertyName("example")]
public object Example { get; set; }
Property Value
Type Description
object

ExclusiveMaximum

Declaration
[JsonPropertyName("exclusiveMaximum")]
public bool? ExclusiveMaximum { get; set; }
Property Value
Type Description
bool?

ExclusiveMinimum

Declaration
[JsonPropertyName("exclusiveMinimum")]
public bool? ExclusiveMinimum { get; set; }
Property Value
Type Description
bool?

ExternalDocs

Declaration
[JsonPropertyName("externalDocs")]
public V1ExternalDocumentation ExternalDocs { get; set; }
Property Value
Type Description
V1ExternalDocumentation

Format

format is an OpenAPI v3 format string. Unknown formats are ignored. The following formats are validated:

  • bsonobjectid: a bson object ID, i.e. a 24 characters hex string - uri: an URI as parsed by Golang net/url.ParseRequestURI - email: an email address as parsed by Golang net/mail.ParseAddress - hostname: a valid representation for an Internet host name, as defined by RFC 1034, section 3.1 [RFC1034]. - ipv4: an IPv4 IP as parsed by Golang net.ParseIP - ipv6: an IPv6 IP as parsed by Golang net.ParseIP - cidr: a CIDR as parsed by Golang net.ParseCIDR - mac: a MAC address as parsed by Golang net.ParseMAC - uuid: an UUID that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$ - uuid3: an UUID3 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$ - uuid4: an UUID4 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ - uuid5: an UUID5 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ - isbn: an ISBN10 or ISBN13 number string like "0321751043" or "978-0321751041" - isbn10: an ISBN10 number string like "0321751043" - isbn13: an ISBN13 number string like "978-0321751041" - creditcard: a credit card number defined by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\d{3})\d{11})$ with any non digit characters mixed in - ssn: a U.S. social security number following the regex ^\d{3}[- ]?\d{2}[- ]?\d{4}$ - hexcolor: an hexadecimal color code like "#FFFFFF: following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ - rgbcolor: an RGB color code like rgb like "rgb(255,255,2559" - byte: base64 encoded binary data - password: any kind of string - date: a date string like "2006-01-02" as defined by full-date in RFC3339 - duration: a duration string like "22 ns" as parsed by Golang time.ParseDuration or compatible with Scala duration format - datetime: a date time string like "2014-12-15T19:30:20.000Z" as defined by date-time in RFC3339.
Declaration
[JsonPropertyName("format")]
public string Format { get; set; }
Property Value
Type Description
string

Id

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

Items

JSONSchemaPropsOrArray represents a value that can either be a JSONSchemaProps or an array of JSONSchemaProps. Mainly here for serialization purposes.

Declaration
[JsonPropertyName("items")]
public object Items { get; set; }
Property Value
Type Description
object

MaxItems

Declaration
[JsonPropertyName("maxItems")]
public long? MaxItems { get; set; }
Property Value
Type Description
long?

MaxLength

Declaration
[JsonPropertyName("maxLength")]
public long? MaxLength { get; set; }
Property Value
Type Description
long?

MaxProperties

Declaration
[JsonPropertyName("maxProperties")]
public long? MaxProperties { get; set; }
Property Value
Type Description
long?

Maximum

Declaration
[JsonPropertyName("maximum")]
public double? Maximum { get; set; }
Property Value
Type Description
double?

MinItems

Declaration
[JsonPropertyName("minItems")]
public long? MinItems { get; set; }
Property Value
Type Description
long?

MinLength

Declaration
[JsonPropertyName("minLength")]
public long? MinLength { get; set; }
Property Value
Type Description
long?

MinProperties

Declaration
[JsonPropertyName("minProperties")]
public long? MinProperties { get; set; }
Property Value
Type Description
long?

Minimum

Declaration
[JsonPropertyName("minimum")]
public double? Minimum { get; set; }
Property Value
Type Description
double?

MultipleOf

Declaration
[JsonPropertyName("multipleOf")]
public double? MultipleOf { get; set; }
Property Value
Type Description
double?

Not

Declaration
[JsonPropertyName("not")]
public V1JSONSchemaProps Not { get; set; }
Property Value
Type Description
V1JSONSchemaProps

Nullable

Declaration
[JsonPropertyName("nullable")]
public bool? Nullable { get; set; }
Property Value
Type Description
bool?

OneOf

Declaration
[JsonPropertyName("oneOf")]
public IList<V1JSONSchemaProps> OneOf { get; set; }
Property Value
Type Description
IList<V1JSONSchemaProps>

Pattern

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

PatternProperties

Declaration
[JsonPropertyName("patternProperties")]
public IDictionary<string, V1JSONSchemaProps> PatternProperties { get; set; }
Property Value
Type Description
IDictionary<string, V1JSONSchemaProps>

Properties

Declaration
[JsonPropertyName("properties")]
public IDictionary<string, V1JSONSchemaProps> Properties { get; set; }
Property Value
Type Description
IDictionary<string, V1JSONSchemaProps>

RefProperty

Declaration
[JsonPropertyName("$ref")]
public string RefProperty { get; set; }
Property Value
Type Description
string

Required

Declaration
[JsonPropertyName("required")]
public IList<string> Required { get; set; }
Property Value
Type Description
IList<string>

Schema

Declaration
[JsonPropertyName("$schema")]
public string Schema { get; set; }
Property Value
Type Description
string

Title

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

Type

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

UniqueItems

Declaration
[JsonPropertyName("uniqueItems")]
public bool? UniqueItems { get; set; }
Property Value
Type Description
bool?

XKubernetesEmbeddedResource

x-kubernetes-embedded-resource defines that the value is an embedded Kubernetes runtime.Object, with TypeMeta and ObjectMeta. The type must be object. It is allowed to further restrict the embedded object. kind, apiVersion and metadata are validated automatically. x-kubernetes-preserve-unknown-fields is allowed to be true, but does not have to be if the object is fully specified (up to kind, apiVersion, metadata).

Declaration
[JsonPropertyName("x-kubernetes-embedded-resource")]
public bool? XKubernetesEmbeddedResource { get; set; }
Property Value
Type Description
bool?

XKubernetesIntOrString

x-kubernetes-int-or-string specifies that this value is either an integer or a string. If this is true, an empty type is allowed and type as child of anyOf is permitted if following one of the following patterns:

  1. anyOf:
  • type: integer
  • type: string
  1. allOf:
  • anyOf:
  • type: integer
  • type: string
  • ... zero or more
Declaration
[JsonPropertyName("x-kubernetes-int-or-string")]
public bool? XKubernetesIntOrString { get; set; }
Property Value
Type Description
bool?

XKubernetesListMapKeys

x-kubernetes-list-map-keys annotates an array with the x-kubernetes-list-type map by specifying the keys used as the index of the map.

This tag MUST only be used on lists that have the "x-kubernetes-list-type" extension set to "map". Also, the values specified for this attribute must be a scalar typed field of the child structure (no nesting is supported).

The properties specified must either be required or have a default value, to ensure those properties are present for all list items.

Declaration
[JsonPropertyName("x-kubernetes-list-map-keys")]
public IList<string> XKubernetesListMapKeys { get; set; }
Property Value
Type Description
IList<string>

XKubernetesListType

x-kubernetes-list-type annotates an array to further describe its topology. This extension must only be used on lists and may have 3 possible values:

  1. atomic: the list is treated as a single entity, like a scalar. Atomic lists will be entirely replaced when updated. This extension may be used on any type of list (struct, scalar, ...).
  2. set: Sets are lists that must not have multiple items with the same value. Each value must be a scalar, an object with x-kubernetes-map-type atomic or an array with x-kubernetes-list-type atomic.
  3. map: These lists are like maps in that their elements have a non-index key used to identify them. Order is preserved upon merge. The map tag must only be used on a list with elements of type object. Defaults to atomic for arrays.
Declaration
[JsonPropertyName("x-kubernetes-list-type")]
public string XKubernetesListType { get; set; }
Property Value
Type Description
string

XKubernetesMapType

x-kubernetes-map-type annotates an object to further describe its topology. This extension must only be used when type is object and may have 2 possible values:

  1. granular: These maps are actual maps (key-value pairs) and each fields are independent from each other (they can each be manipulated by separate actors). This is the default behaviour for all maps.
  2. atomic: the list is treated as a single entity, like a scalar. Atomic maps will be entirely replaced when updated.
Declaration
[JsonPropertyName("x-kubernetes-map-type")]
public string XKubernetesMapType { get; set; }
Property Value
Type Description
string

XKubernetesPreserveUnknownFields

x-kubernetes-preserve-unknown-fields stops the API server decoding step from pruning fields which are not specified in the validation schema. This affects fields recursively, but switches back to normal pruning behaviour if nested properties or additionalProperties are specified in the schema. This can either be true or undefined. False is forbidden.

Declaration
[JsonPropertyName("x-kubernetes-preserve-unknown-fields")]
public bool? XKubernetesPreserveUnknownFields { get; set; }
Property Value
Type Description
bool?

XKubernetesValidations

x-kubernetes-validations describes a list of validation rules written in the CEL expression language.

Declaration
[JsonPropertyName("x-kubernetes-validations")]
public IList<V1ValidationRule> XKubernetesValidations { get; set; }
Property Value
Type Description
IList<V1ValidationRule>

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

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

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

operator !=(V1JSONSchemaProps?, V1JSONSchemaProps?)

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

Implements

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