com.google.api.services.script.model

Class ExecutionError

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.script.model.ExecutionError

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class ExecutionError
extends GenericJson

An object that provides information about the nature of an error resulting from an attempted execution of a script function using the Apps Script API. If a run call succeeds but the script function (or Apps Script itself) throws an exception, the response body's error field contains a Status object. The `Status` object's `details` field contains an array with a single one of these `ExecutionError` objects.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Google Apps Script API. For a detailed explanation see: http://code.google.com/p/google-http-java-client/wiki/JSON

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
ExecutionError()

Method Summary

Methods

Modifier and Type	Method and Description
ExecutionError	clone()
String	getErrorMessage() The error message thrown by Apps Script, usually localized into the user's language.
String	getErrorType() The error type, for example `TypeError` or `ReferenceError`.
List<ScriptStackTraceElement>	getScriptStackTraceElements() An array of objects that provide a stack trace through the script to show where the execution failed, with the deepest call first.
ExecutionError	set(String fieldName, Object value)
ExecutionError	setErrorMessage(String errorMessage) The error message thrown by Apps Script, usually localized into the user's language.
ExecutionError	setErrorType(String errorType) The error type, for example `TypeError` or `ReferenceError`.
ExecutionError	setScriptStackTraceElements(List<ScriptStackTraceElement> scriptStackTraceElements) An array of objects that provide a stack trace through the script to show where the execution failed, with the deepest call first.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ExecutionError

public ExecutionError()

Method Detail

getErrorMessage

public String getErrorMessage()

The error message thrown by Apps Script, usually localized into the user's language.

Returns:

value or null for none

setErrorMessage

public ExecutionError setErrorMessage(String errorMessage)

The error message thrown by Apps Script, usually localized into the user's language.

Parameters:

errorMessage - errorMessage or null for none

getErrorType

public String getErrorType()

The error type, for example `TypeError` or `ReferenceError`. If the error type is unavailable, this field is not included.

Returns:

value or null for none

setErrorType

public ExecutionError setErrorType(String errorType)

The error type, for example `TypeError` or `ReferenceError`. If the error type is unavailable, this field is not included.

Parameters:

errorType - errorType or null for none

getScriptStackTraceElements

public List<ScriptStackTraceElement> getScriptStackTraceElements()

An array of objects that provide a stack trace through the script to show where the execution failed, with the deepest call first.

Returns:

value or null for none

setScriptStackTraceElements

public ExecutionError setScriptStackTraceElements(List<ScriptStackTraceElement> scriptStackTraceElements)

An array of objects that provide a stack trace through the script to show where the execution failed, with the deepest call first.

Parameters:

scriptStackTraceElements - scriptStackTraceElements or null for none

set

public ExecutionError set(String fieldName,
                 Object value)

Overrides:

set in class GenericJson

clone

public ExecutionError clone()

Overrides:

clone in class GenericJson