kubernetes_asyncio.client.models.v1_json_schema_props module

Kubernetes

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501

The version of the OpenAPI document: v1.34.3 Generated by: https://openapi-generator.tech

class kubernetes_asyncio.client.models.v1_json_schema_props.V1JSONSchemaProps(ref=None, schema=None, additional_items=None, additional_properties=None, all_of=None, any_of=None, default=None, definitions=None, dependencies=None, description=None, enum=None, example=None, exclusive_maximum=None, exclusive_minimum=None, external_docs=None, format=None, id=None, items=None, max_items=None, max_length=None, max_properties=None, maximum=None, min_items=None, min_length=None, min_properties=None, minimum=None, multiple_of=None, _not=None, nullable=None, one_of=None, pattern=None, pattern_properties=None, properties=None, required=None, title=None, type=None, unique_items=None, x_kubernetes_embedded_resource=None, x_kubernetes_int_or_string=None, x_kubernetes_list_map_keys=None, x_kubernetes_list_type=None, x_kubernetes_map_type=None, x_kubernetes_preserve_unknown_fields=None, x_kubernetes_validations=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

property additional_items

Gets the additional_items of this V1JSONSchemaProps. # noqa: E501

JSONSchemaPropsOrBool represents JSONSchemaProps or a boolean value. Defaults to true for the boolean property. # noqa: E501

Returns:

The additional_items of this V1JSONSchemaProps. # noqa: E501

Return type:

object

property additional_properties

Gets the additional_properties of this V1JSONSchemaProps. # noqa: E501

JSONSchemaPropsOrBool represents JSONSchemaProps or a boolean value. Defaults to true for the boolean property. # noqa: E501

Returns:

The additional_properties of this V1JSONSchemaProps. # noqa: E501

Return type:

object

property all_of

Gets the all_of of this V1JSONSchemaProps. # noqa: E501

Returns:

The all_of of this V1JSONSchemaProps. # noqa: E501

Return type:

list[V1JSONSchemaProps]

property any_of

Gets the any_of of this V1JSONSchemaProps. # noqa: E501

Returns:

The any_of of this V1JSONSchemaProps. # noqa: E501

Return type:

list[V1JSONSchemaProps]

attribute_map = {'_not': 'not', 'additional_items': 'additionalItems', 'additional_properties': 'additionalProperties', 'all_of': 'allOf', 'any_of': 'anyOf', 'default': 'default', 'definitions': 'definitions', 'dependencies': 'dependencies', 'description': 'description', 'enum': 'enum', 'example': 'example', 'exclusive_maximum': 'exclusiveMaximum', 'exclusive_minimum': 'exclusiveMinimum', 'external_docs': 'externalDocs', 'format': 'format', 'id': 'id', 'items': 'items', 'max_items': 'maxItems', 'max_length': 'maxLength', 'max_properties': 'maxProperties', 'maximum': 'maximum', 'min_items': 'minItems', 'min_length': 'minLength', 'min_properties': 'minProperties', 'minimum': 'minimum', 'multiple_of': 'multipleOf', 'nullable': 'nullable', 'one_of': 'oneOf', 'pattern': 'pattern', 'pattern_properties': 'patternProperties', 'properties': 'properties', 'ref': '$ref', 'required': 'required', 'schema': '$schema', 'title': 'title', 'type': 'type', 'unique_items': 'uniqueItems', 'x_kubernetes_embedded_resource': 'x-kubernetes-embedded-resource', 'x_kubernetes_int_or_string': 'x-kubernetes-int-or-string', 'x_kubernetes_list_map_keys': 'x-kubernetes-list-map-keys', 'x_kubernetes_list_type': 'x-kubernetes-list-type', 'x_kubernetes_map_type': 'x-kubernetes-map-type', 'x_kubernetes_preserve_unknown_fields': 'x-kubernetes-preserve-unknown-fields', 'x_kubernetes_validations': 'x-kubernetes-validations'}
property default

Gets the default of this V1JSONSchemaProps. # noqa: E501

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. # noqa: E501

Returns:

The default of this V1JSONSchemaProps. # noqa: E501

Return type:

object

property definitions

Gets the definitions of this V1JSONSchemaProps. # noqa: E501

Returns:

The definitions of this V1JSONSchemaProps. # noqa: E501

Return type:

dict(str, V1JSONSchemaProps)

property dependencies

Gets the dependencies of this V1JSONSchemaProps. # noqa: E501

Returns:

The dependencies of this V1JSONSchemaProps. # noqa: E501

Return type:

dict(str, object)

property description

Gets the description of this V1JSONSchemaProps. # noqa: E501

Returns:

The description of this V1JSONSchemaProps. # noqa: E501

Return type:

str

property enum

Gets the enum of this V1JSONSchemaProps. # noqa: E501

Returns:

The enum of this V1JSONSchemaProps. # noqa: E501

Return type:

list[object]

property example

Gets the example of this V1JSONSchemaProps. # noqa: E501

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

Returns:

The example of this V1JSONSchemaProps. # noqa: E501

Return type:

object

property exclusive_maximum

Gets the exclusive_maximum of this V1JSONSchemaProps. # noqa: E501

Returns:

The exclusive_maximum of this V1JSONSchemaProps. # noqa: E501

Return type:

bool

property exclusive_minimum

Gets the exclusive_minimum of this V1JSONSchemaProps. # noqa: E501

Returns:

The exclusive_minimum of this V1JSONSchemaProps. # noqa: E501

Return type:

bool

property external_docs

Gets the external_docs of this V1JSONSchemaProps. # noqa: E501

Returns:

The external_docs of this V1JSONSchemaProps. # noqa: E501

Return type:

V1ExternalDocumentation

property format

Gets the format of this V1JSONSchemaProps. # noqa: E501

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. # noqa: E501

Returns:

The format of this V1JSONSchemaProps. # noqa: E501

Return type:

str

property id

Gets the id of this V1JSONSchemaProps. # noqa: E501

Returns:

The id of this V1JSONSchemaProps. # noqa: E501

Return type:

str

property items

Gets the items of this V1JSONSchemaProps. # noqa: E501

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

Returns:

The items of this V1JSONSchemaProps. # noqa: E501

Return type:

object

property max_items

Gets the max_items of this V1JSONSchemaProps. # noqa: E501

Returns:

The max_items of this V1JSONSchemaProps. # noqa: E501

Return type:

int

property max_length

Gets the max_length of this V1JSONSchemaProps. # noqa: E501

Returns:

The max_length of this V1JSONSchemaProps. # noqa: E501

Return type:

int

property max_properties

Gets the max_properties of this V1JSONSchemaProps. # noqa: E501

Returns:

The max_properties of this V1JSONSchemaProps. # noqa: E501

Return type:

int

property maximum

Gets the maximum of this V1JSONSchemaProps. # noqa: E501

Returns:

The maximum of this V1JSONSchemaProps. # noqa: E501

Return type:

float

property min_items

Gets the min_items of this V1JSONSchemaProps. # noqa: E501

Returns:

The min_items of this V1JSONSchemaProps. # noqa: E501

Return type:

int

property min_length

Gets the min_length of this V1JSONSchemaProps. # noqa: E501

Returns:

The min_length of this V1JSONSchemaProps. # noqa: E501

Return type:

int

property min_properties

Gets the min_properties of this V1JSONSchemaProps. # noqa: E501

Returns:

The min_properties of this V1JSONSchemaProps. # noqa: E501

Return type:

int

property minimum

Gets the minimum of this V1JSONSchemaProps. # noqa: E501

Returns:

The minimum of this V1JSONSchemaProps. # noqa: E501

Return type:

float

property multiple_of

Gets the multiple_of of this V1JSONSchemaProps. # noqa: E501

Returns:

The multiple_of of this V1JSONSchemaProps. # noqa: E501

Return type:

float

property nullable

Gets the nullable of this V1JSONSchemaProps. # noqa: E501

Returns:

The nullable of this V1JSONSchemaProps. # noqa: E501

Return type:

bool

property one_of

Gets the one_of of this V1JSONSchemaProps. # noqa: E501

Returns:

The one_of of this V1JSONSchemaProps. # noqa: E501

Return type:

list[V1JSONSchemaProps]

openapi_types = {'_not': 'V1JSONSchemaProps', 'additional_items': 'object', 'additional_properties': 'object', 'all_of': 'list[V1JSONSchemaProps]', 'any_of': 'list[V1JSONSchemaProps]', 'default': 'object', 'definitions': 'dict(str, V1JSONSchemaProps)', 'dependencies': 'dict(str, object)', 'description': 'str', 'enum': 'list[object]', 'example': 'object', 'exclusive_maximum': 'bool', 'exclusive_minimum': 'bool', 'external_docs': 'V1ExternalDocumentation', 'format': 'str', 'id': 'str', 'items': 'object', 'max_items': 'int', 'max_length': 'int', 'max_properties': 'int', 'maximum': 'float', 'min_items': 'int', 'min_length': 'int', 'min_properties': 'int', 'minimum': 'float', 'multiple_of': 'float', 'nullable': 'bool', 'one_of': 'list[V1JSONSchemaProps]', 'pattern': 'str', 'pattern_properties': 'dict(str, V1JSONSchemaProps)', 'properties': 'dict(str, V1JSONSchemaProps)', 'ref': 'str', 'required': 'list[str]', 'schema': 'str', 'title': 'str', 'type': 'str', 'unique_items': 'bool', 'x_kubernetes_embedded_resource': 'bool', 'x_kubernetes_int_or_string': 'bool', 'x_kubernetes_list_map_keys': 'list[str]', 'x_kubernetes_list_type': 'str', 'x_kubernetes_map_type': 'str', 'x_kubernetes_preserve_unknown_fields': 'bool', 'x_kubernetes_validations': 'list[V1ValidationRule]'}
property pattern

Gets the pattern of this V1JSONSchemaProps. # noqa: E501

Returns:

The pattern of this V1JSONSchemaProps. # noqa: E501

Return type:

str

property pattern_properties

Gets the pattern_properties of this V1JSONSchemaProps. # noqa: E501

Returns:

The pattern_properties of this V1JSONSchemaProps. # noqa: E501

Return type:

dict(str, V1JSONSchemaProps)

property properties

Gets the properties of this V1JSONSchemaProps. # noqa: E501

Returns:

The properties of this V1JSONSchemaProps. # noqa: E501

Return type:

dict(str, V1JSONSchemaProps)

property ref

Gets the ref of this V1JSONSchemaProps. # noqa: E501

Returns:

The ref of this V1JSONSchemaProps. # noqa: E501

Return type:

str

property required

Gets the required of this V1JSONSchemaProps. # noqa: E501

Returns:

The required of this V1JSONSchemaProps. # noqa: E501

Return type:

list[str]

property schema

Gets the schema of this V1JSONSchemaProps. # noqa: E501

Returns:

The schema of this V1JSONSchemaProps. # noqa: E501

Return type:

str

property title

Gets the title of this V1JSONSchemaProps. # noqa: E501

Returns:

The title of this V1JSONSchemaProps. # noqa: E501

Return type:

str

to_dict(serialize=False)

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property type

Gets the type of this V1JSONSchemaProps. # noqa: E501

Returns:

The type of this V1JSONSchemaProps. # noqa: E501

Return type:

str

property unique_items

Gets the unique_items of this V1JSONSchemaProps. # noqa: E501

Returns:

The unique_items of this V1JSONSchemaProps. # noqa: E501

Return type:

bool

property x_kubernetes_embedded_resource

Gets the x_kubernetes_embedded_resource of this V1JSONSchemaProps. # noqa: E501

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). # noqa: E501

