EpSdkCustomAttributeDefinitionTask | Solace Tools

Methods

`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 EpSdkTask.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 EpSdkTask.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 EpSdkTask.deepCompareObjects
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:106

`Protected` deleteFunc

deleteFunc(epSdkCustomAttributeDefinitionTask_GetFuncReturn: IEpSdkCustomAttributeDefinitionTask_GetFuncReturn): Promise<IEpSdkCustomAttributeDefinitionTask_DeleteFuncReturn>
Parameters
- epSdkCustomAttributeDefinitionTask_GetFuncReturn: IEpSdkCustomAttributeDefinitionTask_GetFuncReturn
Returns Promise<IEpSdkCustomAttributeDefinitionTask_DeleteFuncReturn>
Overrides EpSdkTask.deleteFunc
- Defined in packages/ep-sdk/src/tasks/EpSdkCustomAttributeDefinitionTask.ts:433

execute

execute(xContextId?: string): Promise<IEpSdkCustomAttributeDefinitionTask_ExecuteReturn>
Parameters
- Optional xContextId: string
Returns Promise<IEpSdkCustomAttributeDefinitionTask_ExecuteReturn>
Overrides EpSdkTask.execute
- Defined in packages/ep-sdk/src/tasks/EpSdkCustomAttributeDefinitionTask.ts:465

`Protected` getCreateFuncAction

getCreateFuncAction(): EEpSdkTask_Action
Returns EEpSdkTask_Action
Inherited from EpSdkTask.getCreateFuncAction
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:186

`Protected` getDefaultEpObjectKeys

getDefaultEpObjectKeys(): IEpSdkTask_EpObjectKeys
Returns IEpSdkTask_EpObjectKeys
Overrides EpSdkTask.getDefaultEpObjectKeys
- Defined in packages/ep-sdk/src/tasks/EpSdkCustomAttributeDefinitionTask.ts:141

`Protected` getDeleteFuncAction

getDeleteFuncAction(): EEpSdkTask_Action
Returns EEpSdkTask_Action
Inherited from EpSdkTask.getDeleteFuncAction
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:213

`Protected` getEpObjectKeys

getEpObjectKeys(epObject: CustomAttributeDefinition): IEpSdkTask_EpObjectKeys
Parameters
- epObject: CustomAttributeDefinition
Returns IEpSdkTask_EpObjectKeys
Overrides EpSdkTask.getEpObjectKeys
- Defined in packages/ep-sdk/src/tasks/EpSdkCustomAttributeDefinitionTask.ts:148

`Protected` getFunc

getFunc(epSdkCustomAttributeDefinitionTask_Keys: IEpSdkCustomAttributeDefinitionTask_Keys): Promise<IEpSdkCustomAttributeDefinitionTask_GetFuncReturn>
Parameters
- epSdkCustomAttributeDefinitionTask_Keys: IEpSdkCustomAttributeDefinitionTask_Keys
Returns Promise<IEpSdkCustomAttributeDefinitionTask_GetFuncReturn>
Overrides EpSdkTask.getFunc
- Defined in packages/ep-sdk/src/tasks/EpSdkCustomAttributeDefinitionTask.ts:166

`Private` getTaskConfig

getTaskConfig(): IEpSdkCustomAttributeDefinitionTask_Config
Returns IEpSdkCustomAttributeDefinitionTask_Config
- Defined in packages/ep-sdk/src/tasks/EpSdkCustomAttributeDefinitionTask.ts:93

`Protected` getTaskKeys

getTaskKeys(): IEpSdkCustomAttributeDefinitionTask_Keys
Returns IEpSdkCustomAttributeDefinitionTask_Keys
Overrides EpSdkTask.getTaskKeys
- Defined in packages/ep-sdk/src/tasks/EpSdkCustomAttributeDefinitionTask.ts:160

`Protected` getUpdateFuncAction

getUpdateFuncAction(wouldFail?: boolean): EEpSdkTask_Action
Parameters
- wouldFail: boolean = false
Returns EEpSdkTask_Action
Inherited from EpSdkTask.getUpdateFuncAction
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:198

`Protected` initializeTask

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

Returns Promise<void>
Inherited from EpSdkTask.initializeTask
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:308

`Protected` isCheckmode

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

`Protected` isUpdateRequiredFunc

isUpdateRequiredFunc(epSdkCustomAttributeDefinitionTask_GetFuncReturn: IEpSdkCustomAttributeDefinitionTask_GetFuncReturn): Promise<IEpSdkTask_IsUpdateRequiredFuncReturn>
Parameters
- epSdkCustomAttributeDefinitionTask_GetFuncReturn: IEpSdkCustomAttributeDefinitionTask_GetFuncReturn
Returns Promise<IEpSdkTask_IsUpdateRequiredFuncReturn>
Overrides EpSdkTask.isUpdateRequiredFunc
- Defined in packages/ep-sdk/src/tasks/EpSdkCustomAttributeDefinitionTask.ts:213

`Protected` prepareCompareObject4Output

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

`Private` sortEpSdkCustomAttributeEntityTypes

sortEpSdkCustomAttributeEntityTypes(__namedParameters: {
epSdkCustomAttributeEntityTypes: EEpSdkCustomAttributeEntityTypes[];
}): EEpSdkCustomAttributeEntityTypes[]
Parameters
- __namedParameters: {
  epSdkCustomAttributeEntityTypes: EEpSdkCustomAttributeEntityTypes[];
  }
  - epSdkCustomAttributeEntityTypes: EEpSdkCustomAttributeEntityTypes[]
Returns EEpSdkCustomAttributeEntityTypes[]
- Defined in packages/ep-sdk/src/tasks/EpSdkCustomAttributeDefinitionTask.ts:95

`Protected` transform_EpSdkTask_Config

transform_EpSdkTask_Config(epSdkTask_Config: IEpSdkTask_Config): IEpSdkTask_Config
Parameters
- epSdkTask_Config: IEpSdkTask_Config
Returns IEpSdkTask_Config
Inherited from EpSdkTask.transform_EpSdkTask_Config
- Defined in packages/ep-sdk/src/tasks/EpSdkTask.ts:136

`Protected` truncate

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

`Protected` updateFunc

updateFunc(epSdkCustomAttributeDefinitionTask_GetFuncReturn: IEpSdkCustomAttributeDefinitionTask_GetFuncReturn): Promise<IEpSdkCustomAttributeDefinitionTask_UpdateFuncReturn>
Parameters
- epSdkCustomAttributeDefinitionTask_GetFuncReturn: IEpSdkCustomAttributeDefinitionTask_GetFuncReturn
Returns Promise<IEpSdkCustomAttributeDefinitionTask_UpdateFuncReturn>
Overrides EpSdkTask.updateFunc
- Defined in packages/ep-sdk/src/tasks/EpSdkCustomAttributeDefinitionTask.ts:300

`Protected` validateTaskConfig

validateTaskConfig(): Promise<void>
Returns Promise<void>
Overrides EpSdkTask.validateTaskConfig
- Defined in packages/ep-sdk/src/tasks/EpSdkCustomAttributeDefinitionTask.ts:119

Class EpSdkCustomAttributeDefinitionTask

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

taskConfig: IEpSdkCustomAttributeDefinitionTask_Config

Returns EpSdkCustomAttributeDefinitionTask

Properties

Private Readonly Default_TEpSdkCustomAttributeDefinitionTask_Settings

Private Readonly Empty_IEpSdkCustomAttributeDefinitionTask_GetFuncReturn

Protected epSdkTask_Config

Protected epSdkTask_TransactionLog

Protected Optional xContextId

Methods

Private createExistingCompareObject

Parameters

__namedParameters: { customAttributeDefinition: CustomAttributeDefinition; }

customAttributeDefinition: CustomAttributeDefinition

Returns TEpSdkCustomAttributeDefinitionTask_Settings

Protected createFunc

Returns Promise<IEpSdkCustomAttributeDefinitionTask_CreateFuncReturn>

Private createObjectSettings

Returns Required<TEpSdkCustomAttributeDefinitionTask_Settings>

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

epSdkCustomAttributeDefinitionTask_GetFuncReturn: IEpSdkCustomAttributeDefinitionTask_GetFuncReturn

Returns Promise<IEpSdkCustomAttributeDefinitionTask_DeleteFuncReturn>

execute

Parameters

Optional xContextId: string

Returns Promise<IEpSdkCustomAttributeDefinitionTask_ExecuteReturn>

Protected getCreateFuncAction

Returns EEpSdkTask_Action

Protected getDefaultEpObjectKeys

Returns IEpSdkTask_EpObjectKeys

Protected getDeleteFuncAction

Returns EEpSdkTask_Action

Protected getEpObjectKeys

Parameters

epObject: CustomAttributeDefinition

Returns IEpSdkTask_EpObjectKeys

Protected getFunc

Parameters

epSdkCustomAttributeDefinitionTask_Keys: IEpSdkCustomAttributeDefinitionTask_Keys

Returns Promise<IEpSdkCustomAttributeDefinitionTask_GetFuncReturn>

Private getTaskConfig

Returns IEpSdkCustomAttributeDefinitionTask_Config

Protected getTaskKeys

Returns IEpSdkCustomAttributeDefinitionTask_Keys

Protected getUpdateFuncAction

Parameters

wouldFail: boolean = false

Returns EEpSdkTask_Action

Protected initializeTask

Returns Promise<void>

Protected isCheckmode

Returns boolean

Protected isUpdateRequiredFunc

Parameters

`Private` `Readonly` Default_TEpSdkCustomAttributeDefinitionTask_Settings

`Private` `Readonly` Empty_IEpSdkCustomAttributeDefinitionTask_GetFuncReturn

`Protected` epSdkTask_Config

`Protected` epSdkTask_TransactionLog

`Protected` `Optional` xContextId

`Private` createExistingCompareObject

__namedParameters: {
customAttributeDefinition: CustomAttributeDefinition;
}

`Protected` createFunc

`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

`Protected` initializeTask

`Protected` isCheckmode

`Protected` isUpdateRequiredFunc

`Protected` prepareCompareObject4Output

`Private` sortEpSdkCustomAttributeEntityTypes

__namedParameters: {
epSdkCustomAttributeEntityTypes: EEpSdkCustomAttributeEntityTypes[];
}

`Protected` transform_EpSdkTask_Config

`Protected` truncate

`Protected` updateFunc

`Protected` validateTaskConfig