GoogleApi.Script.V1.Model.Operation (google_api_script v0.19.0)
View SourceA 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. 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.
Attributes
-
done
(type:boolean()
, default:nil
) - This field indicates whether the script execution has completed. A completed execution has a populatedresponse
field containing the ExecutionResponse from function that was executed. -
error
(type:GoogleApi.Script.V1.Model.Status.t
, default:nil
) - If arun
call succeeds but the script function (or Apps Script itself) throws an exception, this field contains a Status object. TheStatus
object'sdetails
field contains an array with a single ExecutionError object that provides information about the nature of the error. -
response
(type:map()
, default:nil
) - If the script function returns successfully, this field contains an ExecutionResponse object with the function's return value.
Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Types
@type t() :: %GoogleApi.Script.V1.Model.Operation{ done: boolean() | nil, error: GoogleApi.Script.V1.Model.Status.t() | nil, response: map() | nil }