Uses of Class
com.cognite.client.Request

Packages that use Request

Package	Description
com.cognite.client
com.cognite.client.servicesV1
com.cognite.client.servicesV1.request
com.cognite.client.servicesV1.response
com.cognite.client.servicesV1.util
com.cognite.client.stream

Uses of Request in com.cognite.client

Methods in com.cognite.client that return Request

Modifier and Type	Method	Description
abstract Request	Request.Builder.build()
static Request	Request.create()
Request	Request.withAuthConfig(AuthConfig config)	Sets the project configuration for a request.
Request	Request.withDbName(String dbName)	Convenience method for adding the database name when reading from Cognite.Raw.
Request	Request.withFilterMetadataParameter(String key, String value)	Adds a new parameter to the filter.metadata node.
Request	Request.withFilterParameter(String key, Object value)	Adds a new parameter to the filter node.
Request	Request.withItemExternalId(String externalId)	Convenience method for setting the external id for requesting an item.
Request	Request.withItemInternalId(long internalId)	Convenience method for setting the external id for requesting an item.
Request	Request.withItems(List<? extends Map<String,Object>> items)	Sets the items array to the specified input list.
Request	Request.withProtoRequestBody(com.google.protobuf.Message requestBody)	Adds the complete request body as a protobuf object.
Request	Request.withRequestJson(String value)	Adds the complete request parameter structure based on Json.
Request	Request.withRequestParameters(Map<String,Object> requestParameters)	Adds the complete request parameter structure based on Java objects.
Request	Request.withRootParameter(String key, Object value)	Adds a new parameter to the root level.
Request	Request.withTableName(String tableName)	Convenience method for adding the table name when reading from Cognite.Raw.

Methods in com.cognite.client with parameters of type Request

