Package io.vertx.ext.web.handler.graphql
Class GraphQLHandlerOptions
- java.lang.Object
-
- io.vertx.ext.web.handler.graphql.GraphQLHandlerOptions
-
public class GraphQLHandlerOptions extends Object
Options for configuring theGraphQLHandler.- Author:
- Thomas Segismont
-
-
Field Summary
Fields Modifier and Type Field Description static booleanDEFAULT_REQUEST_BATCHING_ENABLEDWhether request batching should be enabled by default = false.static booleanDEFAULT_REQUEST_MULTIPART_ENABLEDWhether a multipart request should be enabled by default = false
-
Constructor Summary
Constructors Constructor Description GraphQLHandlerOptions()Default constructor.GraphQLHandlerOptions(JsonObject json)Constructor to create options from JSON.GraphQLHandlerOptions(GraphQLHandlerOptions other)Copy constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanisRequestBatchingEnabled()booleanisRequestMultipartEnabled()GraphQLHandlerOptionssetRequestBatchingEnabled(boolean requestBatchingEnabled)Whether request batching should be enabled.GraphQLHandlerOptionssetRequestMultipartEnabled(boolean requestMultipartEnabled)Whether request multipart should be enabled.JsonObjecttoJson()
-
-
-
Field Detail
-
DEFAULT_REQUEST_BATCHING_ENABLED
public static final boolean DEFAULT_REQUEST_BATCHING_ENABLED
Whether request batching should be enabled by default = false.- See Also:
- Constant Field Values
-
DEFAULT_REQUEST_MULTIPART_ENABLED
public static final boolean DEFAULT_REQUEST_MULTIPART_ENABLED
Whether a multipart request should be enabled by default = false- See Also:
- Constant Field Values
-
-
Constructor Detail
-
GraphQLHandlerOptions
public GraphQLHandlerOptions()
Default constructor.
-
GraphQLHandlerOptions
public GraphQLHandlerOptions(GraphQLHandlerOptions other)
Copy constructor.- Parameters:
other- the options to copy
-
GraphQLHandlerOptions
public GraphQLHandlerOptions(JsonObject json)
Constructor to create options from JSON.- Parameters:
json- the JSON
-
-
Method Detail
-
toJson
public JsonObject toJson()
- Returns:
- a JSON representation of these options
-
isRequestBatchingEnabled
public boolean isRequestBatchingEnabled()
- Returns:
- true if request batching should be enabled, false otherwise
-
setRequestBatchingEnabled
public GraphQLHandlerOptions setRequestBatchingEnabled(boolean requestBatchingEnabled)
Whether request batching should be enabled. Defaults tofalse.- Parameters:
requestBatchingEnabled- true to enable request batching, false otherwise- Returns:
- a reference to this, so the API can be used fluently
-
isRequestMultipartEnabled
public boolean isRequestMultipartEnabled()
- Returns:
- true if request multipart should be enabled, false otherwise
-
setRequestMultipartEnabled
public GraphQLHandlerOptions setRequestMultipartEnabled(boolean requestMultipartEnabled)
Whether request multipart should be enabled. Defaults tofalse.- Parameters:
requestMultipartEnabled- true to enable request multipart, false otherwise- Returns:
- a reference to this, so the API can be used fluently
-
-