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

MapDefinition

@Serializable

data class MapDefinition(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, val key: MapKeyDefinition? = null, val value: GenericDefinition? = null) : WithComment, AnyDefinition

Definition of a Map in a Wrap ABI.

Constructors

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, key: MapKeyDefinition? = null, value: GenericDefinition? = null)

Properties

open override val _object: GenericDefinition? = null

Reference to the object if the map is of object type.

open override val array: ArrayDefinition? = null

Definition of the inner array if the map is of array type.

open override val comment: String? = null

Optional comment associated with this definition.

open override val enum: GenericDefinition? = null

Reference to the enum if the map is of enum type.

val key: MapKeyDefinition? = null

Definition of the map key.

open override val kind: Int

Kind of the definition.

open override val map: MapDefinition? = null

Definition of the inner map if the map is of map type.

open override val name: String? = null

Optional name of the map.

open override val required: Boolean? = false

Boolean indicating whether the map is required or not.

open override val scalar: ScalarDefinition? = null

Definition of the inner scalar if the map is of scalar type.

open override val type: String

Type of the map.

unresolvedObjectOrEnum

open override val unresolvedObjectOrEnum: GenericDefinition? = null

Reference to the unresolved object or enum if the map is of an unresolved type.

val value: GenericDefinition? = null

Definition of the map value.