io.milvus.param.R Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of milvus-sdk-java Show documentation
Show all versions of milvus-sdk-java Show documentation
Java SDK for Milvus, a distributed high-performance vector database.
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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 io.milvus.param;
import io.milvus.exception.MilvusException;
import io.milvus.grpc.ErrorCode;
import org.apache.commons.lang3.exception.ExceptionUtils;
import java.util.Arrays;
import java.util.Optional;
/**
* Utility class to wrap gpc response and exceptions.
*/
public class R {
private Exception exception;
private Integer status;
private T data;
public Exception getException() {
return exception;
}
public void setException(Exception exception) {
this.exception = exception;
}
public String getMessage() { return exception.getMessage(); }
public Integer getStatus() {
return status;
}
public void setStatus(Integer status) {
this.status = status;
}
public T getData() {
return data;
}
public void setData(T data) {
this.data = data;
}
/**
* Wraps an exception for failure.
*
* @param exception exception object
* @return R
*/
public static R failed(Exception exception) {
R r = new R<>();
if (exception instanceof MilvusException) {
MilvusException e = (MilvusException) exception;
r.setStatus(e.getStatus());
} else {
r.setStatus(Status.Unknown.getCode());
}
r.setException(exception);
return r;
}
/**
* Wraps an error code and error message for failure.
*
* @param errorCode rpc error code
* @param msg error message
* @return R
*/
public static R failed(ErrorCode errorCode, String msg) {
R r = new R<>();
r.setStatus(errorCode.getNumber());
r.setException(new Exception(msg));
return r;
}
/**
* Wraps a status code and error message for failure.
*
* @param statusCode status code
* @param msg error message
* @return R
*/
public static R failed(Status statusCode, String msg) {
R r = new R<>();
r.setStatus(statusCode.getCode());
r.setException(new Exception(msg));
return r;
}
/**
* Returns a succeed status.
*
* @return R
*/
public static R success() {
R r = new R<>();
r.setStatus(Status.Success.getCode());
return r;
}
/**
* Wraps a succeed rpc response object.
*
* @param data rpc response object
* @return R
*/
public static R success(T data) {
R r = new R<>();
r.setStatus(Status.Success.getCode());
r.setData(data);
return r;
}
/**
* Represents server and client side status code
*/
public enum Status {
// Server side error
Success(0),
UnexpectedError(1),
ConnectFailed(2), // Deprecated
PermissionDenied(3), // Deprecated
CollectionNotExists(4), // Deprecated
IllegalArgument(5),
IllegalDimension(7), // Deprecated
IllegalIndexType(8), // Deprecated
IllegalCollectionName(9), // Deprecated
IllegalTOPK(10), // Deprecated
IllegalRowRecord(11), // Deprecated
IllegalVectorID(12), // Deprecated
IllegalSearchResult(13), // Deprecated
FileNotFound(14), // Deprecated
MetaFailed(15), // Deprecated
CacheFailed(16), // Deprecated
CannotCreateFolder(17), // Deprecated
CannotCreateFile(18), // Deprecated
CannotDeleteFolder(19), // Deprecated
CannotDeleteFile(20), // Deprecated
BuildIndexError(21), // Deprecated
IllegalNLIST(22), // Deprecated
IllegalMetricType(23), // Deprecated
OutOfMemory(24), // Deprecated
IndexNotExist(25), // Deprecated
EmptyCollection(26),
// internal error code.
DDRequestRace(1000), // Deprecated
// Client side error
RpcError(-1),
ClientNotConnected(-2),
Unknown(-3),
VersionMismatch(-4),
ParamError(-5),
IllegalResponse(-6);
private final int code;
Status(int code) {
this.code = code;
}
public static Status valueOf(int val) {
Optional search =
Arrays.stream(values()).filter(status -> status.code == val).findFirst();
return search.orElse(Unknown);
}
public int getCode() {
return code;
}
}
/**
* Constructs a String by R instance.
*
* @return String
*/
@Override
public String toString() {
if (exception != null) {
return "R{" +
"exception=" + ExceptionUtils.getMessage(exception) +
", status=" + status +
", data=" + data +
'}';
} else {
return "R{" +
"status=" + status +
", data=" + data +
'}';
}
}
}