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



1011
1012
1013
 
# File 'generated/google/apis/script_v1/classes.rb', line 1011

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

Instance Attribute Details

#code ⇒ Fixnum

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

  • 10, indicating a SCRIPT_TIMEOUT error,
  • 3, indicating an INVALID_ARGUMENT error, or< /li>
  • 1, indicating a CANCELLED execution.
Corresponds to the JSON property code

Returns:

  • (Fixnum) 


997
998
999
 
# File 'generated/google/apis/script_v1/classes.rb', line 997

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


1003
1004
1005
 
# File 'generated/google/apis/script_v1/classes.rb', line 1003

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 details field, or localized by the client. Corresponds to the JSON property message

Returns:

  • (String) 


1009
1010
1011
 
# File 'generated/google/apis/script_v1/classes.rb', line 1009

def message
  @message
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1016
1017
1018
1019
1020
 
# File 'generated/google/apis/script_v1/classes.rb', line 1016

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