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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cdf-sdk-java Show documentation

Java SDK for reading and writing from/to CDF resources.

There is a newer version: 2.3.3

/*
 * 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.google.auto.value.AutoValue;

/**
 * This class represents the Cognite contextualization api endpoint.
 *
 * It provides methods for interacting with the contextualization services.
 */
@AutoValue
public abstract class Contextualization extends ApiBase {

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

    /**
     * Constructs a new {@link Contextualization} object using the provided client 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 assets api object.
     */
    public static Contextualization of(CogniteClient client) {
        return Contextualization.builder()
                .setClient(client)
                .build();
    }

    /**
     * Returns {@link EntityMatching} representing the entity matching api services.
     *
     * @return The entity matching api object.
     */
    public EntityMatching entityMatching() {
        return EntityMatching.of(getClient());
    }

    /**
     * Returns {@link EngineeringDiagrams} representing the engineering diagrams api services.
     *
     * @return The engineering diagrams api object.
     */
    public EngineeringDiagrams engineeringDiagrams() {
        return EngineeringDiagrams.of(getClient());
    }

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