Class EpSdkEpEventVersionTask

Hierarchy

EpSdkVersionTask
- EpSdkEpEventVersionTask

Constructors

constructor

new EpSdkEpEventVersionTask(taskConfig: IEpSdkEpEventVersionTask_Config): EpSdkEpEventVersionTask
Parameters
- taskConfig: IEpSdkEpEventVersionTask_Config
Returns EpSdkEpEventVersionTask
Overrides EpSdkVersionTask.constructor
- Defined in packages/ep-sdk/src/tasks/EpSdkEpEventVersionTask.ts:190

Properties

`Private` `Readonly` Default_TEpSdkEpEventVersionTask_Settings

Default_TEpSdkEpEventVersionTask_Settings: Partial<TEpSdkEpEventVersionTask_Settings> = ...

`Private` `Readonly` Default_TopicDelimiter

Default_TopicDelimiter: "/" = "/"

`Private` `Readonly` Empty_IEpSdkEpEventVersionTask_GetFuncReturn

Empty_IEpSdkEpEventVersionTask_GetFuncReturn: IEpSdkEpEventVersionTask_GetFuncReturn = ...

`Protected` epSdkTask_Config

epSdkTask_Config: IEpSdkTask_Config

`Protected` epSdkTask_TransactionLog

epSdkTask_TransactionLog: EpSdkTask_TransactionLog

`Private` topicAddressLevelList

topicAddressLevelList: AddressLevel[] = []

`Protected` versionStrategy

versionStrategy: EEpSdk_VersionTaskStrategy = EEpSdk_VersionTaskStrategy.BUMP_PATCH

`Protected` versionString

versionString: string = '1.0.0'

`Protected` `Optional` xContextId

xContextId?: string

Methods

`Protected` createFunc

createFunc(): Promise<IEpSdkEpEventVersionTask_CreateFuncReturn>
Create a new EventVersion

Returns Promise<IEpSdkEpEventVersionTask_CreateFuncReturn>
Overrides EpSdkVersionTask.createFunc
- Defined in packages/ep-sdk/src/tasks/EpSdkEpEventVersionTask.ts:320

`Protected` createNextVersionWithStrategyValidation

createNextVersionWithStrategyValidation(__namedParameters: {
existingObjectVersionString: string;
}): string
Parameters
- __namedParameters: {
  existingObjectVersionString: string;
  }
  - existingObjectVersionString: string
Returns string
Inherited from EpSdkVersionTask.createNextVersionWithStrategyValidation
- Defined in packages/ep-sdk/src/tasks/EpSdkVersionTask.ts:58

`Private` createObjectSettings

createObjectSettings(dd?: DeliveryDescriptor): Partial<EventVersion>
Parameters
- Optional dd: DeliveryDescriptor
Returns Partial<EventVersion>
- Defined in packages/ep-sdk/src/tasks/EpSdkEpEventVersionTask.ts:140

`Protected` createReturn4UpdateFunc

createReturn4UpdateFunc(__namedParameters: {
epSdkTask_UpdateFuncReturn: IEpSdkTask_UpdateFuncReturn;
}): IEpSdkTask_ExecuteReturn
Parameters
- __namedParameters: {
  epSdkTask_UpdateFuncReturn: IEpSdkTask_UpdateFuncReturn;
  }
  - epSdkTask_UpdateFuncReturn: IEpSdkTask_UpdateFuncReturn
Returns IEpSdkTask_ExecuteReturn
Inherited from EpSdkVersionTask.createReturn4UpdateFunc
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:224

`Protected` create_IEpSdkTask_IsUpdateRequiredFuncReturn

create_IEpSdkTask_IsUpdateRequiredFuncReturn(__namedParameters: {
existingObject: any;
requestedObject: any;
}): IEpSdkTask_IsUpdateRequiredFuncReturn
Parameters
- __namedParameters: {
  existingObject: any;
  requestedObject: any;
  }
  - existingObject: any
  - requestedObject: any
Returns IEpSdkTask_IsUpdateRequiredFuncReturn
Inherited from EpSdkVersionTask.create_IEpSdkTask_IsUpdateRequiredFuncReturn
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:119

`Protected` deepCompareObjects

deepCompareObjects(__namedParameters: {
existingObject: any;
requestedObject: any;
}): IEpSdkDeepCompareResult
Parameters
- __namedParameters: {
  existingObject: any;
  requestedObject: any;
  }
  - existingObject: any
  - requestedObject: any
Returns IEpSdkDeepCompareResult
Inherited from EpSdkVersionTask.deepCompareObjects
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:106

`Private` getEnumVersionId

getEnumVersionId(enumName: string): Promise<string>
Parameters
- enumName: string
Returns Promise<string>
- Defined in packages/ep-sdk/src/tasks/EpSdkEpEventVersionTask.ts:100

`Protected` getEpObjectKeys