Modifier and Type	Method	Description
com.cognite.client.dto.Aggregate	Assets.aggregate(Request requestParameters)	Performs an item aggregation request to Cognite Data Fusion.
com.cognite.client.dto.Aggregate	Datasets.aggregate(Request requestParameters)	Performs an item aggregation to Cognite Data Fusion.
com.cognite.client.dto.Aggregate	Events.aggregate(Request requestParameters)	Performs an item aggregation request to Cognite Data Fusion.
com.cognite.client.dto.Aggregate	Files.aggregate(Request requestParameters)	Performs an item aggregation request to Cognite Data Fusion.
com.cognite.client.dto.Aggregate	Sequences.aggregate(Request requestParameters)	Performs an item aggregation request to Cognite Data Fusion.
com.cognite.client.dto.Aggregate	Timeseries.aggregate(Request requestParameters)	Performs an item aggregation request to Cognite Data Fusion.
double	DataPoints.getMaxFrequency(Request requestParameters, Instant startOfWindow, Instant endOfWindow)	Calculate the max frequency of the TS items in the query.
Iterator<List<com.cognite.client.dto.Asset>>	Assets.list(Request requestParameters)	Returns all Asset objects that matches the filters set in the Request.
Iterator<List<com.cognite.client.dto.Asset>>	Assets.list(Request requestParameters, String... partitions)	Returns all Asset objects that matches the filters set in the Request for the specified partitions.
Iterator<List<com.cognite.client.dto.DataSet>>	Datasets.list(Request requestParameters)	Return all DataSet object that matches the filters set in the Request.
Iterator<List<com.cognite.client.dto.DataSet>>	Datasets.list(Request requestParameters, String... partitions)	Return all DataSet objects that matches the filters set in the Request for the specific partitions.
Iterator<List<com.cognite.client.dto.Event>>	Events.list(Request requestParameters)	Returns all Event objects that matches the filters set in the Request.
Iterator<List<com.cognite.client.dto.Event>>	Events.list(Request requestParameters, String... partitions)	Returns all Event objects that matches the filters set in the Request for the specified partitions.
Iterator<List<com.cognite.client.dto.FileMetadata>>	Files.list(Request requestParameters)	Returns all FileMetadata objects that matches the filters set in the Request.
Iterator<List<com.cognite.client.dto.FileMetadata>>	Files.list(Request requestParameters, String... partitions)	Returns all Event objects that matches the filters set in the Request for the specified partitions.
Iterator<List<com.cognite.client.dto.Label>>	Labels.list(Request requestParameters)	Return all Label object that matches the filters set in the Request.
Iterator<List<com.cognite.client.dto.Label>>	Labels.list(Request requestParameters, String... partitions)	Returns all Label objects that matches the filters set in the Request for the specific partitions.
Iterator<List<com.cognite.client.dto.RawRow>>	RawRows.list(String dbName, String tableName, Request requestParameters)	Returns a set of rows from a table.
Iterator<List<com.cognite.client.dto.RawRow>>	RawRows.list(String dbName, String tableName, Request requestParameters, String... cursors)	Returns a set of rows from a table.
Iterator<List<com.cognite.client.dto.RawRow>>	RawRows.list(String dbName, String tableName, List<String> columns, Request requestParameters)	Returns all rows from a table.
Iterator<List<com.cognite.client.dto.Relationship>>	Relationships.list(Request requestParameters)	Returns all Relationship objects that matches the filters set in the Request.
Iterator<List<com.cognite.client.dto.Relationship>>	Relationships.list(Request requestParameters, String... partitions)	Returns all Relationship objects that matches the filters set in the Request for the specified partitions.
Iterator<List<com.cognite.client.dto.SecurityCategory>>	SecurityCategories.list(Request requestParameters)	Return all SecurityCategory object that matches the filters set in the SecurityCategory.
Iterator<List<com.cognite.client.dto.SecurityCategory>>	SecurityCategories.list(Request requestParameters, String... partitions)	Returns all SecurityCategory objects that matches the filters set in the Request for the specified partitions.
Iterator<List<com.cognite.client.dto.SequenceMetadata>>	Sequences.list(Request requestParameters)	Return all SequenceMetadata object that matches the filters set in the SequenceMetadata.
Iterator<List<com.cognite.client.dto.SequenceMetadata>>	Sequences.list(Request requestParameters, String... partitions)	Returns all SequenceMetadata objects that matches the filters set in the Request for the specified partitions.
Iterator<List<com.cognite.client.dto.TimeseriesMetadata>>	Timeseries.list(Request requestParameters)	Returns all TimeseriesMetadata object that matches the filters set in the Request.
Iterator<List<com.cognite.client.dto.TimeseriesMetadata>>	Timeseries.list(Request requestParameters, String... partitions)	Returns all TimeseriesMetadata objects that matches the filters set in the Request for the specified partitions.
Iterator<List<com.cognite.client.dto.TimeseriesPoint>>	DataPoints.retrieve(Request requestParameters)	Returns all TimeseriesPoint objects that matches the filters set in the Request.
Iterator<List<com.cognite.client.dto.SequenceBody>>	SequenceRows.retrieve(Request requestParameters)	Returns all SequenceBody objects (i.e.
List<String>	RawRows.retrieveCursors(String dbName, String tableName, int noCursors, Request requestParameters)	Retrieves cursors for parallel retrieval of rows from Raw.
List<String>	RawRows.retrieveCursors(String dbName, String tableName, Request requestParameters)	Retrieves cursors for parallel retrieval of rows from Raw.

Method parameters in com.cognite.client with type arguments of type Request

Modifier and Type	Method	Description
List<com.cognite.client.dto.EntityMatchModel>	EntityMatching.create(Collection<Request> requests)	Train a model that predicts matches between entities (for example, time series names to asset names).
List<com.cognite.client.dto.DiagramResponse>	EngineeringDiagrams.detectAnnotations(Collection<Request> requests, boolean convertToInteractive)	Detect references to assets and files, etc.
List<com.cognite.client.dto.EntityMatchResult>	EntityMatching.predict(Collection<Request> requests)	Matches a set of source entities with a set of targets via a given matching model.
Iterator<List<com.cognite.client.dto.SequenceBody>>	SequenceRows.retrieve(List<Request> requestParametersList)	Returns all SequenceBody objects (i.e.

Uses of Request in com.cognite.client.servicesV1

Methods in com.cognite.client.servicesV1 with parameters of type Request

Modifier and Type	Method	Description
ResponseItems<T>	Connector.execute(Request requestParameters)	Executes a request against the api endpoint.
ResponseItems<T>	ConnectorServiceV1.AsyncJobReader.execute(Request items)	Executes a request to get items and blocks the thread until all items have been downloaded.
CompletableFuture<ResponseItems<T>>	Connector.executeAsync(Request requestParameters)	Executes a request against the api endpoint on a separate thread.
CompletableFuture<ResponseItems<T>>	ConnectorServiceV1.AsyncJobReader.executeAsync(Request items)	Executes an item-based request to get items asynchronously.
ResponseItems<T>	ConnectorServiceV1.AsyncJobReader.getItems(Request items)	Executes a request to get items and blocks the thread until all items have been downloaded.
ResponseItems<T>	ConnectorServiceV1.SingleRequestItemReader.getItems(Request items)	Executes a request to get items and blocks the thread until all items have been downloaded.
ResponseItems<T>	ItemReader.getItems(Request requestParameters)	Executes a request against the api endpoint.
CompletableFuture<ResponseItems<T>>	ConnectorServiceV1.AsyncJobReader.getItemsAsync(Request items)	Executes an item-based request to get items asynchronously.
CompletableFuture<ResponseItems<T>>	ConnectorServiceV1.SingleRequestItemReader.getItemsAsync(Request items)	Executes an item-based request to get items asynchronously.
CompletableFuture<ResponseItems<T>>	ItemReader.getItemsAsync(Request requestParameters)	Executes a request against the api endpoint on a separate thread.
Iterator<CompletableFuture<ResponseItems<String>>>	ConnectorServiceV1.read3dModels(Request queryParameters)	Fetch 3d models from Cognite.
ConnectorServiceV1.ResultFutureIterator<String>	ConnectorServiceV1.readAssets(Request queryParameters)	Read assets from Cognite.
ConnectorServiceV1.ResultFutureIterator<String>	ConnectorServiceV1.readDataSets(Request queryParameters)	Fetch data sets from Cognite.
ConnectorServiceV1.ResultFutureIterator<String>	ConnectorServiceV1.readEvents(Request queryParameters)	Read events from Cognite.
List<ResponseItems<com.cognite.client.dto.FileBinary>>	ConnectorServiceV1.FileBinaryReader.readFileBinaries(Request items)	Executes an item-based request to get file binaries and blocks the thread until all files have been downloaded.
CompletableFuture<List<ResponseItems<com.cognite.client.dto.FileBinary>>>	ConnectorServiceV1.FileBinaryReader.readFileBinariesAsync(Request items)	Executes an item-based request to get file binaries asynchronously.
ConnectorServiceV1.ResultFutureIterator<String>	ConnectorServiceV1.readFileHeaders(Request queryParameters)	List file headers from Cognite.
ConnectorServiceV1.ResultFutureIterator<String>	ConnectorServiceV1.readLabels(Request queryParameters)	Read labels from Cognite.
ConnectorServiceV1.ResultFutureIterator<String>	ConnectorServiceV1.readRawRows(Request queryParameters)	Fetch Raw rows from Cognite.
ConnectorServiceV1.ResultFutureIterator<String>	ConnectorServiceV1.readRelationships(Request queryParameters)	Fetch relationships from Cognite.
ConnectorServiceV1.ResultFutureIterator<String>	ConnectorServiceV1.readSecurityCategories(Request queryParameters)	Read security categories from Cognite.
ConnectorServiceV1.ResultFutureIterator<String>	ConnectorServiceV1.readSequencesHeaders(Request queryParameters)	Fetch sequences headers from Cognite.
ConnectorServiceV1.ResultFutureIterator<String>	ConnectorServiceV1.readSequencesRows(Request queryParameters)	Fetch sequences rows / body from Cognite.
ConnectorServiceV1.ResultFutureIterator<String>	ConnectorServiceV1.readTsDatapoints(Request queryParameters)	Fetch timeseries datapoints from Cognite.
ConnectorServiceV1.ResultFutureIterator<com.cognite.v1.timeseries.proto.DataPointListItem>	ConnectorServiceV1.readTsDatapointsProto(Request queryParameters)	Fetch timeseries datapoints from Cognite using protobuf encoding.
ConnectorServiceV1.ResultFutureIterator<String>	ConnectorServiceV1.readTsHeaders(Request queryParameters)	List timeseries headers from Cognite.
ResponseItems<String>	ConnectorServiceV1.FileWriter.writeFile(Request fileContainerRequest)	Writes file metadata and binaries and blocks the call until the file write completes.
CompletableFuture<ResponseItems<String>>	ConnectorServiceV1.FileWriter.writeFileAsync(Request fileContainerRequest)	Writes file metadata and binaries asynchronously.
ResponseItems<String>	ConnectorServiceV1.ItemWriter.writeItems(Request items)	Executes an item-based write request.
CompletableFuture<ResponseItems<String>>	ConnectorServiceV1.ItemWriter.writeItemsAsync(Request items)	Executes an item-based write request asynchronously.

Uses of Request in com.cognite.client.servicesV1.request

Methods in com.cognite.client.servicesV1.request with parameters of type Request

Modifier and Type	Method	Description
FilesUploadRequestProvider	FilesUploadRequestProvider.withRequest(Request parameters)
GetIdRequestProvider	GetIdRequestProvider.withRequest(Request parameters)
GetLoginRequestProvider	GetLoginRequestProvider.withRequest(Request parameters)
GetPlaygroundJobIdRequestProvider	GetPlaygroundJobIdRequestProvider.withRequest(Request parameters)
GetPlaygroundRequestProvider	GetPlaygroundRequestProvider.withRequest(Request parameters)
GetSimpleListRequestProvider	GetSimpleListRequestProvider.withRequest(Request parameters)
PostJsonListRequestProvider	PostJsonListRequestProvider.withRequest(Request parameters)
PostJsonRequestProvider	PostJsonRequestProvider.withRequest(Request parameters)
PostPlaygroundJsonListRequestProvider	PostPlaygroundJsonListRequestProvider.withRequest(Request parameters)
PostPlaygroundJsonRequestProvider	PostPlaygroundJsonRequestProvider.withRequest(Request parameters)
RawDeleteRowsRequestProvider	RawDeleteRowsRequestProvider.withRequest(Request parameters)
RawReadRowsCursorsRequestProvider	RawReadRowsCursorsRequestProvider.withRequest(Request parameters)
RawReadRowsRequestProvider	RawReadRowsRequestProvider.withRequest(Request parameters)
RawWriteRowsRequestProvider	RawWriteRowsRequestProvider.withRequest(Request parameters)
RawWriteTablesRequestProvider	RawWriteTablesRequestProvider.withRequest(Request parameters)
RequestProvider	RequestProvider.withRequest(Request requestParameters)	Set the baseline Request to build requests from.
TSPointsReadProtoRequestProvider	TSPointsReadProtoRequestProvider.withRequest(Request parameters)
TSPointsRequestProvider	TSPointsRequestProvider.withRequest(Request parameters)
TSPointsWriteProtoRequestProvider	TSPointsWriteProtoRequestProvider.withRequest(Request parameters)

Uses of Request in com.cognite.client.servicesV1.response

Methods in com.cognite.client.servicesV1.response that return Request

Modifier and Type	Method	Description
abstract Request	TSPointsProtoResponseParser.getRequest()
abstract Request	TSPointsResponseParser.getRequest()

Methods in com.cognite.client.servicesV1.response that return types with arguments of type Request

Modifier and Type	Method	Description
com.google.common.collect.ImmutableList<Request>	RequestParametersResponseParser.extractItems(byte[] payload)	Extract the main items from a results json payload.

Methods in com.cognite.client.servicesV1.response with parameters of type Request

Modifier and Type	Method	Description
static FileBinaryResponseParser	FileBinaryResponseParser.of(Request requestParameters)
abstract FileBinaryResponseParser.Builder	FileBinaryResponseParser.Builder.setRequest(Request value)
abstract TSPointsProtoResponseParser.Builder	TSPointsProtoResponseParser.Builder.setRequest(Request value)
abstract TSPointsResponseParser.Builder	TSPointsResponseParser.Builder.setRequest(Request value)
FileBinaryResponseParser	FileBinaryResponseParser.withRequest(Request requestParameters)
TSPointsProtoResponseParser	TSPointsProtoResponseParser.withRequest(Request parameters)
TSPointsResponseParser	TSPointsResponseParser.withRequest(Request parameters)

Uses of Request in com.cognite.client.servicesV1.util

Methods in com.cognite.client.servicesV1.util with parameters of type Request

Modifier and Type	Method	Description
static Optional<Duration>	TSIterationUtilities.getAggregateGranularityDuration(Request requestParameters)	Parses the aggregate duration (minute, hour, day, etc.) from a TS datapoints request.
static Optional<Long>	TSIterationUtilities.getEndAsMillis(Request requestParameters)	Parses the end attribute from a TS datapoints request and returns it as millis since epoch.
static Optional<Long>	TSIterationUtilities.getStartAsMillis(Request requestParameters)	Parses the start attribute from a TS datapoints request and returns it as millis since epoch.

Uses of Request in com.cognite.client.stream

Methods in com.cognite.client.stream with parameters of type Request

Modifier and Type	Method	Description
Iterator<List<T>>	Source.list(Request requestParameters)	Returns all T objects that matches the filters set in the Request.