Uses of Class
com.mulesoft.connectivity.rest.commons.internal.util.RestRequestBuilder

Packages that use RestRequestBuilder

Package	Description
com.mulesoft.connectivity.rest.commons.api.connection
com.mulesoft.connectivity.rest.commons.api.connection.oauth
com.mulesoft.connectivity.rest.commons.api.data.sample
com.mulesoft.connectivity.rest.commons.api.datasense.valueprovider
com.mulesoft.connectivity.rest.commons.api.operation
com.mulesoft.connectivity.rest.commons.api.operation.paging
com.mulesoft.connectivity.rest.commons.api.source
com.mulesoft.connectivity.rest.commons.internal.util

Uses of RestRequestBuilder in com.mulesoft.connectivity.rest.commons.api.connection

Methods in com.mulesoft.connectivity.rest.commons.api.connection with parameters of type RestRequestBuilder

Modifier and Type	Method and Description
CompletableFuture<org.mule.runtime.extension.api.runtime.operation.Result<String,HttpResponseAttributes>>	RestConnection.bodylessRequest(RestRequestBuilder requestBuilder, int responseTimeoutMillis, org.mule.runtime.api.metadata.MediaType defaultResponseMediaType, org.mule.runtime.extension.api.runtime.streaming.StreamingHelper streamingHelper) Sends a request for which a response entity is not expected.
CompletableFuture<org.mule.runtime.extension.api.runtime.operation.Result<String,HttpResponseAttributes>>	DefaultRestConnection.bodylessRequest(RestRequestBuilder requestBuilder, int responseTimeoutMillis, org.mule.runtime.api.metadata.MediaType defaultResponseMediaType, org.mule.runtime.extension.api.runtime.streaming.StreamingHelper streamingHelper) Sends a request for which a response entity is not expected.
protected org.mule.runtime.http.api.domain.message.request.HttpRequest	DefaultRestConnection.buildRequest(RestRequestBuilder requestBuilder)
CompletableFuture<org.mule.runtime.extension.api.runtime.operation.Result<InputStream,HttpResponseAttributes>>	RestConnection.request(RestRequestBuilder requestBuilder, int responseTimeoutMillis, org.mule.runtime.api.metadata.MediaType defaultResponseMediaType, org.mule.runtime.extension.api.runtime.streaming.StreamingHelper streamingHelper) Sends a request and returns a CompletableFuture with a Result which output is the response body in the form of an InputStream and a HttpResponseAttributes.
CompletableFuture<org.mule.runtime.extension.api.runtime.operation.Result<InputStream,HttpResponseAttributes>>	DefaultRestConnection.request(RestRequestBuilder requestBuilder, int responseTimeoutMillis, org.mule.runtime.api.metadata.MediaType defaultResponseMediaType, org.mule.runtime.extension.api.runtime.streaming.StreamingHelper streamingHelper) Sends a request and returns a CompletableFuture with a Result which output is the response body in the form of an InputStream and a HttpResponseAttributes.

Uses of RestRequestBuilder in com.mulesoft.connectivity.rest.commons.api.connection.oauth

Methods in com.mulesoft.connectivity.rest.commons.api.connection.oauth with parameters of type RestRequestBuilder

Modifier and Type	Method and Description
protected org.mule.runtime.http.api.domain.message.request.HttpRequest	OAuthRestConnection.buildRequest(RestRequestBuilder requestBuilder)

Uses of RestRequestBuilder in com.mulesoft.connectivity.rest.commons.api.data.sample

Methods in com.mulesoft.connectivity.rest.commons.api.data.sample that return RestRequestBuilder

Modifier and Type	Method and Description
protected abstract RestRequestBuilder	RestSampleDataProvider.getRequestBuilder(String path) Return a RequestBuilder configured to do the request to the endpoint this source must poll.

Uses of RestRequestBuilder in com.mulesoft.connectivity.rest.commons.api.datasense.valueprovider

Methods in com.mulesoft.connectivity.rest.commons.api.datasense.valueprovider that return RestRequestBuilder

Modifier and Type	Method and Description
protected abstract RestRequestBuilder	RestValueProvider.getRequestBuilder(String path) Return a RequestBuilder configured to do the request to the endpoint this source must poll.

Uses of RestRequestBuilder in com.mulesoft.connectivity.rest.commons.api.operation

Methods in com.mulesoft.connectivity.rest.commons.api.operation with parameters of type RestRequestBuilder

Modifier and Type	Method and Description
protected void	BaseRestOperation.doRequest(RestConfiguration config, RestConnection connection, RestRequestBuilder builder, int responseTimeoutMillis, org.mule.runtime.extension.api.runtime.streaming.StreamingHelper streamingHelper, org.mule.runtime.extension.api.runtime.process.CompletionCallback<InputStream,HttpResponseAttributes> callback) Performs the request using the given builder and connection and completes the callback accordingly.
protected void	BaseRestOperation.doVoidRequest(RestConnection connection, RestRequestBuilder builder, int responseTimeoutMillis, org.mule.runtime.extension.api.runtime.streaming.StreamingHelper streamingHelper, org.mule.runtime.extension.api.runtime.process.CompletionCallback<String,HttpResponseAttributes> callback) Performs the request using the given builder and connection and completes the callback accordingly, expecting the response to not contain a body.