getEpObjectKeys(epObject: EventVersion): IEpSdkVersionTask_EpObjectKeys
Parameters
- epObject: EventVersion
Returns IEpSdkVersionTask_EpObjectKeys
Overrides EpSdkVersionTask.getEpObjectKeys
- Defined in packages/ep-sdk/src/tasks/EpSdkEpEventVersionTask.ts:202

`Protected` getFunc

getFunc(epSdkEpEventVersionTask_Keys: IEpSdkEpEventVersionTask_Keys): Promise<IEpSdkEpEventVersionTask_GetFuncReturn>
Get the latest EventVersion.
Parameters
- epSdkEpEventVersionTask_Keys: IEpSdkEpEventVersionTask_Keys
Returns Promise<IEpSdkEpEventVersionTask_GetFuncReturn>
Overrides EpSdkVersionTask.getFunc
- Defined in packages/ep-sdk/src/tasks/EpSdkEpEventVersionTask.ts:246

`Private` getTaskConfig

getTaskConfig(): IEpSdkEpEventVersionTask_Config
Returns IEpSdkEpEventVersionTask_Config
- Defined in packages/ep-sdk/src/tasks/EpSdkEpEventVersionTask.ts:96

`Protected` getTaskKeys

getTaskKeys(): IEpSdkEpEventVersionTask_Keys
Returns IEpSdkEpEventVersionTask_Keys
Overrides EpSdkVersionTask.getTaskKeys
- Defined in packages/ep-sdk/src/tasks/EpSdkEpEventVersionTask.ts:236

`Protected` getUpdateFuncAction

getUpdateFuncAction(wouldFailOnExactVersionRequirement?: boolean): EEpSdkTask_Action
Parameters
- Optional wouldFailOnExactVersionRequirement: boolean
Returns EEpSdkTask_Action
Inherited from EpSdkVersionTask.getUpdateFuncAction
- Defined in packages/ep-sdk/src/tasks/EpSdkVersionTask.ts:96

`Protected` initializeTask

initializeTask(): Promise<void>
Allows for async init of task

Returns Promise<void>
Overrides EpSdkVersionTask.initializeTask
- Defined in packages/ep-sdk/src/tasks/EpSdkEpEventVersionTask.ts:167

`Private` initializeTopicAddressLevels

initializeTopicAddressLevels(__namedParameters: {
topicDelimiter: string;
topicString: string;
}): Promise<AddressLevel[]>
Parameters
- __namedParameters: {
  topicDelimiter: string;
  topicString: string;
  }
  - topicDelimiter: string
  - topicString: string
Returns Promise<AddressLevel[]>
- Defined in packages/ep-sdk/src/tasks/EpSdkEpEventVersionTask.ts:115

`Protected` isCheckmode

isCheckmode(): boolean
Returns boolean
Inherited from EpSdkVersionTask.isCheckmode
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:97

`Protected` isUpdateRequiredFunc

isUpdateRequiredFunc(epSdkEpEventVersionTask_GetFuncReturn: IEpSdkEpEventVersionTask_GetFuncReturn): Promise<IEpSdkTask_IsUpdateRequiredFuncReturn>
Parameters
- epSdkEpEventVersionTask_GetFuncReturn: IEpSdkEpEventVersionTask_GetFuncReturn
Returns Promise<IEpSdkTask_IsUpdateRequiredFuncReturn>
Overrides EpSdkVersionTask.isUpdateRequiredFunc
- Defined in packages/ep-sdk/src/tasks/EpSdkEpEventVersionTask.ts:275

`Protected` prepareCompareObject4Output

prepareCompareObject4Output(obj: any): any
Parameters
- obj: any
Returns any
Inherited from EpSdkVersionTask.prepareCompareObject4Output
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:102

transform_EpSdkTask_Config

transform_EpSdkTask_Config(epSdkEpEventVersionTask_Config: IEpSdkEpEventVersionTask_Config): IEpSdkEpEventVersionTask_Config
Parameters
- epSdkEpEventVersionTask_Config: IEpSdkEpEventVersionTask_Config
Returns IEpSdkEpEventVersionTask_Config
Overrides EpSdkVersionTask.transform_EpSdkTask_Config
- Defined in packages/ep-sdk/src/tasks/EpSdkEpEventVersionTask.ts:182

`Protected` truncate

truncate(str: string, maxLength: number): string
Parameters
- str: string
- maxLength: number
Returns string
Inherited from EpSdkVersionTask.truncate
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:140

`Protected` updateFunc

updateFunc(epSdkEpEventVersionTask_GetFuncReturn: IEpSdkEpEventVersionTask_GetFuncReturn): Promise<IEpSdkEpEventVersionTask_UpdateFuncReturn>
Creates a new EventVersion with bumped version number.
Parameters
- epSdkEpEventVersionTask_GetFuncReturn: IEpSdkEpEventVersionTask_GetFuncReturn
Returns Promise<IEpSdkEpEventVersionTask_UpdateFuncReturn>
Overrides EpSdkVersionTask.updateFunc
- Defined in packages/ep-sdk/src/tasks/EpSdkEpEventVersionTask.ts:371

`Protected` validateTaskConfig

