polywrap-client/io.polywrap.core.wrap.formats.wrap01.abi/PropertyDefinition

PropertyDefinition

@Serializable

data class PropertyDefinition(val type: String, val kind: Int, val name: String? = null, val required: Boolean? = false, val comment: String? = null, val array: ArrayDefinition? = null, val scalar: ScalarDefinition? = null, val map: MapDefinition? = null, val _object: GenericDefinition? = null, val enum: GenericDefinition? = null, val unresolvedObjectOrEnum: GenericDefinition? = null) : WithComment, AnyDefinition

Definition of a property in a Wrap ABI.

Constructors

PropertyDefinition

constructor(type: String, kind: Int, name: String? = null, required: Boolean? = false, comment: String? = null, array: ArrayDefinition? = null, scalar: ScalarDefinition? = null, map: MapDefinition? = null, _object: GenericDefinition? = null, enum: GenericDefinition? = null, unresolvedObjectOrEnum: GenericDefinition? = null)

Properties

open override val _object: GenericDefinition? = null

Reference to an object property, if it is an object type.

open override val array: ArrayDefinition? = null

Definition of an array property, if it is an array type.

open override val comment: String? = null

Optional comment for the property.

open override val enum: GenericDefinition? = null

Reference to an enum property, if it is an enum type.

open override val kind: Int

Kind of the property definition.

open override val map: MapDefinition? = null

Definition of a map property, if it is a map type.

open override val name: String? = null

Optional name of the property.

open override val required: Boolean? = false

Boolean indicating whether the property is required or not.

open override val scalar: ScalarDefinition? = null

Definition of a scalar property, if it is a scalar type.

open override val type: String

Type of the property.

unresolvedObjectOrEnum

open override val unresolvedObjectOrEnum: GenericDefinition? = null

Reference to an unresolved object or enum property.