Class: Google::Apis::FirebasedataconnectV1beta::GraphqlError

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/firebasedataconnect_v1beta/classes.rb,
lib/google/apis/firebasedataconnect_v1beta/representations.rb,
lib/google/apis/firebasedataconnect_v1beta/representations.rb

Overview

GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/ draft/#sec-Errors Firebase Data Connect API surfaces GraphqlError in various APIs: - Upon compile error, UpdateSchema and UpdateConnector return Code. Invalid_Argument with a list of GraphqlError in error details. - Upon query compile error, ExecuteGraphql and ExecuteGraphqlRead return Code.OK with a list of GraphqlError in response body. - Upon query execution error, ExecuteGraphql, ExecuteGraphqlRead, ExecuteMutation and ExecuteQuery all return Code.OK with a list of GraphqlError in response body.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GraphqlError

Returns a new instance of GraphqlError.



344
345
346
 
# File 'lib/google/apis/firebasedataconnect_v1beta/classes.rb', line 344

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

Instance Attribute Details

#extensions ⇒ Google::Apis::FirebasedataconnectV1beta::GraphqlErrorExtensions

GraphqlErrorExtensions contains additional information of GraphqlError. Corresponds to the JSON property extensions

Returns:



318
319
320
 
# File 'lib/google/apis/firebasedataconnect_v1beta/classes.rb', line 318

def extensions
  @extensions
end

#locations ⇒ Array<Google::Apis::FirebasedataconnectV1beta::SourceLocation>

The source locations where the error occurred. Locations should help developers and toolings identify the source of error quickly. Included in admin endpoints (ExecuteGraphql, ExecuteGraphqlRead, UpdateSchema and UpdateConnector) to reference the provided GraphQL GQL document. Omitted in ExecuteMutation and ExecuteQuery since the caller shouldn't have access access the underlying GQL source. Corresponds to the JSON property locations

Returns:



328
329
330
 
# File 'lib/google/apis/firebasedataconnect_v1beta/classes.rb', line 328

def locations
  @locations
end

#message ⇒ String

The detailed error message. The message should help developer understand the underlying problem without leaking internal data. Corresponds to the JSON property message

Returns:

  • (String) 


334
335
336
 
# File 'lib/google/apis/firebasedataconnect_v1beta/classes.rb', line 334

def message
  @message
end

#path ⇒ Array<Object>

The result field which could not be populated due to error. Clients can use path to identify whether a null result is intentional or caused by a runtime error. It should be a list of string or index from the root of GraphQL query document. Corresponds to the JSON property path

Returns:

  • (Array<Object>) 


342
343
344
 
# File 'lib/google/apis/firebasedataconnect_v1beta/classes.rb', line 342

def path
  @path
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



349
350
351
352
353
354
 
# File 'lib/google/apis/firebasedataconnect_v1beta/classes.rb', line 349

def update!(**args)
  @extensions = args[:extensions] if args.key?(:extensions)
  @locations = args[:locations] if args.key?(:locations)
  @message = args[:message] if args.key?(:message)
  @path = args[:path] if args.key?(:path)
end