インターフェース ExecutionGraphQlRequest

すべてのスーパーインターフェース:
GraphQlRequest
すべての既知の実装クラス:
DefaultExecutionGraphQlRequest、RSocketGraphQlRequest、WebGraphQlRequest、WebSocketGraphQlRequest
public interface ExecutionGraphQlRequest extends GraphQlRequest
GraphQL に渡される ExecutionInput のカスタマイズをサポートする、GraphQL Java によるリクエスト処理用の GraphQlRequest の実装。
導入:
1.0.0
作成者:
Rossen Stoyanchev, Brian Clozel

  • 方法の概要

    修飾子と型
    メソッド
    説明
    void
    configureExecutionInput(BiFunctionSE<graphql.ExecutionInput, graphql.ExecutionInput.Builder, graphql.ExecutionInput> configurer)
    GraphQL に渡される ExecutionInput を初期化するために BiFunction を提供します。
    void
    executionId(graphql.execution.ExecutionId executionId)
    ExecutionId を ExecutionInput.getExecutionId() に設定するように構成し、トランスポートに割り当てられた id を上書きします。
    @Nullable graphql.execution.ExecutionId
    getExecutionId()
    設定された executionId を返します。
    StringSE
    getId()
    executionId を設定するリクエストのトランスポート割り当て ID を返します。
    @Nullable LocaleSE
    getLocale()
    トランスポートに割り当てられたロケール値があれば、それを返します。
    graphql.ExecutionInput
    toExecutionInput()
    GraphQL に渡す ExecutionInput を作成します。

    インターフェース org.springframework.graphql.GraphQlRequest から継承されたメソッド

    getDocument, getExtensions, getOperationName, getVariables, toMap

  • メソッドの詳細

    • getId

      StringSE getId()
      executionId を設定するリクエストのトランスポート割り当て ID を返します。

      デフォルトでは、id は次のように初期化されます。

      • WebFlux では、これは WebFlux ログメッセージに関連する ServerHttpRequest ID です。Reactor Netty の場合は、サーバーログメッセージにも関連付けられます。
      • Spring MVC では、ID は AlternativeJdkIdGenerator を介して生成されます。これは何とも相関しませんが、UUID.randomUUID() に依存するデフォルトの ExecutionIdProvider よりも効率的です。
      • WebSocket では、ID は、WebSocket でリクエストメッセージとレスポンスメッセージを関連付けるために使用される WebSocket プロトコルを介した GraphQL からの "subscribe" メッセージのメッセージ ID に設定されます。

      この ID をオーバーライドするには、executionId(ExecutionId) を使用するか、ExecutionIdProvider を使用して GraphQL を構成します。

      戻り値:
      リクエスト ID

    • executionId

      void executionId(graphql.execution.ExecutionId executionId)
      ExecutionId を ExecutionInput.getExecutionId() に設定するように構成し、トランスポートに割り当てられた id を上書きします。
      パラメーター:
      executionId - 使用する ID

    • getExecutionId

      @Nullable graphql.execution.ExecutionId getExecutionId()
      設定された executionId を返します。

    • getLocale

      @Nullable LocaleSE getLocale()
      トランスポートに割り当てられたロケール値があれば、それを返します。

    • configureExecutionInput

      void configureExecutionInput(BiFunctionSE<graphql.ExecutionInput, graphql.ExecutionInput.Builder, graphql.ExecutionInput> configurer)
      GraphQL に渡される ExecutionInput を初期化するために、BiFunction を指定します。ExecutionInput にはまず "this" と ExecutionGraphQlRequest の値が事前に入力され、その後、ここで提供される関数を使用してカスタマイズされます。
      パラメーター:
      configurer - これまでに初期化された ExecutionInput を受け入れる BiFunction と、それをカスタマイズするためのビルダー。

    • toExecutionInput

      graphql.ExecutionInput toExecutionInput()
      GraphQL に渡す ExecutionInput を作成します。GraphQL に渡されます。ExecutionInput には "this" と ExecutionGraphQlRequest の値が設定され、その後 configureExecutionInput(BiFunction) から提供される関数でカスタマイズされます。
      戻り値:
      結果の ExecutionInput