Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace TypeListRule

The type list rule that defines how fields are projected.

Properties

Optional configValues

configValues: model.ConfigValues

Optional description

description: undefined | string

A user defined description for the object.

Optional isCascade

isCascade: undefined | false | true

Specifies whether to cascade or not.

Optional isCaseSensitive

isCaseSensitive: undefined | false | true

Specifies if the rule is case sensitive.

Optional isJavaRegexSyntax

isJavaRegexSyntax: undefined | false | true

Specifies whether the rule uses a java regex syntax.

Optional isSkipRemainingRulesOnMatch

isSkipRemainingRulesOnMatch: undefined | false | true

Specifies whether to skip remaining rules when a match is found.

Optional key

key: undefined | string

The key of the object.

Optional matchingStrategy

matchingStrategy: MatchingStrategy

The pattern matching strategy.

Const modelType

modelType: string = "TYPE_LIST_RULE"

Optional modelVersion

modelVersion: undefined | string

The model version of an object.

Optional objectStatus

objectStatus: undefined | number

The status of an object that can be set to value 1 for shallow references across objects, other values reserved. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional parentRef

parentRef: model.ParentReference

Optional ruleType

ruleType: RuleType

The rule type.

Optional scope

scope: any

Reference to a typed object. This can be either a key value to an object within the document, a shall referenced to a {@code TypedObject}, or a full {@code TypedObject} definition.

Optional types

types: Array<any>

An arry of types.

Methods

getDeserializedJsonObj

getJsonObj