Class: Google::Apis::ScriptV1::Status

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

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.

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

Returns a new instance of Status



263
264
265
 
# File 'generated/google/apis/script_v1/classes.rb', line 263

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

Instance Attribute Details

#code ⇒ Fixnum

The status code. For this API, this value either:

  • 3, indicating an `INVALID_ARGUMENT` error, or
  • 1, indicating a `CANCELLED` asynchronous execution.

Corresponds to the JSON property code

Returns:

  • (Fixnum) 


248
249
250
 
# File 'generated/google/apis/script_v1/classes.rb', line 248

def code
  @code
end

#details ⇒ Array<Hash<String,Object>>

An array that contains a single ExecutionError object that provides information about the nature of the error. Corresponds to the JSON property details

Returns:

  • (Array<Hash<String,Object>>) 


254
255
256
 
# File 'generated/google/apis/script_v1/classes.rb', line 254

def details
  @details
end

#message ⇒ String

A developer-facing error message, which is in English. Any user-facing error message is localized and sent in the google.rpc.Status.details field, or localized by the client. Corresponds to the JSON property message

Returns:

  • (String) 


261
262
263
 
# File 'generated/google/apis/script_v1/classes.rb', line 261

def message
  @message
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



268
269
270
271
272
 
# File 'generated/google/apis/script_v1/classes.rb', line 268

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