Class DatapackDeploymentRecordGroup

constructor

• new DatapackDeploymentRecordGroup(
      key: string,
      records?: DatapackDeploymentRecord[],
  ): DatapackDeploymentRecordGroup

  Create a new group instance.

  Parameters

  • key: string

    Key of this group

  • records: DatapackDeploymentRecord[] = ...

    Records

  Returns DatapackDeploymentRecordGroup

Readonlykey

Readonlyrecords

datapackKey

• get datapackKey(): string

  Returns string

datapackType

• get datapackType(): string

  Returns string

failedCount

• get failedCount(): number

  Number of failed records in this group

  Returns number

size

• get size(): number

  Total number of records in this group

  Returns number

status

• get status(): DatapackkDeploymentState

  Get the deployment group status based on the status of the individual records in teh group

  Returns DatapackkDeploymentState

[iterator]

• "[iterator]"(): ArrayIterator<DatapackDeploymentRecord>

  Returns ArrayIterator<DatapackDeploymentRecord>

getRecordById

• getRecordById(id: string): undefined | DatapackDeploymentRecord

  Get a deployment record with the specified record id.

  Parameters

  • id: string

    Salesforce record id

  Returns undefined | DatapackDeploymentRecord

  The deployment record matching the specified ID or undefined

getRecordOfType

• getRecordOfType(
      sobjectType: string | RegExp,
  ): undefined | DatapackDeploymentRecord

  Get the first record of the specified SObject type, checks for both NS prefixed and non-prefixed records if the sobjectType does not have a prefix. Does not replace namespace placeholders. The matching is case-sensitive DatapackDeploymentRecord.isMatch for the matching logic

  Parameters

  • sobjectType: string | RegExp

    Type of sobject to look for as string or Regular expression

  Returns undefined | DatapackDeploymentRecord

getRecordsOfType

• getRecordsOfType(sobjectType: string | RegExp): DatapackDeploymentRecord[]

  Get akk records of the specified SObject type, checks for both NS prefixed and non-prefixed records if the sobjectType does not have a prefix. Does not replace namespace placeholders. The matching is case-sensitive DatapackDeploymentRecord.isMatch for the matching logic

  Parameters

  • sobjectType: string | RegExp

    Type of sobject to look for as string or Regular expression

  Returns DatapackDeploymentRecord[]

hasErrors

• hasErrors(): boolean

  Determines if there were errors deploying this record group.

  Returns boolean

hasPendingRecords

• hasPendingRecords(): boolean

  Determines if this group has any pending records

  Returns boolean

isStarted

• isStarted(): boolean

  Determines if the deployment of this record group has already started or if all records are still pending.

  Returns boolean

push

• push(record: DatapackDeploymentRecord): void

  Adds an a new record to the

  Parameters

  • record: DatapackDeploymentRecord

  Returns void