wow-api/me.ahoo.wow.api.query.descriptor/FieldDescriptor

FieldDescriptor

data class FieldDescriptor(val path: String, val role: String?, val types: Set<QueryValueType>, val kind: QueryValueKind, val nullable: Boolean, val semantic: QuerySemanticType?, val enum: List<EnumValueDescriptor>?, val description: String?, val sensitivity: SensitivityDescriptor?, val project: Boolean, val filter: FieldFilterDescriptor, val sort: FieldSortDescriptor, val aggregate: FieldAggregateDescriptor?, val scope: String?, val deprecated: QueryDeprecation? = null, val aliases: List<String> = emptyList())

Constructors

FieldDescriptor

constructor(path: String, role: String?, types: Set<QueryValueType>, kind: QueryValueKind, nullable: Boolean, semantic: QuerySemanticType?, enum: List<EnumValueDescriptor>?, description: String?, sensitivity: SensitivityDescriptor?, project: Boolean, filter: FieldFilterDescriptor, sort: FieldSortDescriptor, aggregate: FieldAggregateDescriptor?, scope: String?, deprecated: QueryDeprecation? = null, aliases: List<String> = emptyList())

Types

object Companion

Properties

val aggregate: FieldAggregateDescriptor?

null when the field cannot be aggregated at all.

val aliases: List<String>

Other paths a query may use for this field; admission replaces them with path.

val deprecated: QueryDeprecation?

Set when the field is deprecated: still queryable, but new queries should avoid it.

val description: String?

val enum: List<EnumValueDescriptor>?

Declared values; never listed for protected fields.

val filter: FieldFilterDescriptor

val kind: QueryValueKind

val nullable: Boolean

val path: String

val project: Boolean

val role: String?

The system role of a system field: a system-field filter target (SystemField, e.g. TENANT_ID), or one of the model's times (EVENT_TIME, FIRST_EVENT_TIME); null for ordinary fields.

val scope: String?

The element this field lives in, or null at the record level.

val semantic: QuerySemanticType?

val sensitivity: SensitivityDescriptor?

val sort: FieldSortDescriptor

val types: Set<QueryValueType>