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

ApexExecutionOverlayResult

Represents the result from the Apex code snippet or SOQL query defined in the associated ApexExecutionOverlayAction, and the resulting heap dump if one was returned.

Available from API version 28.0 or later.

Supported SOAP Calls

query(), retrieve(), delete()

Supported REST HTTP Methods

Query, GET, DELETE

Fields

Field Name Details
ActionScript
Type
string
Properties
Nillable
Description
The Apex code or SOQL query that was run.
ActionScriptType
Type
picklist
Properties
Filter, Group, Sort, Nillable
Description
Indicates whether the ActionScript is written in Apex or SOQL. Valid values are:
  • None
  • Apex
  • SOQL
ApexResult
Type
ApexResult
Properties
Nillable
Description
A complex type that represents the result of Apex code executed as part of an ApexExecutionOverlayAction, returned in an ApexExecutionOverlayResult.
ExpirationDate
Type
dateTime
Properties
Filter, Sort
Description
The expiration date of the overlay action.
HeapDump
Type
HeapDump
Properties
Nillable
Description
A complex type that represents a heap dump in an ApexExecutionOverlayResult. You can only have a single row when using HeapDump in SOQL. To select only one row, you can use a LIMIT=1 clause in your SOQL query, or you can list multiple rows for the user and have them select the row to inspect.
IsDumpingHeap
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether a heap dump was generated (true) or not (false).
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
Filter, Group, Sort, Nillable
Description
The line number of the checkpoint.
SOQLResult
Type
SOQLResult
Properties
Nillable
Description
A complex type that represents the result of a SOQL query in an ApexExecutionOverlayResult.
UserId
Type
reference
Properties
Filter, Group, Sort,
Description
The user who executed the action.

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, and use ApexExecutionOverlayResult to navigate the results.