validateTaskConfig(): Promise<void>
Returns Promise<void>
Inherited from EpSdkVersionTask.validateTaskConfig
- Defined in packages/ep-sdk/src/tasks/EpSdkVersionTask.ts:50

Class EpSdkEpEventVersionTask

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

taskConfig: IEpSdkEpEventVersionTask_Config

Returns EpSdkEpEventVersionTask

Properties

Private Readonly Default_TEpSdkEpEventVersionTask_Settings

Private Readonly Default_TopicDelimiter

Private Readonly Empty_IEpSdkEpEventVersionTask_GetFuncReturn

Protected epSdkTask_Config

Protected epSdkTask_TransactionLog

Private topicAddressLevelList

Protected versionStrategy

Protected versionString

Protected Optional xContextId

Methods

Protected createFunc

Returns Promise<IEpSdkEpEventVersionTask_CreateFuncReturn>

Protected createNextVersionWithStrategyValidation

Parameters

__namedParameters: { existingObjectVersionString: string; }

existingObjectVersionString: string

Returns string

Private createObjectSettings

Parameters

Optional dd: DeliveryDescriptor

Returns Partial<EventVersion>

Protected createReturn4UpdateFunc

Parameters

__namedParameters: { epSdkTask_UpdateFuncReturn: IEpSdkTask_UpdateFuncReturn; }

epSdkTask_UpdateFuncReturn: IEpSdkTask_UpdateFuncReturn

Returns IEpSdkTask_ExecuteReturn

Protected create_IEpSdkTask_IsUpdateRequiredFuncReturn

Parameters

__namedParameters: { existingObject: any; requestedObject: any; }

existingObject: any

requestedObject: any

Returns IEpSdkTask_IsUpdateRequiredFuncReturn

Protected deepCompareObjects

Parameters

__namedParameters: { existingObject: any; requestedObject: any; }

existingObject: any

requestedObject: any

Returns IEpSdkDeepCompareResult

Protected deleteFunc

Parameters

epSdkTask_GetFuncReturn: IEpSdkTask_GetFuncReturn

Returns Promise<IEpSdkTask_DeleteFuncReturn>

execute

Parameters

Optional xContextId: string

Returns Promise<IEpSdkEpEventVersionTask_ExecuteReturn>

Protected getCreateFuncAction

Returns EEpSdkTask_Action

Protected getDefaultEpObjectKeys

Returns IEpSdkVersionTask_EpObjectKeys

Protected getDeleteFuncAction

Returns EEpSdkTask_Action

Private getEnumVersionId

Parameters

enumName: string

Returns Promise<string>

Protected getEpObjectKeys

Parameters

epObject: EventVersion

Returns IEpSdkVersionTask_EpObjectKeys

Protected getFunc

Parameters

epSdkEpEventVersionTask_Keys: IEpSdkEpEventVersionTask_Keys

Returns Promise<IEpSdkEpEventVersionTask_GetFuncReturn>

Private getTaskConfig

Returns IEpSdkEpEventVersionTask_Config

Protected getTaskKeys

Returns IEpSdkEpEventVersionTask_Keys

`Private` `Readonly` Default_TEpSdkEpEventVersionTask_Settings

`Private` `Readonly` Default_TopicDelimiter

`Private` `Readonly` Empty_IEpSdkEpEventVersionTask_GetFuncReturn

`Protected` epSdkTask_Config

`Protected` epSdkTask_TransactionLog

`Private` topicAddressLevelList

`Protected` versionStrategy

`Protected` versionString

`Protected` `Optional` xContextId

`Protected` createFunc

`Protected` createNextVersionWithStrategyValidation

__namedParameters: {
existingObjectVersionString: string;
}

`Private` createObjectSettings

`Optional` dd: DeliveryDescriptor

`Protected` createReturn4UpdateFunc

__namedParameters: {
epSdkTask_UpdateFuncReturn: IEpSdkTask_UpdateFuncReturn;
}

`Protected` create_IEpSdkTask_IsUpdateRequiredFuncReturn

__namedParameters: {
existingObject: any;
requestedObject: any;
}

`Protected` deepCompareObjects

__namedParameters: {
existingObject: any;
requestedObject: any;
}

`Protected` deleteFunc

`Optional` xContextId: string

`Protected` getCreateFuncAction

`Protected` getDefaultEpObjectKeys

`Protected` getDeleteFuncAction

`Private` getEnumVersionId

`Protected` getEpObjectKeys

`Protected` getFunc

`Private` getTaskConfig

`Protected` getTaskKeys

`Protected` getUpdateFuncAction

`Optional` wouldFailOnExactVersionRequirement: boolean

`Protected` initializeTask

`Private` initializeTopicAddressLevels

__namedParameters: {
topicDelimiter: string;
topicString: string;
}

`Protected` isCheckmode

`Protected` isUpdateRequiredFunc

`Protected` prepareCompareObject4Output

`Protected` truncate

`Protected` updateFunc

`Protected` validateTaskConfig