google_api_script v0.3.0 GoogleApi.Script.V1.Model.Operation View Source
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. <p>After execution has started, it can have one of four outcomes:</p> <ul> <li> 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.</li> <li> 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.</li> <li> If the execution has not yet completed, the done field is `false` and the neither the `response` nor `error` fields are present.</li> <li> 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.</li> </ul>
Attributes
- done (boolean()): 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. Defaults to:
null
. - error (Status): 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. Defaults to:
null
. - response (%{optional(String.t) => String.t}): If the script function returns successfully, this field contains an ExecutionResponse object with the function's return value. Defaults to:
null
.
Link to this section Summary
Functions
Unwrap a decoded JSON object into its complex fields
Link to this section Types
t()
View Source
t() :: %GoogleApi.Script.V1.Model.Operation{
done: any(),
error: GoogleApi.Script.V1.Model.Status.t(),
response: map()
}
t() :: %GoogleApi.Script.V1.Model.Operation{ done: any(), error: GoogleApi.Script.V1.Model.Status.t(), response: map() }
Link to this section Functions
decode(value, options) View Source
Unwrap a decoded JSON object into its complex fields.