Package io.quarkus.smallrye.graphql.client.runtime

Interface GraphQLClientConfig

public interface GraphQLClientConfig

  • Method Details

    • url

      Optional<String> url()
      The URL location of the target GraphQL service.

    • headers

      @WithName("header") @ConfigDocMapKey("header-name") Map<String,String> headers()
      HTTP headers to add when communicating with the target GraphQL service.

    • subprotocols

      @WithDefault("graphql-transport-ws") Optional<List<String>> subprotocols()
      WebSocket subprotocols that should be supported by this client for running GraphQL operations over websockets. Allowed values are: - `graphql-ws` for the deprecated Apollo protocol - `graphql-transport-ws` for the newer GraphQL over WebSocket protocol (default value) If multiple protocols are provided, the actual protocol to be used will be subject to negotiation with the server.

    • executeSingleResultOperationsOverWebsocket

      Optional<Boolean> executeSingleResultOperationsOverWebsocket()
      If true, then queries and mutations will run over the websocket transport rather than pure HTTP. Off by default, because it has higher overhead.

    • websocketInitializationTimeout

      OptionalInt websocketInitializationTimeout()
      Maximum time in milliseconds that will be allowed to wait for the server to acknowledge a websocket connection (send a subprotocol-specific ACK message).

    • proxyConfigurationName

      Optional<String> proxyConfigurationName()
      The name of the proxy configuration to use. This setting is ignored if proxy-host is set. If not set and the default proxy configuration is configured (quarkus.proxy.*) then that will be used. If the proxy configuration name is set, the configuration from quarkus.proxy.<name>.* will be used. If the proxy configuration name is set, but no proxy configuration is found with that name, then an error will be thrown at runtime.

    • proxyHost

      @Deprecated(since="3.31.0", forRemoval=true) Optional<String> proxyHost()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use proxy-configuration-name instead.
      Hostname of the proxy to use.

    • proxyPort

      @Deprecated(since="3.31.0", forRemoval=true) OptionalInt proxyPort()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use proxy-configuration-name instead.
      Port number of the proxy to use.

    • proxyUsername

      @Deprecated(since="3.31.0", forRemoval=true) Optional<String> proxyUsername()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use proxy-configuration-name instead.
      Username for the proxy to use.

    • proxyPassword

      @Deprecated(since="3.31.0", forRemoval=true) Optional<String> proxyPassword()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use proxy-configuration-name instead.
      Password for the proxy to use.

    • maxRedirects

      OptionalInt maxRedirects()
      Maximum number of redirects to follow.

    • initPayload

      @WithName("init-payload") @ConfigDocMapKey("property-name") Map<String,String> initPayload()
      Additional payload sent on websocket initialization.

    • allowUnexpectedResponseFields

      Optional<Boolean> allowUnexpectedResponseFields()
      Allowing unexpected fields in response. If true, there will be warning log of an unexpected field. Else it throws an error.

    • tlsConfigurationName

      Optional<String> tlsConfigurationName()
      The name of the TLS configuration (bucket) used for client authentication in the TLS registry.