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

Interface RequestBuilder<ResultT>

Type Parameters:

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

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>

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

Method Summary

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

Method Detail

execute

@Nonnull
ResultT execute(@Nonnull
                         HttpDestinationProperties destination)

Execute the OData request.

Parameters:

destination - The destination to be used as request target.

Returns:

The generic OData response result.

Throws:

DestinationAccessException - If there is an issue accessing the Destination.

HttpClientInstantiationException - If there is an issue creating the HttpClient.

ODataException - If the OData request execution failed. Please find the documentation for ODataException possible sub-types and error scenarios they can occur in.

tryExecute

@Nonnull
default io.vavr.control.Try<ResultT> tryExecute(@Nonnull
                                                         HttpDestinationProperties destination)

Safely execute the OData request.

Parameters:

destination - The destination to be used as request target.

Returns:

The generic OData response result wrapped in a Try block.

toRequest

@Nonnull
 @Beta
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. 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
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.