Returns:

The x_kubernetes_embedded_resource of this V1JSONSchemaProps. # noqa: E501

Return type:

bool

property x_kubernetes_int_or_string

Gets the x_kubernetes_int_or_string of this V1JSONSchemaProps. # noqa: E501

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 # noqa: E501

Returns:

The x_kubernetes_int_or_string of this V1JSONSchemaProps. # noqa: E501

Return type:

bool

property x_kubernetes_list_map_keys

Gets the x_kubernetes_list_map_keys of this V1JSONSchemaProps. # noqa: E501

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. # noqa: E501

Returns:

The x_kubernetes_list_map_keys of this V1JSONSchemaProps. # noqa: E501

Return type:

list[str]

property x_kubernetes_list_type

Gets the x_kubernetes_list_type of this V1JSONSchemaProps. # noqa: E501

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. # noqa: E501

Returns:

The x_kubernetes_list_type of this V1JSONSchemaProps. # noqa: E501

Return type:

str

property x_kubernetes_map_type

Gets the x_kubernetes_map_type of this V1JSONSchemaProps. # noqa: E501

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. # noqa: E501

Returns:

The x_kubernetes_map_type of this V1JSONSchemaProps. # noqa: E501

Return type:

str

property x_kubernetes_preserve_unknown_fields

Gets the x_kubernetes_preserve_unknown_fields of this V1JSONSchemaProps. # noqa: E501

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. # noqa: E501

Returns:

The x_kubernetes_preserve_unknown_fields of this V1JSONSchemaProps. # noqa: E501

Return type:

bool

property x_kubernetes_validations

Gets the x_kubernetes_validations of this V1JSONSchemaProps. # noqa: E501

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

Returns:

The x_kubernetes_validations of this V1JSONSchemaProps. # noqa: E501

Return type:

list[V1ValidationRule]