query/me.ahoo.wow.query.schema/QueryFieldDeclaration

QueryFieldDeclaration

@ExperimentalWowApi

class QueryFieldDeclaration @InternalWowApi constructor(val title: DeclarationValue<String?> = DeclarationValue.Unset, val description: DeclarationValue<String?> = DeclarationValue.Unset, val enumValues: DeclarationValue<List<JsonNode>?> = DeclarationValue.Unset, val enumDescriptions: DeclarationValue<Map<JsonNode, String>> = DeclarationValue.Unset, val valueTypes: DeclarationValue<Set<QueryValueType>> = DeclarationValue.Unset, val nullable: DeclarationValue<Boolean> = DeclarationValue.Unset, val required: DeclarationValue<Boolean> = DeclarationValue.Unset, val kind: DeclarationValue<QueryValueKind> = DeclarationValue.Unset, val properties: DeclarationValue<Map<String, QueryFieldDeclaration>> = DeclarationValue.Unset, val items: DeclarationValue<QueryFieldDeclaration?> = DeclarationValue.Unset, val additionalProperties: DeclarationValue<QueryFieldDeclaration?> = DeclarationValue.Unset, val alternatives: DeclarationValue<List<QueryFieldDeclaration>> = DeclarationValue.Unset, val semanticType: DeclarationValue<QuerySemanticType?> = DeclarationValue.Unset, val maskRule: DeclarationValue<MaskRule> = DeclarationValue.Unset, val variant: DeclarationValue<String?> = DeclarationValue.Unset, val aliases: DeclarationValue<Set<QueryField<*>>> = DeclarationValue.Unset, val deprecated: DeclarationValue<QueryDeprecation?> = DeclarationValue.Unset)

What one source declares about one logical value, in the capability descriptor's vocabulary; each fact may be left Unset for a source of lower priority to state. A source of higher priority cannot drop a sensitivity a lower one declares: replacing a protected structure keeps its masks, or fails.

Constructors

QueryFieldDeclaration

@InternalWowApi

constructor(title: DeclarationValue<String?> = DeclarationValue.Unset, description: DeclarationValue<String?> = DeclarationValue.Unset, enumValues: DeclarationValue<List<JsonNode>?> = DeclarationValue.Unset, enumDescriptions: DeclarationValue<Map<JsonNode, String>> = DeclarationValue.Unset, valueTypes: DeclarationValue<Set<QueryValueType>> = DeclarationValue.Unset, nullable: DeclarationValue<Boolean> = DeclarationValue.Unset, required: DeclarationValue<Boolean> = DeclarationValue.Unset, kind: DeclarationValue<QueryValueKind> = DeclarationValue.Unset, properties: DeclarationValue<Map<String, QueryFieldDeclaration>> = DeclarationValue.Unset, items: DeclarationValue<QueryFieldDeclaration?> = DeclarationValue.Unset, additionalProperties: DeclarationValue<QueryFieldDeclaration?> = DeclarationValue.Unset, alternatives: DeclarationValue<List<QueryFieldDeclaration>> = DeclarationValue.Unset, semanticType: DeclarationValue<QuerySemanticType?> = DeclarationValue.Unset, maskRule: DeclarationValue<MaskRule> = DeclarationValue.Unset, variant: DeclarationValue<String?> = DeclarationValue.Unset, aliases: DeclarationValue<Set<QueryField<*>>> = DeclarationValue.Unset, deprecated: DeclarationValue<QueryDeprecation?> = DeclarationValue.Unset)

Types

object Companion

Properties

additionalProperties

val additionalProperties: DeclarationValue<QueryFieldDeclaration?>

val aliases: DeclarationValue<Set<QueryField<*>>>

Other logical paths that name this value; admission replaces them with this value's path.

val alternatives: DeclarationValue<List<QueryFieldDeclaration>>

val deprecated: DeclarationValue<QueryDeprecation?>

Set when the field is kept only for existing callers.

val description: DeclarationValue<String?>

enumDescriptions

val enumDescriptions: DeclarationValue<Map<JsonNode, String>>

What each enum value means, by value; values without a description are absent.

val enumValues: DeclarationValue<List<JsonNode>?>

val items: DeclarationValue<QueryFieldDeclaration?>

val kind: DeclarationValue<QueryValueKind>

val maskRule: DeclarationValue<MaskRule>

The sensitivity of a string value (the Manifest's x-wow-sensitive and x-wow-mask).

val nullable: DeclarationValue<Boolean>

val properties: DeclarationValue<Map<String, QueryFieldDeclaration>>

val required: DeclarationValue<Boolean>

val semanticType: DeclarationValue<QuerySemanticType?>

val title: DeclarationValue<String?>

val valueTypes: DeclarationValue<Set<QueryValueType>>

val variant: DeclarationValue<String?>

The discriminator value of the variant this value is, when it is one alternative of a model's variant payload, such as an event's type.

Functions

@InternalWowApi

fun copy(title: DeclarationValue<String?> = this.title, description: DeclarationValue<String?> = this.description, enumValues: DeclarationValue<List<JsonNode>?> = this.enumValues, enumDescriptions: DeclarationValue<Map<JsonNode, String>> = this.enumDescriptions, valueTypes: DeclarationValue<Set<QueryValueType>> = this.valueTypes, nullable: DeclarationValue<Boolean> = this.nullable, required: DeclarationValue<Boolean> = this.required, kind: DeclarationValue<QueryValueKind> = this.kind, properties: DeclarationValue<Map<String, QueryFieldDeclaration>> = this.properties, items: DeclarationValue<QueryFieldDeclaration?> = this.items, additionalProperties: DeclarationValue<QueryFieldDeclaration?> = this.additionalProperties, alternatives: DeclarationValue<List<QueryFieldDeclaration>> = this.alternatives, semanticType: DeclarationValue<QuerySemanticType?> = this.semanticType, maskRule: DeclarationValue<MaskRule> = this.maskRule, variant: DeclarationValue<String?> = this.variant, aliases: DeclarationValue<Set<QueryField<*>>> = this.aliases, deprecated: DeclarationValue<QueryDeprecation?> = this.deprecated): QueryFieldDeclaration

This QueryFieldDeclaration with the given values replaced; for Wow's own query rewriting.

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

open override fun toString(): String