Interface RequestProvider
-
- All Known Implementing Classes:
FilesUploadRequestProvider,GetIdRequestProvider,GetJobIdRequestProvider,GetListRequestProvider,GetLoginRequestProvider,GetPlaygroundJobIdRequestProvider,GetPlaygroundRequestProvider,GetSimpleListRequestProvider,PostJsonListRequestProvider,PostJsonRequestProvider,PostPlaygroundJsonListRequestProvider,PostPlaygroundJsonRequestProvider,RawDeleteRowsRequestProvider,RawReadRowsCursorsRequestProvider,RawReadRowsRequestProvider,RawWriteRowsRequestProvider,RawWriteTablesRequestProvider,ThreeDAncestorNodesRequestProvider,ThreeDAssetMappingsFilterRequestProvider,ThreeDAssetMappingsRequestProvider,ThreeDNodesFilterRequestProvider,ThreeDNodesRequestProvider,ThreeDOutputsRequestProvider,ThreeDRequestProvider,ThreeDRevisionLogsRequestProvider,TSPointsReadProtoCursorsRequestProvider,TSPointsReadProtoRequestProvider,TSPointsRequestProvider,TSPointsWriteProtoRequestProvider
public interface RequestProvider
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description okhttp3.RequestbuildRequest(Optional<String> cursor)Builds a request based on the baslineRequestParametersprovided via thewithRequestParametersmethod.RequestProviderwithRequest(Request requestParameters)Set the baselineRequestto build requests from.
-
-
-
Method Detail
-
withRequest
RequestProvider withRequest(Request requestParameters)
Set the baselineRequestto build requests from. This is typically the application-providedRequestthat kicks off a potential series of requests (in the case of iterating over a results set). This baselineRequestdo not change over the life-cycle of a request-response series.- Parameters:
requestParameters-- Returns:
-
buildRequest
okhttp3.Request buildRequest(Optional<String> cursor) throws Exception
Builds a request based on the baslineRequestParametersprovided via thewithRequestParametersmethod. If a cursor is provided, this will typically lead theRequestProviderto modify the underlyingRequest. In order to get the exactRequestused to build the latest request, call thegetEffectiveRequestParametersmethod.- Parameters:
cursor-- Returns:
- Throws:
Exception
-
-