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 com.google.api.client.json.GenericJson

A representation of an execution of an Apps Script function started with run. The execution response does not arrive until the function finishes executing. The maximum execution runtime is listed in the [Apps Script quotas guide](/apps- script/guides/services/quotas#current_limitations). After execution has started, it can have one of four outcomes: - If the script function returns successfully, the response field contains 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 contains a Status object. The `Status` object's `details` field contains an array with a single ExecutionError object that provides information about the nature of the error. - If the execution has not yet completed, the done field is `false` and the neither the `response` nor `error` fields are present. - If the `run` call itself fails (for example, because of a malformed request or an authorization error), the method returns an HTTP response code in the 4XX range with a different format for the response body. Client libraries 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 Apps Script API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/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

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

Modifier and Type	Method and Description
Operation	clone()
Boolean	getDone() This field indicates whether 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 contains a Status object.
Map<String,Object>	getResponse() If the script function returns successfully, this field contains an ExecutionResponse object with the function's return value.
Operation	set(String fieldName, Object value)
Operation	setDone(Boolean done) This field indicates whether 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 contains a Status object.
Operation	setResponse(Map<String,Object> response) If the script function returns successfully, this field contains an ExecutionResponse object with the function's return value.

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, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Operation

public Operation()

Method Detail

getDone

public Boolean getDone()

This field indicates whether 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 indicates whether 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 contains a Status object. The `Status` object's `details` field contains 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 contains a Status object. The `Status` object's `details` field contains an array with a single ExecutionError object that provides information about the nature of the error.

Parameters:

error - error or null for none

getResponse

public Map<String,Object> getResponse()

If the script function returns successfully, this field contains an ExecutionResponse object with the function's return value.

Returns:

value or null for none

setResponse

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

If the script function returns successfully, this field contains an ExecutionResponse object with the function's return value.

Parameters:

response - response or null for none

set

public Operation set(String fieldName,
                     Object value)

Overrides:

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

clone

public Operation clone()

Overrides:

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