• Home
• com.cognite
• cdf-sdk-java
• 1.12.0
• source code
• Labels.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.cognite.client.Labels Maven / Gradle / Ivy

/*
 * Copyright (c) 2020 Cognite AS
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.cognite.client;

import com.cognite.client.config.ResourceType;
import com.cognite.client.dto.Event;
import com.cognite.client.dto.Label;
import com.cognite.client.dto.Item;
import com.cognite.client.servicesV1.ConnectorServiceV1;
import com.cognite.client.servicesV1.parser.LabelParser;
import com.google.auto.value.AutoValue;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.stream.Collectors;

/**
 * This class represents the Cognite labels api endpoint.
 *
 * It provides methods for reading and writing {@link Label}
 */
@AutoValue
public abstract class Labels extends ApiBase {

    private static Builder builder() {
        return new AutoValue_Labels.Builder();
    }

    protected static final Logger LOG = LoggerFactory.getLogger(Labels.class);

    /**
     * Construct a new {@link Labels} object using the provided configuration.
     *
     * This method is intended for internal use--SDK clients should always use {@link CogniteClient} as the entry point
     * to this class.
     *
     * @param client The {@link CogniteClient} to use for configuration settings.
     * @return The labels api object.
     */
    public static Labels of(CogniteClient client) {
        return Labels.builder()
                .setClient(client)
                .build();
    }

    /**
     * Returns all {@link Label} objects.
     *
     * @see #list(Request)
     */
    public Iterator> list() throws Exception {
        return this.list(Request.create());
    }

    /**
     * Return all {@link Label} object that matches the filters set in the {@link Request}.
     *
     * The results are paged through / iterated over via an {@link 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, the you have
     * to stream these results into your own data structure.
     *
     * The labels are retrieved using multiple, parallel request streams towards the Cognite api. The number of
     * parallel streams are set in the {@link com.cognite.client.config.ClientConfig}.
     *
     * @param requestParameters The filters to use for retrieving labels.
     * @return An {@link Iterator} to page through the rsults set.
     * @throws Exception
     */
    public Iterator> list(Request requestParameters) throws Exception {
        List partitions = buildPartitionsList(getClient().getClientConfig().getNoListPartitions());

        return this.list(requestParameters, partitions.toArray(new String[partitions.size()]));
    }

    /**
     * Returns all {@link Label} objects that matches the filters set in the {@link Request} for the
     * specific partitions. This method is intended for advanced use cases where you need direct control over the
     * individual partitions. For example, when using the SDK in a distributed computing environment.
     *
     * The results are paged through / iterated over via an {@link Iterator}--the entire results set is not buffered in
     * memory, but streamed in "pages" from the Cognite api. If you neeed to buffer the entire results set, then you
     * have to stream these results into your own data structure.
     *
     * @param requestParameters The filters to use for retrieving the labels
     * @param partitions The partitions to include.
     * @return An {@link Iterator} to page through the results set.
     * @throws Exception
     */
    public Iterator> list(Request requestParameters, String... partitions) throws Exception {
        return AdapterIterator.of(listJson(ResourceType.LABEL, requestParameters, partitions), this::parseLabels);
    }

    /**
     * Creates or updates a set of {@link Label} objects.
     *
     * If it is a new {@link Label} object already exists in Cognite Data Fusion, it will be updated. The update
     * behaviour is specified via the update mode in teh {@link com.cognite.client.config.ClientConfig} settings.
     *
     * @param labels The labels to upsert.
     * @return The upserted labels
     * @throws Exception
     */
    public List upsert(List labels) throws Exception {
        ConnectorServiceV1 connector = getClient().getConnectorService();
        ConnectorServiceV1.ItemWriter createItemWrite = connector.writeLabels();
        ConnectorServiceV1.ItemWriter deleteItemWriter = connector.deleteLabels();

        UpsertItems upsertItems = UpsertItems.of(createItemWrite, this::toRequestInsertItem, getClient().buildAuthConfig())
                .withDeleteItemWriter(deleteItemWriter)
                .withItemMappingFunction(this::toItem)
                .withIdFunction(this::getLabelId);

        return upsertItems.upsertViaCreateAndDelete(labels).stream()
                .map(this::parseLabels)
                .collect(Collectors.toList());
    }

    /**
     * Deletes a set of Labels.
     *
     * The events to delete are identified via their {@code externalId / id} by submitting a list of {@link Item}.
     *
     * @param labels A list of {@link Item} representing the events (externalId / id) to be deleted.
     * @return The deleted events via {@link Item}.
     * @throws Exception
     */
    public List delete(List labels) throws Exception {
        ConnectorServiceV1 connector = getClient().getConnectorService();
        ConnectorServiceV1.ItemWriter deleteItemWriter = connector.deleteLabels();

        DeleteItems deleteItems = DeleteItems.of(deleteItemWriter, getClient().buildAuthConfig());

        return deleteItems.deleteItems(labels);
    }

    /*
    Wrapping the parser because we need to handle the exception--an ugly workaround since lambdas don't
    deal very well with exceptions.
     */
    private Label parseLabels(String json) {
        try {
            return LabelParser.parseLabel(json);
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }

    /*
    Wrapping the parser because we need to handle the exception--an ugly workaround since lambdas don't
    deal very well with exceptions.
     */
    private Map toRequestInsertItem(Label item) {
        try {
            return LabelParser.toRequestInsertItem(item);
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }

    /*
    Returns an item reflecting the input label. This will extract the label externalId and populate the Item with it.
     */
    private Item toItem(Label item) {
        return Item.newBuilder()
                .setExternalId(item.getExternalId())
                .build();
    }

    /*
    Returns the externalId of a label.

    If no id is found, it returns an empty Optional.
     */
    private Optional getLabelId(Label item) {
        try {
            return Optional.of(item.getExternalId());
        } catch (Exception e) {
            return Optional.empty();
        }
    }

    @AutoValue.Builder
    abstract static class Builder extends ApiBase.Builder {
        abstract Labels build();
    }
}