com.google.api.services.script.model

Class Operation

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.Operation

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Operation
extends GenericJson

The response will not arrive until the function finishes executing. The maximum runtime is listed in the guide to [limitations in Apps Script](https://developers.google.com/apps- script/guides/services/quotas#current_limitations). If the script function returns successfully, the `response` field will contain an `ExecutionResponse` object with the function's return value in the object's `result` field. If the script function (or Apps Script itself) throws an exception, the `error` field will contain a `Status` object. The `Status` object's `details` field will contain an array with a single `ExecutionError` object that provides information about the nature of the error. If the `run` call itself fails (for example, because of a malformed request or an authorization error), the method will return an HTTP response code in the 4XX range with a different format for the response body. Client libraries will automatically convert a 4XX response into an exception class.

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

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
Operation()

Method Summary

Methods

Modifier and Type	Method and Description
Operation	clone()
Boolean	getDone() This field is only used with asynchronous executions and indicates whether or not the script execution has completed.
Status	getError() If a `run` call succeeds but the script function (or Apps Script itself) throws an exception, this field will contain a `Status` object.
Map<String,Object>	getMetadata() This field is not used.
Map<String,Object>	getResponse() If the script function returns successfully, this field will contain an `ExecutionResponse` object with the function's return value as the object's `result` field.
Operation	set(String fieldName, Object value)
Operation	setDone(Boolean done) This field is only used with asynchronous executions and indicates whether or not the script execution has completed.
Operation	setError(Status error) If a `run` call succeeds but the script function (or Apps Script itself) throws an exception, this field will contain a `Status` object.
Operation	setMetadata(Map<String,Object> metadata) This field is not used.
Operation	setResponse(Map<String,Object> response) If the script function returns successfully, this field will contain an `ExecutionResponse` object with the function's return value as the object's `result` field.

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

Operation

public Operation()

Method Detail

getDone

public Boolean getDone()

This field is only used with asynchronous executions and indicates whether or not the script execution has completed. A completed execution has a populated response field containing the `ExecutionResponse` from function that was executed.

Returns:

value or null for none

setDone

public Operation setDone(Boolean done)

This field is only used with asynchronous executions and indicates whether or not the script execution has completed. A completed execution has a populated response field containing the `ExecutionResponse` from function that was executed.

Parameters:

done - done or null for none

getError

public Status getError()

If a `run` call succeeds but the script function (or Apps Script itself) throws an exception, this field will contain a `Status` object. The `Status` object's `details` field will contain an array with a single `ExecutionError` object that provides information about the nature of the error.

Returns:

value or null for none

setError

public Operation setError(Status error)

If a `run` call succeeds but the script function (or Apps Script itself) throws an exception, this field will contain a `Status` object. The `Status` object's `details` field will contain an array with a single `ExecutionError` object that provides information about the nature of the error.

Parameters:

error - error or null for none

getMetadata

public Map<String,Object> getMetadata()

This field is not used.

Returns:

value or null for none

setMetadata

public Operation setMetadata(Map<String,Object> metadata)

This field is not used.

Parameters:

metadata - metadata or null for none

getResponse

public Map<String,Object> getResponse()

If the script function returns successfully, this field will contain an `ExecutionResponse` object with the function's return value as the object's `result` field.

Returns:

value or null for none

setResponse

public Operation setResponse(Map<String,Object> response)

If the script function returns successfully, this field will contain an `ExecutionResponse` object with the function's return value as the object's `result` field.

Parameters:

response - response or null for none

set

public Operation set(String fieldName,
            Object value)

Overrides:

set in class GenericJson

clone

public Operation clone()

Overrides:

clone in class GenericJson