Force.com Tooling API

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

Newer Version Available

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

ApexExecutionOverlayAction

Specifies an Apex code snippet or SOQL query to execute at a specific line of code in an Apex class or trigger and optionally generate a heap dump.

Supported SOAP Calls

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Supported REST HTTP Methods

Query, GET, POST, PATCH, DELETE

Fields

Field Name Details
ActionScript
Type
string
Properties
Create, Nillable, Update
Description
The Apex code or SOQL query to run when execution reaches the line in the Apex class or trigger at the specified iteration. Results will be included in the heap dump file.
ActionScriptType
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
Indicates whether the ActionScript is written in Apex or SOQL. Valid values are:
  • None
  • Apex
  • SOQL

This field is required.
ExecutableEntityId
Type
reference
Properties
Create, Filter, Group, Sort,
Description
The ID of the Apex class or trigger being executed. This field is required.
ExpirationDate
Type
dateTime
Properties
Create, Filter, Sort, Update
Description
The expiration date of the overlay action. This field is required.
IsDumpingHeap
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether a heap dump is generated (true) or not (false). To execute the ActionScript without generating a heap dump, set this field to false.

This field is required.
Iteration
Type
int
Properties
Create, Filter, Group, Sort, Update
Description
The number of times the specified line should execute before the heap dump is generated. This field is required.
Line
Type
int
Properties
Create, Filter, Group, Sort, Update
Description
The line number of the heap dump marker. This field is required.
ScopeId
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
The user who executed the action. This field is required.

Usage

When you are troubleshooting a runtime issue, you often want to find out more about the state of a variable or the state of the database, or create a specific condition to test your code. Use ApexExecutionOverlayAction to overlay a diagnostic output on an Apex class or trigger without compromising production code.