Newer Version Available

This content describes an older version of this product. View Latest

BatchJobPart

Represents one part of a batch job. This object is available in API version 51.0 and later.

When a batch job is run, it is divided in to multiple parts. Each part is used to process a specific number of records.

Supported Calls

describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()

Fields

Field Details
BatchJobId
Type
reference
Properties
Filter, Group, Sort
Description
The unique identifier of the associated batch job.
This is a relationship field.
Relationship Name
BatchJob
Relationship Type
Lookup
Refers To
BatchJob
EndTime
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp when the batch job part was processed.
ErrorDescription
Type
string
Properties
Filter, Nillable, Sort
Description
The error message in case the batch job part failed.
FailedRecordCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of records that the batch job part couldn't process.
InputRecordCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of records that the batch job part must process.
Name
Type
string
Properties
Filter, Group, idLookup, Sort
Description
The name of the batch job part.
OutputRecordCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of records the batch job part has processed.
ParentBatchJobPartId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The unique identifier of the part batch job part associated with the batch job part.
This is a relationship field.
Relationship Name
ParentBatchJobPart
Relationship Type
Lookup
Refers To
BatchJobPart
RetryCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of times the batch job part is automatically rerun in case it fails.
StartTime
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp when the batch job part's run was started.
Status
Type
picklist
Properties
Defaulted on create, Filter, Group, Restricted picklist, Sort
Description
The status of the batch job part.
Possible values are:
  • Canceled—Canceled
  • Completed
  • Failed
  • InProgress—In Progress
Type
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
The type of node in case the associated batch job is of the type Calc (Data Processing Engine).
Possible values are:
  • Aggregate
  • Append
  • Compute
  • Datasink
  • Filter
  • Join
  • Slice
  • Source
  • Transform
  • Writeback

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

BatchJobPartFeed
Feed tracking is available for the object.
BatchJobPartHistory
History is available for tracked fields of the object.