Interface TypesafeGraphQLClientBuilder
-
public interface TypesafeGraphQLClientBuilderUse this builder, when you are not in a CDI context, i.e. when working with Java SE.
-
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description TypesafeGraphQLClientBuilderallowUnexpectedResponseFields(boolean value)<T> Tbuild(Class<T> apiClass)Build the proxy for that api interface.TypesafeGraphQLClientBuilderconfigKey(String configKey)The base key used to read configuration values.default TypesafeGraphQLClientBuilderendpoint(String endpoint)The URL where the GraphQL service is listeningTypesafeGraphQLClientBuilderendpoint(URI endpoint)The URL where the GraphQL service is listeningTypesafeGraphQLClientBuilderexecuteSingleOperationsOverWebsocket(boolean value)If this is true, then queries and mutations will also be executed over a websocket connection rather than over pure HTTP.TypesafeGraphQLClientBuilderheader(String name, String value)Static header to send with all methods in this client.default TypesafeGraphQLClientBuilderheaders(Map<String,String> headers)Static headers to send with all methods in this client.TypesafeGraphQLClientBuilderinitPayload(Map<String,Object> initPayload)Static payload to send with initialization method on subscription.static TypesafeGraphQLClientBuildernewBuilder()TypesafeGraphQLClientBuildersubprotocols(WebsocketSubprotocol... subprotocols)TypesafeGraphQLClientBuilderwebsocketInitializationTimeout(Integer timeoutInMilliseconds)Maximum time (in milliseconds) allowed between initializing a subscription websocket and receiving a subscription start acknowledgement from the server.TypesafeGraphQLClientBuilderwebsocketUrl(String url)Path to the websocket endpoint.
-
-
-
Method Detail
-
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.
-
-