Package com.cognite.client.servicesV1

Class ConnectorServiceV1

java.lang.Object
com.cognite.client.servicesV1.ConnectorServiceV1
All Implemented Interfaces:
Serializable
public abstract class ConnectorServiceV1 extends Object implements Serializable
The service handles connections to the Cognite REST api.
See Also:

  • Field Details

    • LOG

      protected final org.slf4j.Logger LOG

  • Constructor Details

    • ConnectorServiceV1

      public ConnectorServiceV1()

  • Method Details

    • of

      public static ConnectorServiceV1 of(CogniteClient client)

    • create

      public static ConnectorServiceV1 create()

    • getClient

      public abstract CogniteClient getClient()

    • readAssets

      public ConnectorServiceV1.ResultFutureIterator<String> readAssets(Request queryParameters)
      Read assets from Cognite.
      Parameters:
      queryParameters - The parameters for the assets query.
      Returns:

    • readAssetsAggregates

      public ItemReader<String> readAssetsAggregates()
      Read assets aggregates from Cognite.
      Returns:

    • readAssetsById

      public ItemReader<String> readAssetsById()
      Read assets by id from Cognite.
      Returns:

    • writeAssets

      public ConnectorServiceV1.ItemWriter writeAssets()
      Write Assets to Cognite. Calling this method will return an ItemWriter
      Returns:

    • updateAssets

      public ConnectorServiceV1.ItemWriter updateAssets()
      Update Assets in Cognite. Calling this method will return an ItemWriter
      Returns:

    • deleteAssets

      public ConnectorServiceV1.ItemWriter deleteAssets()
      Delete Assets in Cognite. Calling this method will return an ItemWriter
      Returns:

    • readEvents

      public ConnectorServiceV1.ResultFutureIterator<String> readEvents(Request queryParameters)
      Read events from Cognite.
      Parameters:
      queryParameters - The parameters for the events query.
      Returns:

    • readEventsAggregates

      public ItemReader<String> readEventsAggregates()
      Read events aggregates from Cognite.
      Returns:

    • readEventsById

      public ItemReader<String> readEventsById()
      Read events by id from Cognite.
      Returns:

    • writeEvents

      public ConnectorServiceV1.ItemWriter writeEvents()
      Write Events to Cognite. Calling this method will return an ItemWriter
      Returns:

    • updateEvents

      public ConnectorServiceV1.ItemWriter updateEvents()
      Update Events in Cognite. Calling this method will return an ItemWriter
      Returns:

    • deleteEvents

      public ConnectorServiceV1.ItemWriter deleteEvents()
      Delete Events in Cognite. Calling this method will return an ItemWriter
      Returns:

    • readSequencesHeaders

      public ConnectorServiceV1.ResultFutureIterator<String> readSequencesHeaders(Request queryParameters)
      Fetch sequences headers from Cognite.
      Parameters:
      queryParameters - The parameters for the events query.
      Returns:

    • readSequencesAggregates

      public ItemReader<String> readSequencesAggregates()
      Read sequences aggregates from Cognite.
      Returns:

    • readSequencesById

      public ItemReader<String> readSequencesById()
      Read sequences by id from Cognite.
      Returns:

    • writeSequencesHeaders

      public ConnectorServiceV1.ItemWriter writeSequencesHeaders()
      Write sequences headers to Cognite. Calling this method will return an ItemWriter
      Returns:

    • updateSequencesHeaders

      public ConnectorServiceV1.ItemWriter updateSequencesHeaders()
      Update sequences headers in Cognite. Calling this method will return an ItemWriter
      Returns:

    • deleteSequencesHeaders

      public ConnectorServiceV1.ItemWriter deleteSequencesHeaders()
      Delete sequences headers in Cognite. Calling this method will return an ItemWriter
      Returns:

    • readSequencesRows

      public ConnectorServiceV1.ResultFutureIterator<String> readSequencesRows(Request queryParameters)
      Fetch sequences rows / body from Cognite.
      Parameters:
      queryParameters - The parameters for the events query.
      Returns:

    • writeSequencesRows

      public ConnectorServiceV1.ItemWriter writeSequencesRows()
      Write sequences rows to Cognite. Calling this method will return an ItemWriter
      Returns:

    • deleteSequencesRows

      public ConnectorServiceV1.ItemWriter deleteSequencesRows()
      Delete sequences rows in Cognite. Calling this method will return an ItemWriter
      Returns:

    • readTsHeaders

      public ConnectorServiceV1.ResultFutureIterator<String> readTsHeaders(Request queryParameters)
      List timeseries headers from Cognite.
      Parameters:
      queryParameters - The parameters for the TS query.
      Returns:

    • readTsAggregates

      public ItemReader<String> readTsAggregates()
      Read timeseries aggregates from Cognite.
      Returns:

    • readTsById

      public ItemReader<String> readTsById()
      Read time series headers by id from Cognite.
      Returns:

    • writeTsHeaders

      public ConnectorServiceV1.ItemWriter writeTsHeaders()
      Write time series headers to Cognite. Calling this method will return an ItemWriter
      Returns:

    • updateTsHeaders

      public ConnectorServiceV1.ItemWriter updateTsHeaders()
      Update time series headers in Cognite. Calling this method will return an ItemWriter
      Returns:

    • deleteTsHeaders

      public ConnectorServiceV1.ItemWriter deleteTsHeaders()
      Delete TS headers in Cognite. Calling this method will return an ItemWriter
      Returns:

    • readTsDatapoints

      public ConnectorServiceV1.ResultFutureIterator<String> readTsDatapoints(Request queryParameters)
      Fetch timeseries datapoints from Cognite.
      Parameters:
      queryParameters - The parameters for the events query.
      Returns:

    • readTsDatapointsProto

      public ConnectorServiceV1.ResultFutureIterator<DataPointListItem> readTsDatapointsProto(Request queryParameters)
      Fetch timeseries datapoints from Cognite using protobuf encoding.
      Parameters:
      queryParameters - The parameters for the events query.
      Returns:

    • readTsDatapointsLatest

      public ItemReader<String> readTsDatapointsLatest()
      Read latest data point from Cognite.
      Returns:

    • writeTsDatapoints

      public ConnectorServiceV1.ItemWriter writeTsDatapoints()
      Write time series headers to Cognite. Calling this method will return an ItemWriter
      Returns:

    • writeTsDatapointsProto

      public ConnectorServiceV1.ItemWriter writeTsDatapointsProto()
      Write time series data points to Cognite. Calling this method will return an ItemWriter
      Returns:

    • deleteDatapoints

      public ConnectorServiceV1.ItemWriter deleteDatapoints()
      Delete data points in Cognite. Calling this method will return an ItemWriter
      Returns:

    • readRawRows

      public ConnectorServiceV1.ResultFutureIterator<String> readRawRows(Request queryParameters)
      Fetch Raw rows from Cognite. This service can handle both single rows and large collection of rows.
      Parameters:
      queryParameters - The parameters for the raw query.
      Returns:

    • readRawRow

      public ItemReader<String> readRawRow()
      Fetch a single row by row key.
      Returns:

    • readCursorsRawRows

      public ItemReader<String> readCursorsRawRows()
      Read cursors for retrieving events in parallel. The results set is split into n partitions.
      Returns:

    • writeRawRows

      public ConnectorServiceV1.ItemWriter writeRawRows()
      Write rows to Raw in Cognite. Calling this method will return an ItemWriter

    • deleteRawRows

      public ConnectorServiceV1.ItemWriter deleteRawRows()
      Delete Assets in Cognite. Calling this method will return an ItemWriter
      Returns:

    • readRawDbNames

      public ConnectorServiceV1.ResultFutureIterator<String> readRawDbNames(AuthConfig config)
      List the Raw database names from Cognite.
      Returns:

    • writeRawDbNames

      public ConnectorServiceV1.ItemWriter writeRawDbNames()
      Create Raw tables in a given database.
      Returns:

    • deleteRawDbNames

      public ConnectorServiceV1.ItemWriter deleteRawDbNames()
      Create Raw tables in a given database.
      Returns:

    • readRawTableNames

      public ConnectorServiceV1.ResultFutureIterator<String> readRawTableNames(String dbName, AuthConfig config)
      List the Raw tables for a given database.
      Parameters:
      dbName - The name of the database to list tables from.
      Returns:

    • writeRawTableNames

      public ConnectorServiceV1.ItemWriter writeRawTableNames(String dbName)
      Create Raw tables in a given database.
      Parameters:
      dbName - The name of the database to list tables from.
      Returns:

    • deleteRawTableNames

      public ConnectorServiceV1.ItemWriter deleteRawTableNames(String dbName)
      Delete Raw tables from a given database.
      Parameters:
      dbName - The name of the database to list tables from.
      Returns:

    • readFileHeaders

      public ConnectorServiceV1.ResultFutureIterator<String> readFileHeaders(Request queryParameters)
      List file headers from Cognite.
      Parameters:
      queryParameters - The parameters for the file query.
      Returns:

    • readFilesAggregates

      public ItemReader<String> readFilesAggregates()
      Read files aggregates from Cognite.
      Returns:

    • readFilesById

      public ItemReader<String> readFilesById()
      Read files by id from Cognite.
      Returns:

    • readFileBinariesByIds

      public ConnectorServiceV1.FileBinaryReader readFileBinariesByIds()
      Read file binaries from Cognite. Returns an FileBinaryReader which can be used to read file binaries by id.
      Returns:

    • readThreeDFileBinariesById

      public ConnectorServiceV1.ThreeDFileBinaryReader readThreeDFileBinariesById()
      Read 3D file binaries from Cognite. Returns an FileBinaryReader which can be used to read 3D file binaries by id.
      Returns:

    • writeFileHeaders

      public ConnectorServiceV1.ItemWriter writeFileHeaders()
      Write files to Cognite. This is a two-step request with 1) post the file metadata / header and 2) post the file binary. This method returns an ItemWriter to which you can post the file metadata / header. I.e. it performs step 1), but not step 2). The response from the ItemWriter contains a URL reference for the file binary upload.
      Returns:

    • writeFileProto

      public ConnectorServiceV1.FileWriter writeFileProto()
      Write files to Cognite. This method returns an FileWriter to which you can post the FileContainer with file metadata / header. I.e. this writer allows you to post both the file header and the file binary in a single method call. The response contains the the metadata response item for the file.
      Returns:

    • updateFileHeaders

      public ConnectorServiceV1.ItemWriter updateFileHeaders()
      Update file headers to Cognite. Calling this method will return an ItemWriter
      Returns:

    • deleteFiles

      public ConnectorServiceV1.ItemWriter deleteFiles()
      Delete Files (including headers) in Cognite. Calling this method will return an ItemWriter
      Returns:

    • readRelationships

      public ConnectorServiceV1.ResultFutureIterator<String> readRelationships(Request queryParameters)
      Fetch relationships from Cognite.
      Parameters:
      queryParameters - The parameters for the data sets query.
      Returns:

    • readRelationshipsById

      public ItemReader<String> readRelationshipsById()
      Read relationships by id from Cognite.
      Returns:

    • writeRelationships

      public ConnectorServiceV1.ItemWriter writeRelationships()
      Write relationships to Cognite. Calling this method will return an ItemWriter
      Returns:

    • updateRelationships

      public ConnectorServiceV1.ItemWriter updateRelationships()
      Update relationships to Cognite. Calling this method will return an ItemWriter
      Returns:

    • deleteRelationships

      public ConnectorServiceV1.ItemWriter deleteRelationships()
      Delete relationships in Cognite. Calling this method will return an ItemWriter
      Returns:

    • updateDataSets

      public ConnectorServiceV1.ItemWriter updateDataSets()
      Update data sets in Cognite. Calling this method will return an ItemWriter
      Returns:

    • readDataSets

      public ConnectorServiceV1.ResultFutureIterator<String> readDataSets(Request queryParameters)
      Fetch data sets from Cognite.
      Parameters:
      queryParameters - The parameters for the data sets query.
      Returns:

    • readDataSetsAggregates

      public ItemReader<String> readDataSetsAggregates()
      Read data sets aggregates from Cognite.
      Returns:

    • readDataSetsById

      public ItemReader<String> readDataSetsById()
      Read data sets by id from Cognite.
      Returns:

    • writeDataSets

      public ConnectorServiceV1.ItemWriter writeDataSets()
      Write data sets to Cognite. Calling this method will return an ItemWriter
      Returns:

    • readExtractionPipelines

      public ConnectorServiceV1.ResultFutureIterator<String> readExtractionPipelines(Request queryParameters)
      Read extraction pipelines from Cognite.
      Parameters:
      queryParameters - The parameters for the events query.
      Returns:

    • readExtractionPipelinesById

      public ItemReader<String> readExtractionPipelinesById()
      Read extraction pipelines by id from Cognite.
      Returns:

    • writeExtractionPipelines

      public ConnectorServiceV1.ItemWriter writeExtractionPipelines()
      Write extraction pipelines to Cognite. Calling this method will return an ItemWriter
      Returns:

    • updateExtractionPipelines

      public ConnectorServiceV1.ItemWriter updateExtractionPipelines()
      Update extraction pipelines in Cognite. Calling this method will return an ItemWriter
      Returns:

    • deleteExtractionPipelines

      public ConnectorServiceV1.ItemWriter deleteExtractionPipelines()
      Delete extraction pipelines in Cognite. Calling this method will return an ItemWriter
      Returns:

    • readExtractionPipelineRuns

      public ConnectorServiceV1.ResultFutureIterator<String> readExtractionPipelineRuns(Request queryParameters)
      Read extraction pipeline runs from Cognite.
      Parameters:
      queryParameters - The parameters for the events query.
      Returns:

    • writeExtractionPipelineRuns

      public ConnectorServiceV1.ItemWriter writeExtractionPipelineRuns()
      Write extraction pipeline runs to Cognite. Calling this method will return an ItemWriter
      Returns:

    • readLabels

      public ConnectorServiceV1.ResultFutureIterator<String> readLabels(Request queryParameters)
      Read labels from Cognite.
      Parameters:
      queryParameters - The parameters for the data sets query.
      Returns:

    • writeLabels

      public ConnectorServiceV1.ItemWriter writeLabels()
      Write labels to Cognite. Calling this method will return an ItemWriter
      Returns:

    • deleteLabels

      public ConnectorServiceV1.ItemWriter deleteLabels()
      Delete labels in Cognite. Calling this method will return an ItemWriter
      Returns:

    • readSecurityCategories

      public ConnectorServiceV1.ResultFutureIterator<String> readSecurityCategories(Request queryParameters)
      Read security categories from Cognite.
      Parameters:
      queryParameters - The parameters for the security categories query.
      Returns:

    • writeSecurityCategories

      public ConnectorServiceV1.ItemWriter writeSecurityCategories()
      Write security categories to Cognite. Calling this method will return an ItemWriter
      Returns:

    • deleteSecurityCategories

      public ConnectorServiceV1.ItemWriter deleteSecurityCategories()
      Delete security categories in Cognite. Calling this method will return an ItemWriter
      Returns:

    • detectAnnotationsDiagrams

      public ItemReader<String> detectAnnotationsDiagrams()
      Detect references to assets and files in an engineering diagram and annotate the references with bounding boxes. Finds entities in the engineering diagram that match a list of entity names, for instance asset names. The P&ID must be a single-page PDF file.
      Returns:

    • convertDiagrams

      public ItemReader<String> convertDiagrams()
      Convert an engineering diagram in PDF format to an interactive SVG where the provided annotations are highlighted.
      Returns:

    • readEntityMatcherModels

      public ItemReader<String> readEntityMatcherModels()
      Create a reader for listing entity matcher models.
      Returns:
      An ItemReader<String> for reading the models.

    • deleteEntityMatcherModels

      public ConnectorServiceV1.ItemWriter deleteEntityMatcherModels()
      Create a writer for deleting entity matcher models.
      Returns:
      An ConnectorServiceV1.ItemWriter for deleting the models

    • entityMatcherPredict

      public ItemReader<String> entityMatcherPredict()
      Create an entity matcher predict reader.
      Returns:

    • entityMatcherFit

      public Connector<String> entityMatcherFit()
      Create an entity matcher training executor.
      Returns:

    • readThreeDModels

      public Iterator<CompletableFuture<ResponseItems<String>>> readThreeDModels(Request queryParameters)
      Fetch 3d models from Cognite.
      Parameters:
      queryParameters - The parameters for the events query.
      Returns:

    • writeThreeDModels

      public ConnectorServiceV1.ItemWriter writeThreeDModels()
      Write 3D Models to Cognite. Calling this method will return an ItemWriter
      Returns:

    • updateThreeDModels

      public ConnectorServiceV1.ItemWriter updateThreeDModels()
      Update 3D Models in Cognite. Calling this method will return an ItemWriter
      Returns:

    • deleteThreeDModels

      public ConnectorServiceV1.ItemWriter deleteThreeDModels()
      Create a writer for deleting 3D Models.
      Returns:
      An ConnectorServiceV1.ItemWriter for deleting the models

    • readThreeDModelsById

      public ItemReader<String> readThreeDModelsById()
      Read 3D Models by id from Cognite.
      Returns:

    • readThreeDModelsRevisionsById

      public ItemReader<String> readThreeDModelsRevisionsById(Long modelId)
      Read 3d models revisions by id from Cognite.
      Returns:

    • readThreeDModelsRevisions

      public Iterator<CompletableFuture<ResponseItems<String>>> readThreeDModelsRevisions(Request queryParameters)
      Read 3D Models Revisions from Cognite.
      Parameters:
      queryParameters - The parameters for the events query.
      Returns:

    • writeThreeDModelsRevisions

      public ConnectorServiceV1.ItemWriter writeThreeDModelsRevisions(Long modelId)
      Write 3D Models Revisions to Cognite. Calling this method will return an ItemWriter
      Parameters:
      modelId - The id of ThreeDModel object
      Returns:

    • updateThreeDModelsRevisions

      public ConnectorServiceV1.ItemWriter updateThreeDModelsRevisions(Long modelId)
      Update 3D Models Revisions in Cognite. Calling this method will return an ItemWriter
      Parameters:
      modelId - The id of ThreeDModel object
      Returns:

    • deleteThreeDModelsRevisions

      public ConnectorServiceV1.ItemWriter deleteThreeDModelsRevisions(Long modelId)
      Create a writer for deleting 3D Models Revisions.
      Parameters:
      modelId - The id of ThreeDModel object
      Returns:
      An ConnectorServiceV1.ItemWriter for deleting the models

    • readThreeDOutputs

      public ItemReader<String> readThreeDOutputs()
      Read 3d Available Outputs by modeId and revisionId from Cognite.
      Returns:

    • readThreeDRevisionLogs

      public ItemReader<String> readThreeDRevisionLogs()

    • readThreeDNodes

      public ItemReader<String> readThreeDNodes()

    • readThreeDNodes

      public Iterator<CompletableFuture<ResponseItems<String>>> readThreeDNodes(Request queryParameters)

    • filterThreeDNodes

      public Iterator<CompletableFuture<ResponseItems<String>>> filterThreeDNodes(Long modelId, Long revisionId, Request queryParameters)

    • readThreeDAncestorNodes

      public Iterator<CompletableFuture<ResponseItems<String>>> readThreeDAncestorNodes(Request queryParameters)

    • readThreeDAncestorNodes

      public ItemReader<String> readThreeDAncestorNodes()

    • readThreeDNodesById

      public ItemReader<String> readThreeDNodesById(Long modelId, Long revisionId)

    • updateThreeDTRevisionThumbnail

      public ConnectorServiceV1.ItemWriter updateThreeDTRevisionThumbnail(Long modelId, Long revisionId)
      Update the Thumbnail of Revision Calling this method will return an ItemWriter
      Parameters:
      modelId - The id of ThreeDModel object
      revisionId - The id of ThreeDModelRevision object
      Returns:

    • readThreeDAssetMappings

      public Iterator<CompletableFuture<ResponseItems<String>>> readThreeDAssetMappings(Request requestParameters)

    • filterThreeDAssetMappings

      public Iterator<CompletableFuture<ResponseItems<String>>> filterThreeDAssetMappings(Long modelId, Long revisionId, Request requestParameters)

    • writeThreeDAssetMappings

      public ConnectorServiceV1.ItemWriter writeThreeDAssetMappings(Long modelId, Long revisionId)

    • deleteThreeDAssetMappings

      public ConnectorServiceV1.ItemWriter deleteThreeDAssetMappings(Long modelId, Long revisionId)

    • writeTransformation

      public ConnectorServiceV1.ItemWriter writeTransformation()
      Write Transformation to Cognite. Calling this method will return an ItemWriter
      Returns:

    • updateTransformation

      public ConnectorServiceV1.ItemWriter updateTransformation()
      Update Transformation to Cognite. Calling this method will return an ItemWriter
      Returns:

    • readTransformations

      public Iterator<CompletableFuture<ResponseItems<String>>> readTransformations(Request queryParameters)
      Filter Transformations in Cognite.
      Parameters:
      queryParameters -
      Returns:

    • deleteTransformations

      public ConnectorServiceV1.ItemWriter deleteTransformations()
      Delete Transformations in Cognite. Calling this method will return an ItemWriter
      Returns:

    • readTransformationsById

      public ItemReader<String> readTransformationsById()
      Retrieve Transformations in Cognite.
      Returns:

    • runTransformationJobs

      public ConnectorServiceV1.ItemWriter runTransformationJobs(Request queryParameters)
      Start running the job in Cognite.
      Parameters:
      queryParameters -
      Returns:

    • cancelTransformationJobs

      public ConnectorServiceV1.ItemWriter cancelTransformationJobs(Request queryParameters)
      Stop running the job
      Parameters:
      queryParameters -
      Returns:

    • readTransformationJobs

      public Iterator<CompletableFuture<ResponseItems<String>>> readTransformationJobs(Request queryParameters)
      Filter Transformations in Cognite.
      Parameters:
      queryParameters -
      Returns:

    • readTransformationJobsById

      public ItemReader<String> readTransformationJobsById()
      Retrieve Transformations Jobs in Cognite.
      Returns:

    • readTransformationJobMetrics

      public Iterator<CompletableFuture<ResponseItems<String>>> readTransformationJobMetrics(Request requestParameters)
      List TransformationJobMetrics
      Returns:

    • writeTransformationSchedules

      public ConnectorServiceV1.ItemWriter writeTransformationSchedules()
      Write Transformation Schedules to Cognite. Calling this method will return an ItemWriter
      Returns:

    • updateTransformationSchedules

      public ConnectorServiceV1.ItemWriter updateTransformationSchedules()
      Update Transformation Schedules to Cognite. Calling this method will return an ItemWriter
      Returns:

    • readTransformationSchedules

      public Iterator<CompletableFuture<ResponseItems<String>>> readTransformationSchedules(Request requestParameters)
      List TransformationSchedules
      Returns:

    • readTransformationSchedulesById

      public ItemReader<String> readTransformationSchedulesById()
      Retrieve Transformations Jobs in Cognite.
      Returns:

    • deleteTransformationSchedules

      public ConnectorServiceV1.ItemWriter deleteTransformationSchedules()
      Delete Transformations in Cognite. Calling this method will return an ItemWriter
      Returns:

    • readTransformationNotifications

      public Iterator<CompletableFuture<ResponseItems<String>>> readTransformationNotifications(Request requestParameters)
      List Transformation Notifications
      Returns:

    • writeTransformationNotifications

      public ConnectorServiceV1.ItemWriter writeTransformationNotifications()
      Write Transformation Notifications to Cognite. Calling this method will return an ItemWriter
      Returns:

    • deleteTransformationNotifications

      public ConnectorServiceV1.ItemWriter deleteTransformationNotifications()
      Delete Transformation Notifications in Cognite. Calling this method will return an ItemWriter
      Returns: