クラス DefaultExecutionGraphQlResponse

java.lang.ObjectSE
org.springframework.graphql.support.AbstractGraphQlResponse
org.springframework.graphql.support.DefaultExecutionGraphQlResponse
実装済みのインターフェース一覧:
ExecutionGraphQlResponse, GraphQlResponse
既知の直属サブクラス
RSocketGraphQlResponse, WebGraphQlResponse
public class DefaultExecutionGraphQlResponse extends AbstractGraphQlResponse implements ExecutionGraphQlResponse
GraphQL から返された ExecutionResult をラップし、渡された実際の ExecutionInput インスタンスも公開する、サーバー用の GraphQlResponse。
導入:
1.0.0
作成者:
Rossen Stoyanchev

  • コンストラクターの詳細

    • DefaultExecutionGraphQlResponse

      public DefaultExecutionGraphQlResponse(graphql.ExecutionInput input, graphql.ExecutionResult result)
      初期インスタンスを作成するコンストラクター。
      パラメーター:
      input - この GraphQL 操作の実行入力
      result - この GraphQL 操作の実行結果

    • DefaultExecutionGraphQlResponse

      protected DefaultExecutionGraphQlResponse(ExecutionGraphQlResponse response)
      トランスポート固有のサブクラスから再ラップするコンストラクター。
      パラメーター:
      response - 実行レスポンス

  • メソッドの詳細

    • getExecutionInput

      public graphql.ExecutionInput getExecutionInput()
      インターフェースからコピーされた説明: ExecutionGraphQlResponse
      ExecutionGraphQlRequest を通じて準備され、GraphQL に渡された ExecutionInput を返します。
      次で指定:
      インターフェース ExecutionGraphQlResponse の getExecutionInput 

    • getExecutionResult

      public graphql.ExecutionResult getExecutionResult()
      インターフェースからコピーされた説明: ExecutionGraphQlResponse
      呼び出しから返された ExecutionResult を GraphQL に返します。
      次で指定:
      インターフェース ExecutionGraphQlResponse の getExecutionResult 

    • isValid

      public boolean isValid()
      インターフェースからコピーされた説明: GraphQlResponse
      レスポンスが有効かどうか。次の 2 つのケースのいずれかの場合、レスポンスは無効です。
      • response map には、実行前にエラーを示す「データ」エントリがありません。文法の解析と検証
      • 「データ」エントリには、有効なレスポンスを妨げた実行中のエラーを示す null 値があります

      有効なレスポンスには non-null 値を持つ「データ」キーがありますが、まだ部分的であり、フィールドエラーのために一部のフィールドが null に設定されている可能性があります。

      詳細については、GraphQL 仕様のセクション 7「レスポンス」を参照してください。

      次で指定:
      インターフェース GraphQlResponse の isValid 

    • getData

      public <T> @Nullable T getData()
      インターフェースからコピーされた説明: GraphQlResponse
      レスポンスのデータ部分を返すか、レスポンスが valid でない場合は null を返します。
      次で指定:
      インターフェース GraphQlResponse の getData 
      型パラメーター:
      T - マップまたはリスト

    • getErrors

      public ListSE<ResponseError> getErrors()
      インターフェースからコピーされた説明: GraphQlResponse
      レスポンスに含まれるエラーを返します。

      valid ではないレスポンスには、「リクエストエラー」が含まれます。これらはリクエスト全体に適用されるエラーで、空のエラー path があります。

      有効なレスポンスはまだ部分的であり、「フィールドエラー」が含まれている可能性があります。これらは、エラーパスを介して特定のフィールドに関連付けられたエラーです。

      次で指定:
      インターフェース GraphQlResponse の getErrors 

    • getExtensions

      public MapSE<ObjectSE,ObjectSE> getExtensions()
      インターフェースからコピーされた説明: GraphQlResponse
      もしあれば、実装者固有のプロトコル拡張を返します。
      次で指定:
      インターフェース GraphQlResponse の getExtensions 

    • toMap

      public MapSE<StringSE,ObjectSE> toMap()
      インターフェースからコピーされた説明: GraphQlResponse
      GraphQL 仕様の「レスポンス」セクションで要求されているようにフォーマットされた、レスポンスのマップ表現を返します。
      次で指定:
      インターフェース GraphQlResponse の toMap 

    • toString

      public StringSE toString()
      オーバーライド:
      クラス ObjectSE の toString