Struct cluster_api_rs::api::capi_clusterclass::ClusterClassStatusVariablesDefinitionsSchemaOpenApiv3Schema

pub struct ClusterClassStatusVariablesDefinitionsSchemaOpenApiv3Schema {

    pub additional_properties: Option<Value>,
    pub default: Option<Value>,
    pub description: Option<String>,
    pub enum: Option<Vec<BTreeMap<String, Value>>>,
    pub example: Option<Value>,
    pub exclusive_maximum: Option<bool>,
    pub exclusive_minimum: Option<bool>,
    pub format: Option<String>,
    pub items: Option<Value>,
    pub max_items: Option<i64>,
    pub max_length: Option<i64>,
    pub max_properties: Option<i64>,
    pub maximum: Option<i64>,
    pub min_items: Option<i64>,
    pub min_length: Option<i64>,
    pub min_properties: Option<i64>,
    pub minimum: Option<i64>,
    pub pattern: Option<String>,
    pub properties: Option<Value>,
    pub required: Option<Vec<String>>,
    pub type: String,
    pub unique_items: Option<bool>,
    pub x_kubernetes_preserve_unknown_fields: Option<bool>,
    pub x_kubernetes_validations: Option<Vec<ClusterClassStatusVariablesDefinitionsSchemaOpenApiv3SchemaXKubernetesValidations>>,
    pub x_metadata: Option<ClusterClassStatusVariablesDefinitionsSchemaOpenApiv3SchemaXMetadata>,
}

OpenAPIV3Schema defines the schema of a variable via OpenAPI v3 schema. The schema is a subset of the schema used in Kubernetes CRDs.

Fields

additional_properties: Option<Value>

AdditionalProperties specifies the schema of values in a map (keys are always strings). NOTE: Can only be set if type is object. NOTE: AdditionalProperties is mutually exclusive with Properties. NOTE: This field uses PreserveUnknownFields and Schemaless, because recursive validation is not possible.

default: Option<Value>

Default is the default value of the variable. NOTE: Can be set for all types.

description: Option<String>

Description is a human-readable description of this variable.

enum: Option<Vec<BTreeMap<String, Value>>>

Enum is the list of valid values of the variable. NOTE: Can be set for all types.

example: Option<Value>

Example is an example for this variable.

exclusive_maximum: Option<bool>

ExclusiveMaximum specifies if the Maximum is exclusive. NOTE: Can only be set if type is integer or number.

exclusive_minimum: Option<bool>

ExclusiveMinimum specifies if the Minimum is exclusive. NOTE: Can only be set if type is integer or number.

format: Option<String>

Format is an OpenAPI v3 format string. Unknown formats are ignored. For a list of supported formats please see: (of the k8s.io/apiextensions-apiserver version we’re currently using) https://github.com/kubernetes/apiextensions-apiserver/blob/master/pkg/apiserver/validation/formats.go NOTE: Can only be set if type is string.

items: Option<Value>

Items specifies fields of an array. NOTE: Can only be set if type is array. NOTE: This field uses PreserveUnknownFields and Schemaless, because recursive validation is not possible.

max_items: Option<i64>

MaxItems is the max length of an array variable. NOTE: Can only be set if type is array.

max_length: Option<i64>

MaxLength is the max length of a string variable. NOTE: Can only be set if type is string.

max_properties: Option<i64>

MaxProperties is the maximum amount of entries in a map or properties in an object. NOTE: Can only be set if type is object.

maximum: Option<i64>

Maximum is the maximum of an integer or number variable. If ExclusiveMaximum is false, the variable is valid if it is lower than, or equal to, the value of Maximum. If ExclusiveMaximum is true, the variable is valid if it is strictly lower than the value of Maximum. NOTE: Can only be set if type is integer or number.

min_items: Option<i64>

MinItems is the min length of an array variable. NOTE: Can only be set if type is array.

min_length: Option<i64>

MinLength is the min length of a string variable. NOTE: Can only be set if type is string.

min_properties: Option<i64>

MinProperties is the minimum amount of entries in a map or properties in an object. NOTE: Can only be set if type is object.

minimum: Option<i64>

Minimum is the minimum of an integer or number variable. If ExclusiveMinimum is false, the variable is valid if it is greater than, or equal to, the value of Minimum. If ExclusiveMinimum is true, the variable is valid if it is strictly greater than the value of Minimum. NOTE: Can only be set if type is integer or number.

pattern: Option<String>

Pattern is the regex which a string variable must match. NOTE: Can only be set if type is string.

properties: Option<Value>

Properties specifies fields of an object. NOTE: Can only be set if type is object. NOTE: Properties is mutually exclusive with AdditionalProperties. NOTE: This field uses PreserveUnknownFields and Schemaless, because recursive validation is not possible.

required: Option<Vec<String>>

Required specifies which fields of an object are required. NOTE: Can only be set if type is object.

type: String

Type is the type of the variable. Valid values are: object, array, string, integer, number or boolean.

unique_items: Option<bool>

UniqueItems specifies if items in an array must be unique. NOTE: Can only be set if type is array.

x_kubernetes_preserve_unknown_fields: Option<bool>

XPreserveUnknownFields allows setting fields in a variable object which are not defined in the variable schema. This affects fields recursively, except if nested properties or additionalProperties are specified in the schema.

x_kubernetes_validations: Option<Vec<ClusterClassStatusVariablesDefinitionsSchemaOpenApiv3SchemaXKubernetesValidations>>

XValidations describes a list of validation rules written in the CEL expression language.

x_metadata: Option<ClusterClassStatusVariablesDefinitionsSchemaOpenApiv3SchemaXMetadata>

XMetadata is the metadata of a variable or a nested field within a variable. It can be used to add additional data for higher level tools.

Trait Implementations

impl Clone for ClusterClassStatusVariablesDefinitionsSchemaOpenApiv3Schema

fn clone(&self) -> ClusterClassStatusVariablesDefinitionsSchemaOpenApiv3Schema

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ClusterClassStatusVariablesDefinitionsSchemaOpenApiv3Schema

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ClusterClassStatusVariablesDefinitionsSchemaOpenApiv3Schema

fn default() -> ClusterClassStatusVariablesDefinitionsSchemaOpenApiv3Schema

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ClusterClassStatusVariablesDefinitionsSchemaOpenApiv3Schema

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for ClusterClassStatusVariablesDefinitionsSchemaOpenApiv3Schema

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Serialize for ClusterClassStatusVariablesDefinitionsSchemaOpenApiv3Schema

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.