程序包 com.alibaba.graphscope.interactive.openapi.api

类 QueryServiceApi

java.lang.Object

com.alibaba.graphscope.interactive.openapi.api.QueryServiceApi

public class QueryServiceApi
extends Object

构造器概要

构造器

构造器	说明
QueryServiceApi()
QueryServiceApi(ApiClient apiClient)

方法概要

修饰符和类型	方法	说明
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
byte[]	procCall(String graphId, String xInteractiveRequestFormat, byte[] body)	run queries on graph After the procedure is created, user can use this API to run the procedure.
okhttp3.Call	procCallAsync(String graphId, String xInteractiveRequestFormat, byte[] body, ApiCallback<byte[]> _callback)	run queries on graph (asynchronously) After the procedure is created, user can use this API to run the procedure.
okhttp3.Call	procCallCall(String graphId, String xInteractiveRequestFormat, byte[] body, ApiCallback _callback)	Build call for procCall
byte[]	procCallCurrent(String xInteractiveRequestFormat, byte[] body)	run queries on the running graph Submit a query to the running graph.
okhttp3.Call	procCallCurrentAsync(String xInteractiveRequestFormat, byte[] body, ApiCallback<byte[]> _callback)	run queries on the running graph (asynchronously) Submit a query to the running graph.
okhttp3.Call	procCallCurrentCall(String xInteractiveRequestFormat, byte[] body, ApiCallback _callback)	Build call for procCallCurrent
ApiResponse<byte[]>	procCallCurrentWithHttpInfo(String xInteractiveRequestFormat, byte[] body)	run queries on the running graph Submit a query to the running graph.
ApiResponse<byte[]>	procCallWithHttpInfo(String graphId, String xInteractiveRequestFormat, byte[] body)	run queries on graph After the procedure is created, user can use this API to run the procedure.
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

QueryServiceApi

public QueryServiceApi()

QueryServiceApi

public QueryServiceApi(ApiClient apiClient)

方法详细资料

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

procCallCall

public okhttp3.Call procCallCall(String graphId,
                                 String xInteractiveRequestFormat,
                                 byte[] body,
                                 ApiCallback _callback)
                          throws ApiException

Build call for procCall

参数:

graphId - (required)

xInteractiveRequestFormat - (required)

body - (optional)

_callback - Callback for upload/download progress

返回:

Call to execute

抛出:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Successfully runned. Empty if failed?	-
500	Server internal error	-

procCall

public byte[] procCall(String graphId,
                       String xInteractiveRequestFormat,
                       byte[] body)
                throws ApiException

run queries on graph After the procedure is created, user can use this API to run the procedure. TODO: a full example cypher->plan->json. TODO: make sure typeinfo can be passed.

参数:

graphId - (required)

xInteractiveRequestFormat - (required)

body - (optional)

返回:

byte[]

抛出:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Successfully runned. Empty if failed?	-
500	Server internal error	-

procCallWithHttpInfo

public ApiResponse<byte[]> procCallWithHttpInfo(String graphId,
                                                String xInteractiveRequestFormat,
                                                byte[] body)
                                         throws ApiException

run queries on graph After the procedure is created, user can use this API to run the procedure. TODO: a full example cypher->plan->json. TODO: make sure typeinfo can be passed.

参数:

graphId - (required)

xInteractiveRequestFormat - (required)

body - (optional)

返回:

ApiResponse<byte[]>

抛出:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Successfully runned. Empty if failed?	-
500	Server internal error	-

procCallAsync

public okhttp3.Call procCallAsync(String graphId,
                                  String xInteractiveRequestFormat,
                                  byte[] body,
                                  ApiCallback<byte[]> _callback)
                           throws ApiException

run queries on graph (asynchronously) After the procedure is created, user can use this API to run the procedure. TODO: a full example cypher->plan->json. TODO: make sure typeinfo can be passed.

参数:

graphId - (required)

xInteractiveRequestFormat - (required)

body - (optional)

_callback - The callback to be executed when the API call finishes

返回:

The request call

抛出:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Successfully runned. Empty if failed?	-
500	Server internal error	-

procCallCurrentCall

public okhttp3.Call procCallCurrentCall(String xInteractiveRequestFormat,
                                        byte[] body,
                                        ApiCallback _callback)
                                 throws ApiException

Build call for procCallCurrent

参数:

xInteractiveRequestFormat - (required)

body - (optional)

_callback - Callback for upload/download progress

返回:

Call to execute

抛出:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Successfully runned. Empty if failed?	-
500	Server internal error	-

procCallCurrent

public byte[] procCallCurrent(String xInteractiveRequestFormat,
                              byte[] body)
                       throws ApiException

run queries on the running graph Submit a query to the running graph.

参数:

xInteractiveRequestFormat - (required)

body - (optional)

返回:

byte[]

抛出:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Successfully runned. Empty if failed?	-
500	Server internal error	-

procCallCurrentWithHttpInfo

public ApiResponse<byte[]> procCallCurrentWithHttpInfo(String xInteractiveRequestFormat,
                                                       byte[] body)
                                                throws ApiException

run queries on the running graph Submit a query to the running graph.

参数:

xInteractiveRequestFormat - (required)

body - (optional)

返回:

ApiResponse<byte[]>

抛出:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Successfully runned. Empty if failed?	-
500	Server internal error	-

procCallCurrentAsync

public okhttp3.Call procCallCurrentAsync(String xInteractiveRequestFormat,
                                         byte[] body,
                                         ApiCallback<byte[]> _callback)
                                  throws ApiException

run queries on the running graph (asynchronously) Submit a query to the running graph.

参数:

xInteractiveRequestFormat - (required)

body - (optional)

_callback - The callback to be executed when the API call finishes

返回:

The request call

抛出:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Successfully runned. Empty if failed?	-
500	Server internal error	-