Package com.linecorp.armeria.common

Interface PathAndQueryParamSetters

All Known Subinterfaces:

HttpRequestSetters, RequestPreparationSetters

All Known Implementing Classes:

AbstractHttpRequestBuilder, BlockingWebClientRequestPreparation, FutureTransformingRequestPreparation, HttpRequestBuilder, RestClientPreparation, TransformingRequestPreparation, WebClientRequestPreparation

@UnstableApi
public interface PathAndQueryParamSetters

Provides the setters for building a path and a query string.

Method Summary

Modifier and Type	Method	Description
PathAndQueryParamSetters	disablePathParams()	Disables path parameters substitution.
PathAndQueryParamSetters	pathParam(String name, Object value)	Sets a path param for this message.
PathAndQueryParamSetters	pathParams(Map<String,?> pathParams)	Sets multiple path params for this message.
PathAndQueryParamSetters	queryParam(String name, Object value)	Adds a query param for this message.
PathAndQueryParamSetters	queryParams(Iterable<? extends Map.Entry<? extends String,String>> queryParams)	Adds multiple query params for this message.

Method Details

pathParam

PathAndQueryParamSetters pathParam(String name,
 Object value)

Sets a path param for this message.

pathParams

PathAndQueryParamSetters pathParams(Map<String,?> pathParams)

Sets multiple path params for this message.

disablePathParams

PathAndQueryParamSetters disablePathParams()

Disables path parameters substitution. If path parameter is not disabled and a parameter is specified using {} or :, value is not found, an IllegalStateException is thrown.

queryParam

PathAndQueryParamSetters queryParam(String name,
 Object value)

Adds a query param for this message.

queryParams

PathAndQueryParamSetters queryParams(Iterable<? extends Map.Entry<? extends String,String>> queryParams)

Adds multiple query params for this message.