インターフェース ResponseError


public interface ResponseError
GraphQL レスポンスエラーを表します。
導入:
1.0.0
作成者:
Rossen Stoyanchev
  • 方法の概要

    修飾子と型
    メソッド
    説明
    graphql.ErrorClassification
    GraphQL Java に固有のエラーの分類を返します。
    GraphQL Java およびその他の実装固有のプロトコルエラー詳細拡張 ( getErrorType() など) を含むマップを返します。空の可能性があります。
    ListSE<graphql.language.SourceLocation>
    エラーをドキュメント内の特定のポイントに関連付けることができる場合、GraphQL ドキュメント内の場所のリストを返します。
    @Nullable StringSE
    開発者がエラーを理解して修正するためのガイドとして、エラーの説明を含むメッセージを返します。
    エラーが結果の特定のフィールドに関連付けられる場合は、エラーが発生したレスポンスフィールドへのパスを返します。それ以外の場合は、空のリストを返します。
    parsed path の文字列表現、またはエラーがフィールドに関連付けられていない場合は空の文字列を返します。
  • メソッドの詳細

    • getMessage

      @Nullable StringSE getMessage()
      開発者がエラーを理解して修正するためのガイドとして、エラーの説明を含むメッセージを返します。
    • getErrorType

      graphql.ErrorClassification getErrorType()
      GraphQL Java に固有のエラーの分類を返します。これは、レスポンスマップの "extensions" で直列化されます。
      関連事項:
    • getPath

      StringSE getPath()
      parsed path の文字列表現、またはエラーがフィールドに関連付けられていない場合は空の文字列を返します。

      パスの例:

       "hero"
       "hero.name"
       "hero.friends"
       "hero.friends[2]"
       "hero.friends[2].name"
       
    • getParsedPath

      ListSE<ObjectSE> getParsedPath()
      エラーが結果の特定のフィールドに関連付けられる場合は、エラーが発生したレスポンスフィールドへのパスを返します。それ以外の場合は、空のリストを返します。これにより、クライアントは null の結果が意図的なものかエラーによるものかを識別できます。

      このリストには、レスポンスのルートから始まり、エラーに関連付けられたフィールドで終わるパスセグメントが含まれます。フィールドを表すパスセグメントは文字列であり、リストインデックスを表すパスセグメントは 0 から始まる整数です。エラーがエイリアス化されたフィールドで発生した場合、パスはエイリアス化された名前を使用します。これは、リクエスト内ではなく、レスポンス内のパスを表すためです。

    • getLocations

      ListSE<graphql.language.SourceLocation> getLocations()
      エラーをドキュメント内の特定のポイントに関連付けることができる場合、GraphQL ドキュメント内の場所のリストを返します。各位置には行と列があり、どちらも正で、1 から始まり、関連する構文要素の開始を表します。
    • getExtensions

      MapSE<StringSE,ObjectSE> getExtensions()
      GraphQL Java およびその他の実装固有のプロトコルエラー詳細拡張 ( getErrorType() など) を含むマップを返します。空の可能性があります。