Package com.cognite.client.servicesV1.request

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, TSPointsRequestProvider, TSPointsWriteProtoRequestProvider
public interface RequestProvider

  • Method Summary

    Modifier and Type
    Method
    Description
    okhttp3.Request
    buildRequest(Optional<String> cursor)
    Builds a request based on the basline RequestParameters provided via the withRequestParameters method.
    RequestProvider
    withRequest(Request requestParameters)
    Set the baseline Request to build requests from.

  • Method Details

    • withRequest

      RequestProvider withRequest(Request requestParameters)
      Set the baseline Request to build requests from. This is typically the application-provided Request that kicks off a potential series of requests (in the case of iterating over a results set). This baseline Request do 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 basline RequestParameters provided via the withRequestParameters method. If a cursor is provided, this will typically lead the RequestProvider to modify the underlying Request. In order to get the exact Request used to build the latest request, call the getEffectiveRequestParameters method.
      Parameters:
      cursor -
      Returns:
      Throws:
      Exception