Uses of RestRequestBuilder in com.mulesoft.connectivity.rest.commons.api.operation.paging

Methods in com.mulesoft.connectivity.rest.commons.api.operation.paging with parameters of type RestRequestBuilder

Modifier and Type	Method and Description
protected void	OffsetPagingProvider.configureRequest(RestRequestBuilder requestBuilder)
protected void	PageNumberPagingProvider.configureRequest(RestRequestBuilder requestBuilder)
protected abstract void	RestPagingProvider.configureRequest(RestRequestBuilder requestBuilder) Depending on the paging strategy, different parameters or headers may need to be passed.
protected void	MarkerPagingProvider.configureRequest(RestRequestBuilder requestBuilder)

Constructor parameters in com.mulesoft.connectivity.rest.commons.api.operation.paging with type arguments of type RestRequestBuilder

Constructor and Description
MarkerPagingProvider(String markerParamName, String nextMarkerExpression, Function<RestConnection,RestRequestBuilder> requestFactory, org.mule.runtime.api.el.ExpressionLanguage expressionLanguage, org.mule.runtime.extension.api.runtime.streaming.StreamingHelper streamingHelper, String payloadExpression, org.mule.runtime.api.metadata.MediaType defaultMediaType, int responseTimeout) Creates a new instance
OffsetPagingProvider(String offsetParamName, int initialOffset, Function<RestConnection,RestRequestBuilder> requestFactory, org.mule.runtime.api.el.ExpressionLanguage expressionLanguage, org.mule.runtime.extension.api.runtime.streaming.StreamingHelper streamingHelper, String payloadExpression, org.mule.runtime.api.metadata.MediaType defaultMediaType, int responseTimeout) Creates a new instance
PageNumberPagingProvider(String pageNumberParamName, int initialPageNumber, Function<RestConnection,RestRequestBuilder> requestFactory, org.mule.runtime.api.el.ExpressionLanguage expressionLanguage, org.mule.runtime.extension.api.runtime.streaming.StreamingHelper streamingHelper, String payloadExpression, org.mule.runtime.api.metadata.MediaType defaultMediaType, int responseTimeout) Creates a new instance
RestPagingProvider(Function<RestConnection,RestRequestBuilder> requestFactory, org.mule.runtime.api.el.ExpressionLanguage expressionLanguage, org.mule.runtime.extension.api.runtime.streaming.StreamingHelper streamingHelper, String payloadExpression, org.mule.runtime.api.metadata.MediaType defaultMediaType, int responseTimeout) Creates a new instance

Uses of RestRequestBuilder in com.mulesoft.connectivity.rest.commons.api.source

Methods in com.mulesoft.connectivity.rest.commons.api.source that return RestRequestBuilder

Modifier and Type	Method and Description
protected abstract RestRequestBuilder	RestPollingSource.getRequestBuilder(String path) Return a RequestBuilder configured to do the request to the endpoint this source must poll.

Uses of RestRequestBuilder in com.mulesoft.connectivity.rest.commons.internal.util

Methods in com.mulesoft.connectivity.rest.commons.internal.util that return RestRequestBuilder

Modifier and Type	Method and Description
RestRequestBuilder	RestRequestBuilder.addHeader(String key, String value) Adds a header to the request builder.
RestRequestBuilder	RestRequestBuilder.addHeaders(String key, List<String> values) Adds multiple headers (with the same name) to the request builder.
RestRequestBuilder	RestRequestBuilder.addQueryParam(String key, String value) Adds a query parameter to the request builder.
RestRequestBuilder	RestRequestBuilder.addQueryParams(String key, List<String> values) Adds multiple query parameters (with the same name) to the request builder.
RestRequestBuilder	RestRequestBuilder.headers(org.mule.runtime.api.util.MultiMap<String,String> headers) Adds all the headers present in a multimap to the request builder.
RestRequestBuilder	RestRequestBuilder.queryParams(org.mule.runtime.api.util.MultiMap<String,String> queryParams) Adds all the query parameters present in a multimap to the request builder.
RestRequestBuilder	RestRequestBuilder.setBody(org.mule.runtime.api.metadata.TypedValue<InputStream> body, StreamingType streamingType) Defines the body and content streaming for this request.
RestRequestBuilder	RestRequestBuilder.setQueryParamFormat(RestRequestBuilder.QueryParamFormat queryParamFormat) Defines the format in which the query parameter arrays must be handled by this request.

Methods in com.mulesoft.connectivity.rest.commons.internal.util with parameters of type RestRequestBuilder

Modifier and Type	Method and Description
static org.mule.runtime.extension.api.runtime.operation.Result<org.mule.runtime.api.metadata.TypedValue<String>,HttpResponseAttributes>	RequestStreamingUtils.doRequestAndConsumeString(RestConnection connection, RestConfiguration config, RestRequestBuilder requestBuilder, org.mule.runtime.api.metadata.MediaType defaultResponseMediaType) Does a request as specified in the provided request builder using the connection, config and media type provided.