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



115
116
117
 
# File 'generated/google/apis/script_v1/classes.rb', line 115

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

Instance Attribute Details

#code ⇒ Fixnum

The status code. For this API, this value will always be 3, corresponding to an INVALID_ARGUMENT error. Corresponds to the JSON property code

Returns:

  • (Fixnum) 


113
114
115
 
# File 'generated/google/apis/script_v1/classes.rb', line 113

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


107
108
109
 
# File 'generated/google/apis/script_v1/classes.rb', line 107

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) 


101
102
103
 
# File 'generated/google/apis/script_v1/classes.rb', line 101

def message
  @message
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



120
121
122
123
124
 
# File 'generated/google/apis/script_v1/classes.rb', line 120

def update!(**args)
  @message = args[:message] if args.key?(:message)
  @details = args[:details] if args.key?(:details)
  @code = args[:code] if args.key?(:code)
end