com.google.api.services.script.model

Class ExecutionResponse

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.script.model.ExecutionResponse

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

public final class ExecutionResponse
extends com.google.api.client.json.GenericJson

An object that provides the return value of a function executed through the Apps Script Execution API. If an `run` call succeeds and the script function returns successfully, the response body's `response` field will contain this `ExecutionResponse` object.

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 Execution 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

com.google.api.client.util.GenericData.Flags

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

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

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

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
ExecutionResponse()

Method Summary

Methods

Modifier and Type	Method and Description
ExecutionResponse	clone()
java.lang.Object	getResult() The return value of the script function.
java.lang.String	getStatus()
ExecutionResponse	set(java.lang.String fieldName, java.lang.Object value)
ExecutionResponse	setResult(java.lang.Object result) The return value of the script function.
ExecutionResponse	setStatus(java.lang.String status)

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

ExecutionResponse

public ExecutionResponse()

Method Detail

getResult

public java.lang.Object getResult()

The return value of the script function. The type will match the type returned in Apps Script. Functions called through the Execution API cannot return Apps Script-specific objects (such as a `Document` or `Calendar`); they can only return primitive types such as a `string`, `number`, `array`, `object`, or `boolean`.

Returns:

value or null for none

setResult

public ExecutionResponse setResult(java.lang.Object result)

The return value of the script function. The type will match the type returned in Apps Script. Functions called through the Execution API cannot return Apps Script-specific objects (such as a `Document` or `Calendar`); they can only return primitive types such as a `string`, `number`, `array`, `object`, or `boolean`.

Parameters:

result - result or null for none

getStatus

public java.lang.String getStatus()

Returns:

value or null for none

setStatus

public ExecutionResponse setStatus(java.lang.String status)

Parameters:

status - status or null for none

set

public ExecutionResponse set(java.lang.String fieldName,
                    java.lang.Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public ExecutionResponse clone()

Overrides:

clone in class com.google.api.client.json.GenericJson