com.arangodb.ArangoSearch Maven / Gradle / Ivy
/*
* DISCLAIMER
*
* Copyright 2018 ArangoDB GmbH, Cologne, Germany
*
* 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.
*
* Copyright holder is ArangoDB GmbH, Cologne, Germany
*/
package com.arangodb;
import com.arangodb.entity.ViewEntity;
import com.arangodb.entity.arangosearch.ArangoSearchPropertiesEntity;
import com.arangodb.model.arangosearch.ArangoSearchCreateOptions;
import com.arangodb.model.arangosearch.ArangoSearchPropertiesOptions;
import javax.annotation.concurrent.ThreadSafe;
/**
* Interface for operations on ArangoDB view level for ArangoSearch views.
*
* @author Mark Vollmary
* @see View API Documentation
* @since ArangoDB 3.4.0
*/
@ThreadSafe
public interface ArangoSearch extends ArangoView {
/**
* Creates a view, then returns view information from the server.
*
* @return information about the view
* @see API
* Documentation
*/
ViewEntity create();
/**
* Creates a view with the given {@code options}, then returns view information from the server.
*
* @param options Additional options, can be null
* @return information about the view
* @see API
* Documentation
*/
ViewEntity create(ArangoSearchCreateOptions options);
/**
* Reads the properties of the specified view.
*
* @return properties of the view
* @see API
* Documentation
*/
ArangoSearchPropertiesEntity getProperties();
/**
* Partially changes properties of the view.
*
* @param options properties to change
* @return properties of the view
* @see API
* Documentation
*/
ArangoSearchPropertiesEntity updateProperties(ArangoSearchPropertiesOptions options);
/**
* Changes properties of the view.
*
* @param options properties to change
* @return properties of the view
* @see API
* Documentation
*/
ArangoSearchPropertiesEntity replaceProperties(ArangoSearchPropertiesOptions options);
}