org.neo4j.gds.model.ModelConfig Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of model-catalog-api Show documentation

Neo4j Graph Data Science :: Model Catalog API

There is a newer version: 2.9.0

/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [http://neo4j.com]
 *
 * This file is part of Neo4j.
 *
 * Neo4j is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package org.neo4j.gds.model;

import org.jetbrains.annotations.Nullable;
import org.neo4j.gds.annotation.Configuration;
import org.neo4j.gds.config.BaseConfig;

import java.io.Serializable;

import static org.neo4j.gds.core.StringIdentifierValidations.emptyToNull;
import static org.neo4j.gds.core.StringIdentifierValidations.validateNoWhiteCharacter;

public interface ModelConfig extends Serializable, BaseConfig {

    long serialVersionUID = 0x42L;

    String MODEL_NAME_KEY = "modelName";
    String MODEL_TYPE_KEY = "modelType";

    @Configuration.ConvertWith(method = "validateName")
    String modelName();

    @Configuration.Parameter
    String modelUser();

    static @Nullable String validateName(String input) {
        return validateNoWhiteCharacter(emptyToNull(input), MODEL_NAME_KEY);
    }

    @Configuration.Ignore
    default String username() {
        return usernameOverride().orElse(modelUser());
    }
}