Class DataMapperExtractObjectBuilder

Index

Constructors

Properties

objectName outputObjectName outputPath parent sequence

Methods

addItem child define done filter formula limit list map offset orderBy sourcePath where

Constructors

constructor

new DataMapperExtractObjectBuilder(
    parent: DataMapperBuilder,
    objectName: string,
    outputPath: string,
    sequence: number,
    outputObjectName: string,
): DataMapperExtractObjectBuilder
Parameters
- parent: DataMapperBuilder
- objectName: string
- outputPath: string
- sequence: number
- outputObjectName: string
Returns DataMapperExtractObjectBuilder
- Defined in packages/vlocity/src/datamapper/builder.ts:142

Properties

`Private` `Readonly`objectName

objectName: string

`Private` `Readonly`outputObjectName

outputObjectName: string

`Private` `Readonly`outputPath

outputPath: string

`Private` `Readonly`parent

parent: DataMapperBuilder

`Private` `Readonly`sequence

sequence: number

Methods

`Private`addItem

addItem(fields: Partial<DataMapperItem>): this
Parameters
- fields: Partial<DataMapperItem>
Returns this
- Defined in packages/vlocity/src/datamapper/builder.ts:224

child

child(
    objectName: string,
    pathSegment: string,
    options?: DataMapperExtractObjectOptions,
): DataMapperExtractObjectBuilder
Parameters
- objectName: string
- pathSegment: string
- options: DataMapperExtractObjectOptions = {}
Returns DataMapperExtractObjectBuilder
- Defined in packages/vlocity/src/datamapper/builder.ts:215

define

define(options?: DataMapperExtractObjectOptions): this
Parameters
- options: DataMapperExtractObjectOptions = {}
Returns this
- Defined in packages/vlocity/src/datamapper/builder.ts:151

done

done(): DataMapperBuilder
Returns DataMapperBuilder
- Defined in packages/vlocity/src/datamapper/builder.ts:220

filter

filter(
    fieldName: string,
    operator: string,
    value?: string,
    options?: DataMapperExtractFilterOptions,
): this
Parameters
- fieldName: string
- operator: string
- Optionalvalue: string
- options: DataMapperExtractFilterOptions = {}
Returns this
- Defined in packages/vlocity/src/datamapper/builder.ts:158

formula

formula(
    expression: string,
    resultPath: string,
    options?: DataMapperFormulaOptions,
): this
Parameters
- expression: string
- resultPath: string
- Optionaloptions: DataMapperFormulaOptions
Returns this
- Defined in packages/vlocity/src/datamapper/builder.ts:210

limit

limit(limit: number, options?: DataMapperExtractFilterOptions): this
Parameters
- limit: number
- options: DataMapperExtractFilterOptions = {}
Returns this
- Defined in packages/vlocity/src/datamapper/builder.ts:182

list

list(
outputPath: string,
options?: Omit<DataMapperMapOptions, "outputFieldFormat">,
): this
Parameters
- outputPath: string
- Optionaloptions: Omit<DataMapperMapOptions, "outputFieldFormat">
Returns this
- Defined in packages/vlocity/src/datamapper/builder.ts:205

map

map(
    inputFieldName: string,
    outputPath: string,
    options?: DataMapperMapOptions,
): this
Parameters
- inputFieldName: string
- outputPath: string
- Optionaloptions: DataMapperMapOptions
Returns this
- Defined in packages/vlocity/src/datamapper/builder.ts:200

offset

offset(offset: number, options?: DataMapperExtractFilterOptions): this
Parameters
- offset: number
- options: DataMapperExtractFilterOptions = {}
Returns this
- Defined in packages/vlocity/src/datamapper/builder.ts:191

orderBy

orderBy(orderBy: string, options?: DataMapperExtractFilterOptions): this
Parameters
- orderBy: string
- options: DataMapperExtractFilterOptions = {}
Returns this
- Defined in packages/vlocity/src/datamapper/builder.ts:173

`Private`sourcePath

sourcePath(path: string): string
Parameters
- path: string
Returns string
- Defined in packages/vlocity/src/datamapper/builder.ts:235

where

where(
    fieldName: string,
    operator: string,
    value?: string,
    options?: DataMapperExtractFilterOptions,
): this
Parameters
- fieldName: string
- operator: string
- Optionalvalue: string
- Optionaloptions: DataMapperExtractFilterOptions
Returns this
- Defined in packages/vlocity/src/datamapper/builder.ts:169