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

Constructor Details

#initialize(**args) ⇒ Status

Returns a new instance of Status.



1040
1041
1042
 
# File 'generated/google/apis/script_v1/classes.rb', line 1040

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 - 1, indicating a CANCELLED execution. Corresponds to the JSON property code

Returns:

  • (Fixnum) 


1026
1027
1028
 
# File 'generated/google/apis/script_v1/classes.rb', line 1026

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


1032
1033
1034
 
# File 'generated/google/apis/script_v1/classes.rb', line 1032

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) 


1038
1039
1040
 
# File 'generated/google/apis/script_v1/classes.rb', line 1038

def message
  @message
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1045
1046
1047
1048
1049
 
# File 'generated/google/apis/script_v1/classes.rb', line 1045

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