クラス DgsGraphQlClient.RequestSpec

java.lang.ObjectSE
org.springframework.graphql.client.DgsGraphQlClient.RequestSpec
含まれているクラス:
DgsGraphQlClient

public final class DgsGraphQlClient.RequestSpec extends ObjectSE
GraphQL リクエストの入力を収集して実行するオプションを宣言します。
導入:
1.3.0
作成者:
Rossen Stoyanchev
  • メソッドの詳細

    • queryAlias

      public DgsGraphQlClient.RequestSpec queryAlias(StringSE queryAlias)
      現在のクエリのエイリアスを設定します。
      パラメーター:
      queryAlias - このクエリのエイリアス
      戻り値:
      同じビルダーインスタンス
    • projection

      public DgsGraphQlClient.RequestSpec projection(com.netflix.graphql.dgs.client.codegen.BaseProjectionNode projectionNode)
      レスポンス選択セットを定義する BaseProjectionNode を提供します。
      パラメーター:
      projectionNode - レスポンス選択セット
      戻り値:
      同じビルダーインスタンス
    • coercing

      public DgsGraphQlClient.RequestSpec coercing(ClassSE<?> scalarType, graphql.schema.Coercing<?,?> coercing)
      スカラー型の直列化用に Coercing を構成します。
      パラメーター:
      scalarType - スカラー型
      coercing - このスカラーの強制関数
      戻り値:
      同じビルダーインスタンス
    • coercing

      public DgsGraphQlClient.RequestSpec coercing(MapSE<ClassSE<?>, graphql.schema.Coercing<?,?>> coercingMap)
      スカラー型の直列化用に Coercing を構成します。
      パラメーター:
      coercingMap - 強制関数のマップ
      戻り値:
      同じビルダーインスタンス
    • attribute

      public DgsGraphQlClient.RequestSpec attribute(StringSE name, ObjectSE value)
      クライアントリクエスト属性を設定します。

      これは純粋にクライアント側のリクエスト処理用です。つまり、GraphQlClientInterceptor チェーン全体で使用できますが、送信されません。

      パラメーター:
      name - 属性名
      value - 属性値
      戻り値:
      同じビルダーインスタンス
    • attributes

      public DgsGraphQlClient.RequestSpec attributes(ConsumerSE<MapSE<StringSE,ObjectSE>> attributesConsumer)
      クライアントリクエスト属性を操作します。コンシューマーに提供されるマップは「ライブ」であるため、コンシューマーはそれに応じて属性をインスペクションおよび変更できます。
      パラメーター:
      attributesConsumer - リクエスト属性を操作するコンシューマー
      戻り値:
      同じビルダーインスタンス
    • request

      public DgsGraphQlClient.RequestSpec request(com.netflix.graphql.dgs.client.codegen.GraphQLQuery query)
      指定された GraphQLQuery に対して追加の GraphQL リクエストを定義し、結果として GraphQLMultiQueryRequest が送信されます。
      パラメーター:
      query - GraphQL クエリ
      関連事項:
    • retrieveSync

      public GraphQlClient.RetrieveSyncSpec retrieveSync()
      GraphQLQueryRequest を作成し、それを送信用の文字列ドキュメントに直列化して、ラップされた GraphQlClient に委譲します。

      詳細については、デリゲートメソッド GraphQlClient.RequestSpec.retrieveSync(String) の Javadoc を参照してください。使用されるパスは operationName です。

    • retrieveSync

      public GraphQlClient.RetrieveSyncSpec retrieveSync(StringSE path)
      「データ」キーを基準とした明示的なパスを持つ executeSync() のバリアント。
      パラメーター:
      path - 「データ」キーを基準とした JSON パス
    • retrieve

      public GraphQlClient.RetrieveSpec retrieve()
      GraphQLQueryRequest を作成し、それを送信用の文字列ドキュメントに直列化して、ラップされた GraphQlClient に委譲します。

      詳細については、デリゲートメソッド GraphQlClient.RequestSpec.retrieve(String) の Javadoc を参照してください。使用されるパスは operationName です。

    • retrieve

      public GraphQlClient.RetrieveSpec retrieve(StringSE path)
      「データ」キーを基準とした明示的なパスを持つ retrieve() のバリアント。
      パラメーター:
      path - 「データ」キーを基準とした JSON パス
    • retrieveSubscription

      public GraphQlClient.RetrieveSubscriptionSpec retrieveSubscription()
      GraphQLQueryRequest を作成し、それを送信用の文字列ドキュメントに直列化して、ラップされた GraphQlClient に委譲します。

      詳細については、デリゲートメソッド GraphQlClient.RequestSpec.retrieveSubscription(String) の Javadoc を参照してください。使用されるパスは operationName です。

    • executeSync

      public ClientGraphQlResponse executeSync()
      GraphQLQueryRequest を作成し、それを送信用の文字列ドキュメントに直列化して、ラップされた GraphQlClient に委譲します。

      詳細については、デリゲートメソッド GraphQlClient.RequestSpec.executeSync() の Javadoc を参照してください。

    • execute

      public reactor.core.publisher.Mono<ClientGraphQlResponse> execute()
      GraphQLQueryRequest を作成し、それを送信用の文字列ドキュメントに直列化して、ラップされた GraphQlClient に委譲します。

      詳細については、デリゲートメソッド GraphQlClient.RequestSpec.execute() の Javadoc を参照してください。

    • executeSubscription

      public reactor.core.publisher.Flux<ClientGraphQlResponse> executeSubscription()
      GraphQLQueryRequest を作成し、それを送信用の文字列ドキュメントに直列化して、ラップされた GraphQlClient に委譲します。

      詳細については、デリゲートメソッド GraphQlClient.RequestSpec.executeSubscription() の Javadoc を参照してください。