Package com.sap.cloud.sdk.datamodel.odatav4.core

Interface RequestBuilder<ResultT>

Type Parameters:

ResultT - The type of the result entity, if any.

All Superinterfaces:

RequestBuilderExecutable<ResultT>

All Known Subinterfaces:

ModificationRequestBuilder<ResultT>, ReadRequestBuilder<ResultT>

All Known Implementing Classes:

ActionRequestBuilder, BatchRequestBuilder, CollectionValueActionRequestBuilder, CollectionValueFunctionRequestBuilder, CountRequestBuilder, CreateRequestBuilder, DeleteRequestBuilder, FunctionRequestBuilder, GetAllRequestBuilder, GetByKeyRequestBuilder, SingleValueActionRequestBuilder, SingleValueFunctionRequestBuilder, UpdateRequestBuilder

public interface RequestBuilder<ResultT>
extends RequestBuilderExecutable<ResultT>

Representation of a generic OData request builder as a fluent interface.

Method Summary

Modifier and Type	Method	Description
ODataRequestGeneric	toRequest()	Assemble a generic, untyped request object that represents the request build up via this builder.
RequestBuilder<ResultT>	withHeader(String key, String value)	Gives the option to specify custom HTTP headers.
default RequestBuilder<ResultT>	withHeaders(Map<String,String> map)	Gives the option to specify a map of custom HTTP headers.

Methods inherited from interface com.sap.cloud.sdk.datamodel.odatav4.core.RequestBuilderExecutable

execute, tryExecute

Method Details

toRequest

@Nonnull
ODataRequestGeneric toRequest()

Assemble a generic, untyped request object that represents the request build up via this builder.

Returns:

A request object extending ODataRequestGeneric.

withHeader

@Nonnull
RequestBuilder<ResultT> withHeader(@Nonnull
 String key,
 @Nullable
 String value)

Gives the option to specify custom HTTP headers. Multiple headers with the same key can be specified. The returned object allows to specify the requests the headers should be used in.

Parameters:

key - Name of the (first) desired HTTP header parameter.

value - Value of the (first) desired HTTP header parameter.

Returns:

A request builder to specify further headers and their intended usage.

withHeaders

@Nonnull
default RequestBuilder<ResultT> withHeaders(@Nonnull
 Map<String,String> map)

Gives the option to specify a map of custom HTTP headers. The returned object allows to specify the requests the headers should be used in.

Parameters:

map - A map of HTTP header key/value pairs.

Returns:

A request builder to specify further headers and their intended usage.