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

Class GraphQLClientConfig

java.lang.Object
io.quarkus.smallrye.graphql.client.runtime.GraphQLClientConfig
public class GraphQLClientConfig extends Object

  • Field Details

    • url

      @ConfigItem public Optional<String> url
      The URL location of the target GraphQL service.

    • headers

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

    • subprotocols

      @ConfigItem(defaultValue="graphql-transport-ws") public 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

      @ConfigItem public 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

      @ConfigItem public 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

      @ConfigItem @Deprecated(forRemoval=true, since="3.16.0") public 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."client-name".tls-bucket-name.
      The trust store location. Can point to either a classpath resource or a file.

    • trustStorePassword

      @ConfigItem @Deprecated(forRemoval=true, since="3.16.0") public 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."client-name".tls-bucket-name.
      The trust store password.

    • trustStoreType

      @ConfigItem @Deprecated(forRemoval=true, since="3.16.0") public 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."client-name".tls-bucket-name.
      The type of the trust store. Defaults to "JKS".

    • keyStore

      @ConfigItem @Deprecated(forRemoval=true, since="3.16.0") public 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."client-name".tls-bucket-name.
      The key store location. Can point to either a classpath resource or a file.

    • keyStorePassword

      @ConfigItem @Deprecated(forRemoval=true, since="3.16.0") public 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."client-name".tls-bucket-name.
      The key store password.

    • keyStoreType

      @ConfigItem @Deprecated(forRemoval=true, since="3.16.0") public 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."client-name".tls-bucket-name.
      The type of the key store. Defaults to "JKS".

    • proxyHost

      @ConfigItem public Optional<String> proxyHost
      Hostname of the proxy to use.

    • proxyPort

      @ConfigItem public OptionalInt proxyPort
      Port number of the proxy to use.

    • proxyUsername

      @ConfigItem public Optional<String> proxyUsername
      Username for the proxy to use.

    • proxyPassword

      @ConfigItem public Optional<String> proxyPassword
      Password for the proxy to use.

    • maxRedirects

      @ConfigItem public OptionalInt maxRedirects
      Maximum number of redirects to follow.

    • initPayload

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

    • allowUnexpectedResponseFields

      @ConfigItem public 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

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

  • Constructor Details

    • GraphQLClientConfig

      public GraphQLClientConfig()