Package com.cognite.client

Class SecurityCategories

java.lang.Object

com.cognite.client.SecurityCategories

public abstract class SecurityCategories
extends Object

This class represents the Cognite security categories api endpoint. It provide methods for reading and writing SecurityCategory

Field Summary

Fields

Modifier and Type	Field	Description
protected static org.slf4j.Logger	LOG

Constructor Summary

Constructors

Constructor	Description
SecurityCategories()

Method Summary

Modifier and Type	Method	Description
protected Request	addAuthInfo(Request request)	Adds the required authentication information into the request object.
protected Aggregate	aggregate(ResourceType resourceType, Request requestParameters)	Performs an item aggregation request to Cognite Data Fusion.
protected List<String>	buildPartitionsList(int noPartitions)	Builds an array of partition specifications for parallel retrieval from the Cognite api.
List<SecurityCategory>	create(List<SecurityCategory> securityCategories)	Creates a set of SecurityCategory objects.
protected List<Item>	deDuplicate(Collection<Item> itemList)	De-duplicates a collection of Item.
List<SecurityCategory>	delete(List<SecurityCategory> securityCategories)	Deletes a set of Security Categories.
abstract CogniteClient	getClient()
protected Iterator<CompletableFuture<ResponseItems<String>>>	getListResponseIterator(ResourceType resourceType, Request requestParameters)
protected boolean	itemsHaveId(Collection<Item> items)	Returns true if all items contain either an externalId or id.
Iterator<List<SecurityCategory>>	list()	Returns all SecurityCategory objects.
Iterator<List<SecurityCategory>>	list(Request requestParameters)	Return all SecurityCategory object that matches the filters set in the SecurityCategory.
Iterator<List<SecurityCategory>>	list(Request requestParameters, String... partitions)	Returns all SecurityCategory objects that matches the filters set in the Request for the specified partitions.
protected Iterator<List<String>>	listJson(ResourceType resourceType, Request requestParameters, String... partitions)	Will return the results from a list / filter api endpoint.
protected Iterator<List<String>>	listJson(ResourceType resourceType, Request requestParameters, String partitionKey, String... partitions)	Will return the results from a list / filter api endpoint.
protected Map<String,Item>	mapItemToId(Collection<Item> items)	Maps all items to their externalId (primary) or id (secondary).
static SecurityCategories	of(CogniteClient client)	Construct a new SecurityCategories object using the provided configuration- This method is intended for internal use--SDK client should always use CogniteClient as the entry point to this class.
protected List<Item>	parseItems(List<String> input)	Parses a list of item object in json representation to typed objects.
protected String	parseName(String json)	Returns the name attribute value from a json input.
protected String	parseString(String itemJson, String fieldName)	Try parsing the specified Json path as a String.
protected List<String>	retrieveJson(ResourceType resourceType, Collection<Item> items)	Retrieve items by id.
protected List<String>	retrieveJson(ResourceType resourceType, Collection<Item> items, Map<String,Object> parameters)	Retrieve items by id.
protected List<Map<String,Object>>	toRequestItems(Collection<Item> itemList)	Converts a list of Item to a request object structure (that can later be parsed to Json).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOG

protected static final org.slf4j.Logger LOG

Constructor Detail

SecurityCategories

public SecurityCategories()

Method Detail

of

public static SecurityCategories of(CogniteClient client)

Construct a new SecurityCategories object using the provided configuration- This method is intended for internal use--SDK client should always use CogniteClient as the entry point to this class.

Parameters:

client - The CogniteClient to use for configuration settings.

Returns:

The labels api object.

list

public Iterator<List<SecurityCategory>> list()
                                      throws Exception

Returns all SecurityCategory objects.

Example:

 
     List<SecurityCategory> listResults = new ArrayList<>();
     client.securityCategories()
             .list()
             .forEachRemaining(listResults::addAll);
 
 

API Reference - List security categories

Throws:

Exception

See Also:

list(Request), CogniteClient, CogniteClient.securityCategories()

list

public Iterator<List<SecurityCategory>> list(Request requestParameters)
                                      throws Exception

Return all SecurityCategory object that matches the filters set in the SecurityCategory. The results are paged through / iterated over via an Iterator--the entire results set is not buffered in memory, but streamed in "pages" from the Cognite api. If you need to buffer the entire results set, then you have to stream these results into yout own data structure. The security categories are retrieved using multiple, parallel request streams towards the Cognite api. The number of parallel streams are set in the ClientConfig.

Example:

 
      List<SecurityCategory> listResults = new ArrayList<>();
      client.securityCategories()
              .list(Request.create()
                             .withRootParameter("sort", "ASC"))
              .forEachRemaining(listResults::addAll);
 
 

API Reference - List security categories

Parameters:

requestParameters -

Returns:

an Iterator to page through the results set.

Throws:

Exception

See Also:

list(Request,String...), CogniteClient, CogniteClient.securityCategories()

list

