Class EpSdkEventApiVersionTask

Hierarchy

EpSdkVersionTask
- EpSdkEventApiVersionTask

Constructors

constructor

new EpSdkEventApiVersionTask(taskConfig: IEpSdkEventApiVersionTask_Config): EpSdkEventApiVersionTask
Parameters
- taskConfig: IEpSdkEventApiVersionTask_Config
Returns EpSdkEventApiVersionTask
Overrides EpSdkVersionTask.constructor
- Defined in packages/ep-sdk/src/tasks/EpSdkEventApiVersionTask.ts:93

Properties

`Private` `Readonly` Default_TEpSdkEventApiVersionTask_Settings

Default_TEpSdkEventApiVersionTask_Settings: Partial<Required<Pick<EventApiVersion, "stateId" | "description" | "displayName" | "producedEventVersionIds" | "consumedEventVersionIds">>> = {}

`Private` `Readonly` Empty_IEpSdkEventApiVersionTask_GetFuncReturn

Empty_IEpSdkEventApiVersionTask_GetFuncReturn: IEpSdkEventApiVersionTask_GetFuncReturn = ...

`Protected` epSdkTask_Config

epSdkTask_Config: IEpSdkTask_Config

`Protected` epSdkTask_TransactionLog

epSdkTask_TransactionLog: EpSdkTask_TransactionLog

`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<IEpSdkEventApiVersionTask_CreateFuncReturn>
Create a new EventVersion

Returns Promise<IEpSdkEventApiVersionTask_CreateFuncReturn>
Overrides EpSdkVersionTask.createFunc
- Defined in packages/ep-sdk/src/tasks/EpSdkEventApiVersionTask.ts:209

`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(): Partial<EventApiVersion>
Returns Partial<EventApiVersion>
- Defined in packages/ep-sdk/src/tasks/EpSdkEventApiVersionTask.ts:75

`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

`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>
Inherited from EpSdkVersionTask.initializeTask
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:308

`Protected` isCheckmode

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

`Protected` isUpdateRequiredFunc

isUpdateRequiredFunc(epSdkEventApiVersionTask_GetFuncReturn: IEpSdkEventApiVersionTask_GetFuncReturn): Promise<IEpSdkTask_IsUpdateRequiredFuncReturn>
Parameters
- epSdkEventApiVersionTask_GetFuncReturn: IEpSdkEventApiVersionTask_GetFuncReturn
Returns Promise<IEpSdkTask_IsUpdateRequiredFuncReturn>
Overrides EpSdkVersionTask.isUpdateRequiredFunc
- Defined in packages/ep-sdk/src/tasks/EpSdkEventApiVersionTask.ts:164

`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

`Protected` transform_EpSdkTask_Config

transform_EpSdkTask_Config(epSdkEventApiVersionTask_Config: IEpSdkEventApiVersionTask_Config): IEpSdkEventApiVersionTask_Config
Parameters
- epSdkEventApiVersionTask_Config: IEpSdkEventApiVersionTask_Config
Returns IEpSdkEventApiVersionTask_Config
Overrides EpSdkVersionTask.transform_EpSdkTask_Config
- Defined in packages/ep-sdk/src/tasks/EpSdkEventApiVersionTask.ts:84

`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(epSdkEventApiVersionTask_GetFuncReturn: IEpSdkEventApiVersionTask_GetFuncReturn): Promise<IEpSdkEventApiVersionTask_UpdateFuncReturn>
Creates a new EventApiVersion with bumped version number.
Parameters
- epSdkEventApiVersionTask_GetFuncReturn: IEpSdkEventApiVersionTask_GetFuncReturn
Returns Promise<IEpSdkEventApiVersionTask_UpdateFuncReturn>
Overrides EpSdkVersionTask.updateFunc
- Defined in packages/ep-sdk/src/tasks/EpSdkEventApiVersionTask.ts:277

`Protected` validateTaskConfig

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

Class EpSdkEventApiVersionTask

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

taskConfig: IEpSdkEventApiVersionTask_Config

Returns EpSdkEventApiVersionTask

Properties

Private Readonly Default_TEpSdkEventApiVersionTask_Settings

Private Readonly Empty_IEpSdkEventApiVersionTask_GetFuncReturn

Protected epSdkTask_Config

Protected epSdkTask_TransactionLog

Protected versionStrategy

Protected versionString

Protected Optional xContextId

Methods

Protected createFunc

Returns Promise<IEpSdkEventApiVersionTask_CreateFuncReturn>

Protected createNextVersionWithStrategyValidation

Parameters

__namedParameters: { existingObjectVersionString: string; }

existingObjectVersionString: string

Returns string

Private createObjectSettings

Returns Partial<EventApiVersion>

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<IEpSdkEventApiVersionTask_ExecuteReturn>

Protected getCreateFuncAction

Returns EEpSdkTask_Action

Protected getDefaultEpObjectKeys

Returns IEpSdkVersionTask_EpObjectKeys

Protected getDeleteFuncAction

Returns EEpSdkTask_Action

Protected getEpObjectKeys

Parameters

epObject: EventApiVersion

Returns IEpSdkVersionTask_EpObjectKeys

Protected getFunc

Parameters

epSdkEventApiVersionTask_Keys: IEpSdkEventApiVersionTask_Keys

Returns Promise<IEpSdkEventApiVersionTask_GetFuncReturn>

Private getTaskConfig

Returns IEpSdkEventApiVersionTask_Config

Protected getTaskKeys

Returns IEpSdkEventApiVersionTask_Keys

Protected getUpdateFuncAction

Parameters

Optional wouldFailOnExactVersionRequirement: boolean

Returns EEpSdkTask_Action

Protected initializeTask

Returns Promise<void>

Protected isCheckmode

Returns boolean

`Private` `Readonly` Default_TEpSdkEventApiVersionTask_Settings

`Private` `Readonly` Empty_IEpSdkEventApiVersionTask_GetFuncReturn

`Protected` epSdkTask_Config

`Protected` epSdkTask_TransactionLog

`Protected` versionStrategy

`Protected` versionString

`Protected` `Optional` xContextId

`Protected` createFunc

`Protected` createNextVersionWithStrategyValidation

__namedParameters: {
existingObjectVersionString: string;
}

`Private` createObjectSettings

`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

`Protected` getEpObjectKeys

`Protected` getFunc

`Private` getTaskConfig

`Protected` getTaskKeys

`Protected` getUpdateFuncAction

`Optional` wouldFailOnExactVersionRequirement: boolean

`Protected` initializeTask

`Protected` isCheckmode

`Protected` isUpdateRequiredFunc

`Protected` prepareCompareObject4Output

`Protected` transform_EpSdkTask_Config

`Protected` truncate

`Protected` updateFunc

`Protected` validateTaskConfig