Class GraphqlError

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, ExecuteGraphqlRead and IntrospectGraphql return Code.OK with a list of GraphqlError in response body. - Upon query execution error, ExecuteGraphql, ExecuteGraphqlRead, ExecuteMutation, ExecuteQuery, IntrospectGraphql, ImpersonateQuery and ImpersonateMutation all return Code.OK with a list of GraphqlError in response body.

Inheritance

object

GraphqlError

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.FirebaseDataConnect.v1beta.Data

Assembly: Google.Apis.FirebaseDataConnect.v1beta.dll

Syntax

public class GraphqlError : IDirectResponseSchema

Properties

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

Extensions

Additional error information.

Declaration

[JsonProperty("extensions")]
public virtual GraphqlErrorExtensions Extensions { get; set; }

Property Value

Type	Description
GraphqlErrorExtensions

Locations

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, IntrospectGraphql, ImpersonateQuery, ImpersonateMutation, 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.

Declaration

[JsonProperty("locations")]
public virtual IList<SourceLocation> Locations { get; set; }

Property Value

Type	Description
IList<SourceLocation>

Message

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

Declaration

[JsonProperty("message")]
public virtual string Message { get; set; }

Property Value

Type	Description
string

Path

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.

Declaration

[JsonProperty("path")]
public virtual IList<object> Path { get; set; }

Property Value

Type	Description
IList<object>

Implements

IDirectResponseSchema