Class JSONSchemaProps

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

Inheritance

System.Object

JSONSchemaProps

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Kubernetes.Types.Outputs.ApiExtensions.V1

Assembly: Pulumi.Kubernetes.dll

Syntax

public sealed class JSONSchemaProps

Fields

AdditionalItems

Declaration

public readonly Union<JSONSchemaProps, bool> AdditionalItems

Field Value

Type	Description
Union<JSONSchemaProps, System.Boolean>

AdditionalProperties

Declaration

public readonly Union<JSONSchemaProps, bool> AdditionalProperties

Field Value

Type	Description
Union<JSONSchemaProps, System.Boolean>

AllOf

Declaration

public readonly ImmutableArray<JSONSchemaProps> AllOf

Field Value

Type	Description
System.Collections.Immutable.ImmutableArray<JSONSchemaProps>

AnyOf

Declaration

public readonly ImmutableArray<JSONSchemaProps> AnyOf

Field Value

Type	Description
System.Collections.Immutable.ImmutableArray<JSONSchemaProps>

Default

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

public readonly Json.JsonElement Default

Field Value

Type	Description
System.Text.Json.JsonElement

Definitions

Declaration

public readonly ImmutableDictionary<string, JSONSchemaProps> Definitions

Field Value

Type	Description
System.Collections.Immutable.ImmutableDictionary<System.String, JSONSchemaProps>

Dependencies

Declaration

public readonly ImmutableDictionary<string, Union<JSONSchemaProps, ImmutableArray<string>>> Dependencies

Field Value

Type	Description
System.Collections.Immutable.ImmutableDictionary<System.String, Union<JSONSchemaProps, System.Collections.Immutable.ImmutableArray<System.String>>>

Description

Declaration

public readonly string Description

Field Value

Type	Description
System.String

Enum

Declaration

public readonly ImmutableArray<Json.JsonElement> Enum

Field Value

Type	Description
System.Collections.Immutable.ImmutableArray<System.Text.Json.JsonElement>

Example

Declaration

public readonly Json.JsonElement Example

Field Value

Type	Description
System.Text.Json.JsonElement

ExclusiveMaximum

Declaration

public readonly bool ExclusiveMaximum

Field Value

Type	Description
System.Boolean

ExclusiveMinimum

Declaration

public readonly bool ExclusiveMinimum

Field Value

Type	Description
System.Boolean

ExternalDocs

Declaration

public readonly ExternalDocumentation ExternalDocs

Field Value

Type	Description
ExternalDocumentation

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

public readonly string Format

Field Value

Type	Description
System.String

Id

Declaration

public readonly string Id

Field Value

Type	Description
System.String

Items

Declaration

public readonly Union<JSONSchemaProps, ImmutableArray<string>> Items

Field Value

Type	Description
Union<JSONSchemaProps, System.Collections.Immutable.ImmutableArray<System.String>>

Maximum

Declaration

public readonly double Maximum

Field Value

Type	Description
System.Double

MaxItems

Declaration

public readonly int MaxItems

Field Value

Type	Description
System.Int32

MaxLength

Declaration

public readonly int MaxLength

Field Value

Type	Description
System.Int32

MaxProperties

Declaration

public readonly int MaxProperties

Field Value

Type	Description
System.Int32

Minimum

Declaration

public readonly double Minimum

Field Value

Type	Description
System.Double

MinItems

Declaration

public readonly int MinItems

Field Value

Type	Description
System.Int32

MinLength

Declaration

public readonly int MinLength

Field Value

Type	Description
System.Int32

MinProperties

Declaration

public readonly int MinProperties

Field Value

Type	Description
System.Int32

MultipleOf

Declaration

public readonly double MultipleOf

Field Value

Type	Description
System.Double

Not

Declaration

public readonly JSONSchemaProps Not

Field Value

Type	Description
JSONSchemaProps

Nullable

Declaration

public readonly bool Nullable

Field Value

Type	Description
System.Boolean

OneOf

Declaration

public readonly ImmutableArray<JSONSchemaProps> OneOf

Field Value

Type	Description
System.Collections.Immutable.ImmutableArray<JSONSchemaProps>

Pattern

Declaration

public readonly string Pattern

Field Value

Type	Description
System.String

PatternProperties

Declaration

public readonly ImmutableDictionary<string, JSONSchemaProps> PatternProperties

Field Value

Type	Description
System.Collections.Immutable.ImmutableDictionary<System.String, JSONSchemaProps>

Properties

Declaration

public readonly ImmutableDictionary<string, JSONSchemaProps> Properties

Field Value

Type	Description
System.Collections.Immutable.ImmutableDictionary<System.String, JSONSchemaProps>

Ref

Declaration

public readonly string Ref

Field Value

Type	Description
System.String

Required

Declaration

public readonly ImmutableArray<string> Required

Field Value

Type	Description
System.Collections.Immutable.ImmutableArray<System.String>

Schema

Declaration

public readonly string Schema

Field Value

Type	Description
System.String

Title

Declaration

public readonly string Title

Field Value

Type	Description
System.String

Type

Declaration

public readonly string Type

Field Value

Type	Description
System.String

UniqueItems

Declaration

public readonly bool UniqueItems

Field Value

Type	Description
System.Boolean

X_kubernetes_embedded_resource

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

public readonly bool X_kubernetes_embedded_resource

Field Value

Type	Description
System.Boolean

X_kubernetes_int_or_string

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

2. allOf:

• anyOf:
• type: integer
• type: string
• ... zero or more

Declaration

public readonly bool X_kubernetes_int_or_string

Field Value

Type	Description
System.Boolean

X_kubernetes_list_map_keys

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

public readonly ImmutableArray<string> X_kubernetes_list_map_keys

Field Value

Type	Description
System.Collections.Immutable.ImmutableArray<System.String>

X_kubernetes_list_type

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

public readonly string X_kubernetes_list_type

Field Value

Type	Description
System.String

X_kubernetes_map_type

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

public readonly string X_kubernetes_map_type

Field Value

Type	Description
System.String

X_kubernetes_preserve_unknown_fields

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

public readonly bool X_kubernetes_preserve_unknown_fields

Field Value

Type	Description
System.Boolean