Package org.cdk8s.plus23.k8s

Interface JsonSchemaProps

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable
    All Known Implementing Classes:
    JsonSchemaProps.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.69.0 (build f656c31)",
           date="2022-10-15T03:08:35.346Z")
@Stability(Stable)
public interface JsonSchemaProps
extends software.amazon.jsii.JsiiSerializable
    JSONSchemaProps is a JSON-Schema following Specification Draft 4 (http://json-schema.org/).

    • Method Detail

      • getAdditionalItems

        @Stability(Stable)
@Nullable
default Object getAdditionalItems()

      • getAdditionalProperties

        @Stability(Stable)
@Nullable
default Object getAdditionalProperties()

      • getDefaultValue

        @Stability(Stable)
@Nullable
default Object getDefaultValue()
        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.

      • getDependencies

        @Stability(Stable)
@Nullable
default Map<String,​Object> getDependencies()

      • getDescription

        @Stability(Stable)
@Nullable
default String getDescription()

      • getEnumValue

        @Stability(Stable)
@Nullable
default List<Object> getEnumValue()

      • getExample

        @Stability(Stable)
@Nullable
default Object getExample()

      • getExclusiveMaximum

        @Stability(Stable)
@Nullable
default Boolean getExclusiveMaximum()

      • getExclusiveMinimum

        @Stability(Stable)
@Nullable
default Boolean getExclusiveMinimum()

      • getFormat

        @Stability(Stable)
@Nullable
default String getFormat()
        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.

      • getId

        @Stability(Stable)
@Nullable
default String getId()

      • getItems

        @Stability(Stable)
@Nullable
default Object getItems()

      • getMaximum

        @Stability(Stable)
@Nullable
default Number getMaximum()

      • getMaxItems

        @Stability(Stable)
@Nullable
default Number getMaxItems()

      • getMaxLength

        @Stability(Stable)
@Nullable
default Number getMaxLength()

      • getMaxProperties

        @Stability(Stable)
@Nullable
default Number getMaxProperties()

      • getMinimum

        @Stability(Stable)
@Nullable
default Number getMinimum()

      • getMinItems

        @Stability(Stable)
@Nullable
default Number getMinItems()

      • getMinLength

        @Stability(Stable)
@Nullable
default Number getMinLength()

      • getMinProperties

        @Stability(Stable)
@Nullable
default Number getMinProperties()

      • getMultipleOf

        @Stability(Stable)
@Nullable
default Number getMultipleOf()

      • getNullable

        @Stability(Stable)
@Nullable
default Boolean getNullable()

      • getPattern

        @Stability(Stable)
@Nullable
default String getPattern()

      • getRef

        @Stability(Stable)
@Nullable
default String getRef()

      • getRequired

        @Stability(Stable)
@Nullable
default List<String> getRequired()

      • getSchema

        @Stability(Stable)
@Nullable
default String getSchema()

      • getTitle

        @Stability(Stable)
@Nullable
default String getTitle()

      • getType

        @Stability(Stable)
@Nullable
default String getType()

      • getUniqueItems

        @Stability(Stable)
@Nullable
default Boolean getUniqueItems()

      • getXKubernetesEmbeddedResource

        @Stability(Stable)
@Nullable
default Boolean getXKubernetesEmbeddedResource()
        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).

      • getXKubernetesIntOrString

        @Stability(Stable)
@Nullable
default Boolean getXKubernetesIntOrString()
        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

      • getXKubernetesListMapKeys

        @Stability(Stable)
@Nullable
default List<String> getXKubernetesListMapKeys()
        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.

      • getXKubernetesListType

        @Stability(Stable)
@Nullable
default String getXKubernetesListType()
        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.

        Default: atomic for arrays.

      • getXKubernetesMapType

        @Stability(Stable)
@Nullable
default String getXKubernetesMapType()
        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.

      • getXKubernetesPreserveUnknownFields

        @Stability(Stable)
@Nullable
default Boolean getXKubernetesPreserveUnknownFields()
        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.

      • getXKubernetesValidations

        @Stability(Stable)
@Nullable
default List<ValidationRule> getXKubernetesValidations()
        x-kubernetes-validations describes a list of validation rules written in the CEL expression language.

        This field is an alpha-level. Using this field requires the feature gate CustomResourceValidationExpressions to be enabled.