Package io.smallrye.graphql.client.typesafe.api

Interface TypesafeGraphQLClientBuilder

public interface TypesafeGraphQLClientBuilder

Use this builder, when you are not in a CDI context, i.e. when working with Java SE.

Method Summary

Modifier and Type	Method	Description
TypesafeGraphQLClientBuilder	allowUnexpectedResponseFields(boolean value)
<T> T	build(Class<T> apiClass)	Build the proxy for that api interface.
TypesafeGraphQLClientBuilder	configKey(String configKey)	The base key used to read configuration values.
default TypesafeGraphQLClientBuilder	endpoint(String endpoint)	The URL where the GraphQL service is listening
TypesafeGraphQLClientBuilder	endpoint(URI endpoint)	The URL where the GraphQL service is listening
TypesafeGraphQLClientBuilder	executeSingleOperationsOverWebsocket(boolean value)	If this is true, then queries and mutations will also be executed over a websocket connection rather than over pure HTTP.
TypesafeGraphQLClientBuilder	header(String name, String value)	Static header to send with all methods in this client.
default TypesafeGraphQLClientBuilder	headers(Map<String,String> headers)	Static headers to send with all methods in this client.
TypesafeGraphQLClientBuilder	initPayload(Map<String,Object> initPayload)	Static payload to send with initialization method on subscription.
static TypesafeGraphQLClientBuilder	newBuilder()
TypesafeGraphQLClientBuilder	subprotocols(WebsocketSubprotocol... subprotocols)
TypesafeGraphQLClientBuilder	websocketInitializationTimeout(Integer timeoutInMilliseconds)	Maximum time (in milliseconds) allowed between initializing a subscription websocket and receiving a subscription start acknowledgement from the server.
TypesafeGraphQLClientBuilder	websocketUrl(String url)	Path to the websocket endpoint.

Method Details

newBuilder

static TypesafeGraphQLClientBuilder newBuilder()

configKey

TypesafeGraphQLClientBuilder configKey(String configKey)

The base key used to read configuration values. Defaults to the fully qualified name of the API interface.

endpoint

default TypesafeGraphQLClientBuilder endpoint(String endpoint)

The URL where the GraphQL service is listening

endpoint

TypesafeGraphQLClientBuilder endpoint(URI endpoint)

The URL where the GraphQL service is listening

websocketUrl

TypesafeGraphQLClientBuilder websocketUrl(String url)

Path to the websocket endpoint. By default this is the regular HTTP endpoint with the protocol changed to `ws`.

executeSingleOperationsOverWebsocket

TypesafeGraphQLClientBuilder executeSingleOperationsOverWebsocket(boolean value)

If this is true, then queries and mutations will also be executed over a websocket connection rather than over pure HTTP. As this comes with higher overhead, it is false by default.

headers

default TypesafeGraphQLClientBuilder headers(Map<String,String> headers)

Static headers to send with all methods in this client.

See Also:

• Header
• AuthorizationHeader

header

TypesafeGraphQLClientBuilder header(String name,
 String value)

Static header to send with all methods in this client.

See Also:

• Header
• AuthorizationHeader

initPayload

TypesafeGraphQLClientBuilder initPayload(Map<String,Object> initPayload)

Static payload to send with initialization method on subscription.

subprotocols

TypesafeGraphQLClientBuilder subprotocols(WebsocketSubprotocol... subprotocols)

allowUnexpectedResponseFields

TypesafeGraphQLClientBuilder allowUnexpectedResponseFields(boolean value)

websocketInitializationTimeout

TypesafeGraphQLClientBuilder websocketInitializationTimeout(Integer timeoutInMilliseconds)

Maximum time (in milliseconds) allowed between initializing a subscription websocket and receiving a subscription start acknowledgement from the server.

build

<T> T build(Class<T> apiClass)

Build the proxy for that api interface.