com.google.api.services.script.model

Class ExecutionRequest

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.script.model.ExecutionRequest

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

public final class ExecutionRequest
extends com.google.api.client.json.GenericJson

A request to run the function in a script. The script is identified by the specified `script_id`. Executing a function on a script returns results based on the implementation of the script.

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 Google Apps Script Execution 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

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
ExecutionRequest()

Method Summary

Methods

Modifier and Type	Method and Description
ExecutionRequest	clone()
java.lang.Boolean	getDevMode() 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.
java.lang.String	getFunction() The name of the function to execute in the given script.
java.util.List<java.lang.Object>	getParameters() The parameters to be passed to the function being executed.
java.lang.String	getSessionState() For Android add-ons only.
ExecutionRequest	set(java.lang.String fieldName, java.lang.Object value)
ExecutionRequest	setDevMode(java.lang.Boolean devMode) 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.
ExecutionRequest	setFunction(java.lang.String function) The name of the function to execute in the given script.
ExecutionRequest	setParameters(java.util.List<java.lang.Object> parameters) The parameters to be passed to the function being executed.
ExecutionRequest	setSessionState(java.lang.String sessionState) For Android add-ons only.

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

Methods inherited from class java.util.AbstractMap

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ExecutionRequest

public ExecutionRequest()

Method Detail

getDevMode

public java.lang.Boolean getDevMode()

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`.

Returns:

value or null for none

setDevMode

public ExecutionRequest setDevMode(java.lang.Boolean devMode)

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`.

Parameters:

devMode - devMode or null for none

getFunction

public java.lang.String getFunction()

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

Returns:

value or null for none

setFunction

public ExecutionRequest setFunction(java.lang.String function)

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

Parameters:

function - function or null for none

getParameters

public java.util.List<java.lang.Object> getParameters()

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

Returns:

value or null for none

setParameters

public ExecutionRequest setParameters(java.util.List<java.lang.Object> parameters)

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

Parameters:

parameters - parameters or null for none

getSessionState

public java.lang.String getSessionState()

For Android add-ons only. An ID that represents the user's current session in the Android app for Google Docs or Sheets, included as extra data in the [`Intent`](https://developer.android.com/guide/components/intents-filters.html) that launches the add-on. When an Android add-on is run with a session state, it gains the privileges of a [bound](https://developers.google.com/apps-script/guides/bound) script that is, it can access information like the user's current cursor position (in Docs) or selected cell (in Sheets). To retrieve the state, call `Intent.getStringExtra("com.google.android.apps.docs.addons.SessionState")`. Optional.

Returns:

value or null for none

setSessionState

public ExecutionRequest setSessionState(java.lang.String sessionState)

For Android add-ons only. An ID that represents the user's current session in the Android app for Google Docs or Sheets, included as extra data in the [`Intent`](https://developer.android.com/guide/components/intents-filters.html) that launches the add-on. When an Android add-on is run with a session state, it gains the privileges of a [bound](https://developers.google.com/apps-script/guides/bound) script that is, it can access information like the user's current cursor position (in Docs) or selected cell (in Sheets). To retrieve the state, call `Intent.getStringExtra("com.google.android.apps.docs.addons.SessionState")`. Optional.

Parameters:

sessionState - sessionState or null for none

set

public ExecutionRequest set(java.lang.String fieldName,
                   java.lang.Object value)

Overrides:

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

clone

public ExecutionRequest clone()

Overrides:

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