google-api-ruby-client/generated/google/apis/script_v1/classes.rb

277 lines
12 KiB
Ruby

# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'date'
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module ScriptV1
# An object that provides information about the nature of an error resulting
# from an attempted execution of a script function using the Apps Script API.
# 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 a
# Status object. The `Status` object's `details` field
# contains an array with a single one of these `ExecutionError` objects.
class ExecutionError
include Google::Apis::Core::Hashable
# The error message thrown by Apps Script, usually localized into the user's
# language.
# Corresponds to the JSON property `errorMessage`
# @return [String]
attr_accessor :error_message
# The error type, for example `TypeError` or `ReferenceError`. If the error
# type is unavailable, this field is not included.
# Corresponds to the JSON property `errorType`
# @return [String]
attr_accessor :error_type
# An array of objects that provide a stack trace through the script to show
# where the execution failed, with the deepest call first.
# Corresponds to the JSON property `scriptStackTraceElements`
# @return [Array<Google::Apis::ScriptV1::ScriptStackTraceElement>]
attr_accessor :script_stack_trace_elements
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@error_message = args[:error_message] if args.key?(:error_message)
@error_type = args[:error_type] if args.key?(:error_type)
@script_stack_trace_elements = args[:script_stack_trace_elements] if args.key?(:script_stack_trace_elements)
end
end
# 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.
class ExecutionRequest
include Google::Apis::Core::Hashable
# 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 Apps Script API. Optional; default is `false`.
# Corresponds to the JSON property `devMode`
# @return [Boolean]
attr_accessor :dev_mode
alias_method :dev_mode?, :dev_mode
# 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`
# @return [String]
attr_accessor :function
# 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.
# Corresponds to the JSON property `parameters`
# @return [Array<Object>]
attr_accessor :parameters
# 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&mdash;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.
# Corresponds to the JSON property `sessionState`
# @return [String]
attr_accessor :session_state
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@dev_mode = args[:dev_mode] if args.key?(:dev_mode)
@function = args[:function] if args.key?(:function)
@parameters = args[:parameters] if args.key?(:parameters)
@session_state = args[:session_state] if args.key?(:session_state)
end
end
# An object that provides the return value of a function executed using the
# Apps Script API. If the script function returns successfully, the response
# body's response field contains this
# `ExecutionResponse` object.
class ExecutionResponse
include Google::Apis::Core::Hashable
# The return value of the script function. The type matches the object type
# returned in Apps Script. Functions called using the Apps Script API cannot
# return Apps Script-specific objects (such as a `Document` or a `Calendar`);
# they can only return primitive types such as a `string`, `number`, `array`,
# `object`, or `boolean`.
# Corresponds to the JSON property `result`
# @return [Object]
attr_accessor :result
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@result = args[:result] if args.key?(:result)
end
end
# 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](/apps-script/guides/services/quotas#
# current_limitations).
# <p>After the execution is 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 was asynchronous and has not yet completed,
# the done field is `false` and
# the neither the `response` nor `error` fields are present.</li>
# <li> 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.</li>
# </ul>
class Operation
include Google::Apis::Core::Hashable
# 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`
# @return [Boolean]
attr_accessor :done
alias_method :done?, :done
# 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`
# @return [Google::Apis::ScriptV1::Status]
attr_accessor :error
# If the script function returns successfully, this field contains an
# ExecutionResponse object with the function's return value.
# Corresponds to the JSON property `response`
# @return [Hash<String,Object>]
attr_accessor :response
def initialize(**args)
update!(**args)
end
# Update properties of this object
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
end
# A stack trace through the script that shows where the execution failed.
class ScriptStackTraceElement
include Google::Apis::Core::Hashable
# The name of the function that failed.
# Corresponds to the JSON property `function`
# @return [String]
attr_accessor :function
# The line number where the script failed.
# Corresponds to the JSON property `lineNumber`
# @return [Fixnum]
attr_accessor :line_number
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@function = args[:function] if args.key?(:function)
@line_number = args[:line_number] if args.key?(:line_number)
end
end
# 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.
class Status
include Google::Apis::Core::Hashable
# The status code. For this API, this value either:
# <ul> <li> 3, indicating an `INVALID_ARGUMENT` error, or</li> <li> 1,
# indicating a `CANCELLED` asynchronous execution.</li> </ul>
# Corresponds to the JSON property `code`
# @return [Fixnum]
attr_accessor :code
# An array that contains a single ExecutionError object that provides
# information about the nature of the error.
# Corresponds to the JSON property `details`
# @return [Array<Hash<String,Object>>]
attr_accessor :details
# A developer-facing error message, which is in English. Any user-facing error
# message is localized and sent in the [google.rpc.Status.details](google.rpc.
# Status.details) field, or localized by the client.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@details = args[:details] if args.key?(:details)
@message = args[:message] if args.key?(:message)
end
end
end
end
end