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.

Version 

Introduced in API version 28.0.

Supported SOAP API Calls 

delete(), describeSObjects(), query(), retrieve()

Supported REST API Methods 

DELETE, GET, HEAD, Query

Fields 

ActionScript 

• Type: textarea

• Required: No

• Properties: Nillable

• Description: The Apex code or SOQL query that was run.

ActionScriptType 

• Type: picklist

• Required: No

• Properties: Filter, Group, Nillable, Restricted picklist, Sort

• Description: Indicates whether the ActionScript is written in Apex or SOQL.

• Possible values:

  • None — None

  • Apex — Apex

  • SOQL — SOQL

ApexResult 

• Type: complexvalue

• Required: No

• Properties: Nillable

• Description: A complex type that represents the result of Apex code executed as part of an ApexExecutionOverlayAction, returned in an ApexExecutionOverlayResult.

ClassName 

• Type: string
• Required: No
• Properties: Filter, Group, Nillable, Sort

ExpirationDate 

• Type: datetime

• Required: No

• Properties: Filter, Nillable, Sort

• Description: The expiration date of the overlay action.

HeapDump 

• Type: complexvalue

• Required: No

• Properties: Nillable

• Description: A complex type that represents a heap dump in an ApexExecutionOverlayResult object. 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

• Required: No

• Properties: Defaulted on create, Filter, Group, Sort

• Description: Indicates whether a heap dump was generated (true) or not (false).

• Default value: false

Iteration 

• Type: int

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The number of times the specified line should execute before the heap dump is generated. This field is required.

Line 

• Type: int

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The line number of the checkpoint.

Namespace 

• Type: string
• Required: No
• Properties: Filter, Group, Nillable, Sort

OverlayResultLength 

• Type: int
• Required: No
• Properties: Filter, Group, Nillable, Sort

RequestedById 

• Type: reference

• Required: No

• Properties: Filter, Group, Sort

• Relationship name: RequestedBy

• Relationship type: relationship

• Refers to: User

SOQLResult 

• Type: complexvalue

• Required: No

• Properties: Nillable

• Description: A complex type that represents the result of a SOQL query in an ApexExecutionOverlayResult object.

UserId 

• Type: reference

• Required: No

• Properties: Filter, Group, Sort

• Description: The user who executed the action.

• Relationship name: User

• Relationship type: polymorphic

• Refers to: User, SelfServiceUser

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.