public Iterator<List<SecurityCategory>> list(Request requestParameters,
                                             String... partitions)
                                      throws Exception

Returns all SecurityCategory objects that matches the filters set in the Request for the specified partitions. This method is intended for advanced use cases you need direct control over the individual partitions. For example, when using the SDK in a distributed environment. The results are paged through / iterated over via an Iterator--the entire results set is not buffered in memory, but streamed in "pages" from the Cognite api. If you need to buffer the entire results set, then you have to stream these results into your own data structure.

Example:

 
      List<SecurityCategory> listResults = new ArrayList<>();
      client.securityCategories()
              .list(Request.create()
                             .withRootParameter("sort", "ASC"),
                                  "1/8","2/8","3/8","4/8","5/8","6/8","7/8","8/8")
              .forEachRemaining(listResults::addAll);
 
 

API Reference - List security categories

Parameters:

requestParameters - The filters to use for retrieving the SecurityCategory.

partitions - The partitions to include

Returns:

an Iterator to page through the results set.

Throws:

Exception

See Also:

listJson(ResourceType,Request,String...), CogniteClient, CogniteClient.securityCategories()

create

public List<SecurityCategory> create(List<SecurityCategory> securityCategories)
                              throws Exception

Creates a set of SecurityCategory objects.

Example:

 
      List<SecurityCategory> securityCategories = //List of SecurityCategory;
      client.securityCategories().create(securityCategories);
 
 

API Reference - Create security categories

Parameters:

securityCategories - The security categories to upsert

Returns:

The upserted security categories

Throws:

Exception

See Also:

ApiBase.UpsertItems.create(List), CogniteClient, CogniteClient.securityCategories()

delete

public List<SecurityCategory> delete(List<SecurityCategory> securityCategories)
                              throws Exception

Deletes a set of Security Categories. The security categories to delete are identified via their id by submitting a list of SecurityCategory.

Example:

 
     List<SecurityCategory> securityCategories = // List of SecurityCategory;
     List<SecurityCategory> deletedItemsResults = client.securityCategories().delete(securityCategories);
 
 

API Reference - Delete security categories

Parameters:

securityCategories - A list of SecurityCategory representing the security categories (id) to be deleted

Returns:

The deleted security categories via Item

Throws:

Exception

See Also:

CogniteClient, CogniteClient.securityCategories()

getClient

public abstract CogniteClient getClient()

buildPartitionsList

protected List<String> buildPartitionsList(int noPartitions)

Builds an array of partition specifications for parallel retrieval from the Cognite api. This specification is used as a parameter together with the filter / list endpoints. The number of partitions indicate the number of parallel read streams. Employ one partition specification per read stream.

Example:

 
      List<String> partitions = buildPartitionsList(getClient().getClientConfig().getNoListPartitions());
 
 

Parameters:

noPartitions - The total number of partitions

Returns:

a List of partition specifications

listJson

protected Iterator<List<String>> listJson(ResourceType resourceType,
                                          Request requestParameters,
                                          String... partitions)
                                   throws Exception

Will return the results from a list / filter api endpoint. For example, the filter assets endpoint. The results are paged through / iterated over via an Iterator--the entire results set is not buffered in memory, but streamed in "pages" from the Cognite api. If you need to buffer the entire results set, then you have to stream these results into your own data structure. This method support parallel retrieval via a set of partition specifications. The specified partitions will be collected and merged together before being returned via the Iterator.

Example:

 
      Iterator<List<String>> result = listJson(resourceType, requestParameters, partitions);
 
 

Parameters:

resourceType - The resource type to query / filter / list. Ex. event, asset, time series.

requestParameters - The query / filter specification. Follows the Cognite api request parameters.

partitions - An optional set of partitions to read via.

Returns:

an Iterator over the results set.

Throws:

Exception

See Also:

listJson(ResourceType,Request,String,String...)

listJson

protected Iterator<List<String>> listJson(ResourceType resourceType,
                                          Request requestParameters,
                                          String partitionKey,
                                          String... partitions)
                                   throws Exception

Will return the results from a list / filter api endpoint. For example, the filter assets endpoint. The results are paged through / iterated over via an Iterator--the entire results set is not buffered in memory, but streamed in "pages" from the Cognite api. If you need to buffer the entire results set, then you have to stream these results into your own data structure. This method support parallel retrieval via a set of partition specifications. The specified partitions will be collected and merged together before being returned via the Iterator.

Example:

 
      Iterator<List<String>> result = listJson(resourceType, requestParameters, partitionKey, partitions);
 
 

Parameters:

resourceType - The resource type to query / filter / list. Ex. event, asset, time series.

requestParameters - The query / filter specification. Follows the Cognite api request parameters.

partitionKey - The key to use for the partitions in the read request. For example partition or cursor.

partitions - An optional set of partitions to read via.

Returns:

an Iterator over the results set.

Throws:

Exception

retrieveJson

