Class: Google::Apis::ScriptV1::ExecutionRequest

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 request to run the function in a script. The script is identified by the specified script_id. Executing a function on a script will return results based on the implementation of the script.

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) ⇒ ExecutionRequest

Returns a new instance of ExecutionRequest.



59
60
61
 
# File 'generated/google/apis/script_v1/classes.rb', line 59

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

Instance Attribute Details

#dev_mode ⇒ Boolean Also known as: dev_mode?

If true and the user is an owner of the script, the script runs at the most recently saved version rather than the version deployed for use with the Execution API. Optional; default is false. Corresponds to the JSON property devMode

Returns:

  • (Boolean) 


56
57
58
 
# File 'generated/google/apis/script_v1/classes.rb', line 56

def dev_mode
  @dev_mode
end

#function ⇒ String

The name of the function to execute in the given script. The name does not include parentheses or parameters. Corresponds to the JSON property function

Returns:

  • (String) 


35
36
37
 
# File 'generated/google/apis/script_v1/classes.rb', line 35

def function
  @function
end

#parameters ⇒ Array<Object>

The parameters to be passed to the function being executed. The type for each parameter should match the expected type in Apps Script. Parameters cannot be Apps Script-specific objects (such as a Document or Calendar); they can only be primitive types such as a string, number, array, object, or boolean. Optional. Corresponds to the JSON property parameters

Returns:

  • (Array<Object>) 


44
45
46
 
# File 'generated/google/apis/script_v1/classes.rb', line 44

def parameters
  @parameters
end

#session_state ⇒ String

This field is not used. Corresponds to the JSON property sessionState

Returns:

  • (String) 


49
50
51
 
# File 'generated/google/apis/script_v1/classes.rb', line 49

def session_state
  @session_state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



64
65
66
67
68
69
 
# File 'generated/google/apis/script_v1/classes.rb', line 64

def update!(**args)
  @function = args[:function] if args.key?(:function)
  @parameters = args[:parameters] if args.key?(:parameters)
  @session_state = args[:session_state] if args.key?(:session_state)
  @dev_mode = args[:dev_mode] if args.key?(:dev_mode)
end