Class: Google::Apis::ScriptV1::Operation

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/script_v1/classes.rb,
generated/google/apis/script_v1/representations.rb,
generated/google/apis/script_v1/representations.rb

Overview

A representation of a execution of an Apps Script function that is started using run or runAsync. The execution response does not arrive until the function finishes executing. The maximum execution runtime is listed in the Apps Script quotas guide.

After the execution is 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 was asynchronous and has not yet completed, the done field is `false` and the neither the `response` nor `error` fields are present.
  • If the `run` or `runAsync` 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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Operation

Returns a new instance of Operation



200
201
202
 
# File 'generated/google/apis/script_v1/classes.rb', line 200

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#done ⇒ Boolean Also known as: done?

This field is only used with asynchronous executions. It indicates whether the script execution has completed. A completed execution has a populated response field containing the ExecutionResponse from function that was executed. Corresponds to the JSON property done

Returns:

  • (Boolean) 


184
185
186
 
# File 'generated/google/apis/script_v1/classes.rb', line 184

def done
  @done
end

#error ⇒ Google::Apis::ScriptV1::Status

If a run or runAsync call succeeds but the script function (or Apps Script itself) throws an exception, the response body's error field contains this Status object. Corresponds to the JSON property error

Returns:



192
193
194
 
# File 'generated/google/apis/script_v1/classes.rb', line 192

def error
  @error
end

#response ⇒ Hash<String,Object>

If the script function returns successfully, this field contains an ExecutionResponse object with the function's return value. Corresponds to the JSON property response

Returns:

  • (Hash<String,Object>) 


198
199
200
 
# File 'generated/google/apis/script_v1/classes.rb', line 198

def response
  @response
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



205
206
207
208
209
 
# File 'generated/google/apis/script_v1/classes.rb', line 205

def update!(**args)
  @done = args[:done] if args.key?(:done)
  @error = args[:error] if args.key?(:error)
  @response = args[:response] if args.key?(:response)
end