protected List<String> retrieveJson(ResourceType resourceType,
                                    Collection<Item> items)
                             throws Exception

Retrieve items by id. Will ignore unknown ids by default.

Example:

 
      Collection<Item> items = //Collection of items with ids;
      List<String> result = retrieveJson(resourceType, items);
 
 

Parameters:

resourceType - The item resource type (Event, Asset, etc.) to retrieve.

items - The item(s) externalId / id to retrieve.

Returns:

The items in Json representation.

Throws:

Exception

See Also:

retrieveJson(ResourceType,Collection,Map)

retrieveJson

protected List<String> retrieveJson(ResourceType resourceType,
                                    Collection<Item> items,
                                    Map<String,Object> parameters)
                             throws Exception

Retrieve items by id. This version allows you to explicitly set additional parameters for the retrieve request. For example: <"ignoreUnknownIds", true> and <"fetchResources", true>.

Example:

 
      Collection<Item> items = //Collection of items with ids;
      Map<String, Object> parameters = //Parameters;
      List<String> result = retrieveJson(resourceType, items, parameters);
 
 

Parameters:

resourceType - The item resource type (Event, Asset, etc.) to retrieve.

items - The item(s) externalId / id to retrieve.

parameters - Additional parameters for the request. For example <"ignoreUnknownIds", true>

Returns:

The items in Json representation.

Throws:

Exception

aggregate

protected Aggregate aggregate(ResourceType resourceType,
                              Request requestParameters)
                       throws Exception

Performs an item aggregation request to Cognite Data Fusion. The default aggregation is a total item count based on the (optional) filters in the request. Some resource types, for example Event, supports multiple types of aggregation.

Example:

 
      Aggregate aggregateResult = aggregate(resourceType,requestParameters);
 
 

Parameters:

resourceType - The resource type to perform aggregation of.

requestParameters - The request containing filters.

Returns:

The aggregation result.

Throws:

Exception

See Also:

Cognite API v1 specification

addAuthInfo

protected Request addAuthInfo(Request request)
                       throws Exception

Adds the required authentication information into the request object. If the request object already have complete auth info nothing will be added. The following authentication schemes are supported: 1) API key. When using an api key, this service will look up the corresponding project/tenant to issue requests to.

Example:

 
      Request requestParams = addAuthInfo(request);
 
 

Parameters:

request - The request to enrich with auth information.

Returns:

The request parameters with auth info added to it.

Throws:

Exception

getListResponseIterator

protected Iterator<CompletableFuture<ResponseItems<String>>> getListResponseIterator(ResourceType resourceType,
                                                                                     Request requestParameters)
                                                                              throws Exception

Throws:

Exception

parseItems

protected List<Item> parseItems(List<String> input)
                         throws Exception

Parses a list of item object in json representation to typed objects.

Example:

 
      List<String> input = //List of json;
      List<Item> resultList = parseItems(input);
 
 

Parameters:

input - the item list in Json string representation

Returns:

the parsed item objects

Throws:

Exception

toRequestItems

protected List<Map<String,Object>> toRequestItems(Collection<Item> itemList)

Converts a list of Item to a request object structure (that can later be parsed to Json).

Example:

 
      Collection<Item> itemList = //Collection of items;
      List<Map<String, Object>> result = toRequestItems(itemList);
 
 

Parameters:

itemList - The items to parse.

Returns:

The items in request item object form.

deDuplicate

protected List<Item> deDuplicate(Collection<Item> itemList)

De-duplicates a collection of Item.

Example:

 
      Collection<Item> itemList = //Collection of items;
      List<Item> result = deDuplicate(itemList);
 
 

Parameters:

itemList -

Returns:

itemsHaveId

protected boolean itemsHaveId(Collection<Item> items)

Returns true if all items contain either an externalId or id.

Example:

 
      Collection<Item> items = //Collection of items;
      boolean result = itemsHaveId(items);
 
 

Parameters:

items -

Returns:

mapItemToId

protected Map<String,Item> mapItemToId(Collection<Item> items)

Maps all items to their externalId (primary) or id (secondary). If the id function does not return any identity, the item will be mapped to the empty string. Via the identity mapping, this function will also perform deduplication of the input items.

Example:

 
      Collection<Item> items = //Collection of items;
      Map<String, Item> result = mapItemToId(items);
 
 

Parameters:

items - the items to map to externalId / id.

Returns:

the Map with all items mapped to externalId / id.

parseString

protected String parseString(String itemJson,
                             String fieldName)

Try parsing the specified Json path as a String.

Example:

 
      String json = //String of json object
      String result = parseString(json, "name");
 
 

Parameters:

itemJson - The Json string

fieldName - The Json path to parse

Returns:

The Json path as a String.

parseName

protected String parseName(String json)

Returns the name attribute value from a json input.

Example:

 
      String json = //String of json object
      String result = parseName(json);
 
 

Parameters:

json - the json to parse

Returns:

The name value