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).

    • trustStore

      @Deprecated(forRemoval=true, since="3.16.0") Optional<String> trustStore()
      Deprecated, for removal: This API element is subject to removal in a future version.
      This configuration property is deprecated. Consider using the Quarkus TLS registry. Set the desired TLS bucket name using the following configuration property: quarkus.smallrye-graphql-client."config-key".tls-bucket-name.
      The trust store location. Can point to either a classpath resource or a file.

    • trustStorePassword

      @Deprecated(forRemoval=true, since="3.16.0") Optional<String> trustStorePassword()
      Deprecated, for removal: This API element is subject to removal in a future version.
      This configuration property is deprecated. Consider using the Quarkus TLS registry. Set the desired TLS bucket name using the following configuration property: quarkus.smallrye-graphql-client."config-key".tls-bucket-name.
      The trust store password.

    • trustStoreType

      @Deprecated(forRemoval=true, since="3.16.0") Optional<String> trustStoreType()
      Deprecated, for removal: This API element is subject to removal in a future version.
      This configuration property is deprecated. Consider using the Quarkus TLS registry. Set the desired TLS bucket name using the following configuration property: quarkus.smallrye-graphql-client."config-key".tls-bucket-name.
      The type of the trust store. Defaults to "JKS".

    • keyStore

      @Deprecated(forRemoval=true, since="3.16.0") Optional<String> keyStore()
      Deprecated, for removal: This API element is subject to removal in a future version.
      This configuration property is deprecated. Consider using the Quarkus TLS registry. Set the desired TLS bucket name using the following configuration property: quarkus.smallrye-graphql-client."config-key".tls-bucket-name.
      The key store location. Can point to either a classpath resource or a file.

    • keyStorePassword

      @Deprecated(forRemoval=true, since="3.16.0") Optional<String> keyStorePassword()
      Deprecated, for removal: This API element is subject to removal in a future version.
      This configuration property is deprecated. Consider using the Quarkus TLS registry. Set the desired TLS bucket name using the following configuration property: quarkus.smallrye-graphql-client."config-key".tls-bucket-name.
      The key store password.

    • keyStoreType

      @Deprecated(forRemoval=true, since="3.16.0") Optional<String> keyStoreType()
      Deprecated, for removal: This API element is subject to removal in a future version.
      This configuration property is deprecated. Consider using the Quarkus TLS registry. Set the desired TLS bucket name using the following configuration property: quarkus.smallrye-graphql-client."config-key".tls-bucket-name.
      The type of the key store. Defaults to "JKS".

    • proxyHost

      Optional<String> proxyHost()
      Hostname of the proxy to use.

    • proxyPort

      OptionalInt proxyPort()
      Port number of the proxy to use.

    • proxyUsername

      Optional<String> proxyUsername()
      Username for the proxy to use.

    • proxyPassword

      Optional<String> proxyPassword()
      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.