类的使用
com.alibaba.graphscope.interactive.openapi.ApiException

使用ApiException的程序包

程序包	说明
com.alibaba.graphscope.interactive.client.common
com.alibaba.graphscope.interactive.openapi
com.alibaba.graphscope.interactive.openapi.api
com.alibaba.graphscope.interactive.openapi.auth

com.alibaba.graphscope.interactive.client.common中ApiException的使用

参数类型为ApiException的com.alibaba.graphscope.interactive.client.common中的方法

修饰符和类型	方法	说明
static <T> Result<T>	Result.fromException(ApiException exception)
static Status	Status.fromException(ApiException exception)

com.alibaba.graphscope.interactive.openapi中ApiException的使用

参数类型为ApiException的com.alibaba.graphscope.interactive.openapi中的方法

修饰符和类型	方法	说明
void	ApiCallback.onFailure(ApiException e, int statusCode, Map<String,List<String>> responseHeaders)	This is called when the API call fails.

抛出ApiException的com.alibaba.graphscope.interactive.openapi中的方法

修饰符和类型	方法	说明
okhttp3.Call	ApiClient.buildCall(String baseUrl, String path, String method, List<Pair> queryParams, List<Pair> collectionQueryParams, Object body, Map<String,String> headerParams, Map<String,String> cookieParams, Map<String,Object> formParams, String[] authNames, ApiCallback callback)	Build HTTP call with the given options.
okhttp3.Request	ApiClient.buildRequest(String baseUrl, String path, String method, List<Pair> queryParams, List<Pair> collectionQueryParams, Object body, Map<String,String> headerParams, Map<String,String> cookieParams, Map<String,Object> formParams, String[] authNames, ApiCallback callback)	Build an HTTP request with the given options.
<T> T	ApiClient.deserialize(okhttp3.Response response, Type returnType)	Deserialize response body to Java object, according to the return type and the Content-Type response header.
File	ApiClient.downloadFileFromResponse(okhttp3.Response response)	Download file from the given response.
<T> ApiResponse<T>	ApiClient.execute(okhttp3.Call call)	ApiClient.execute(Call, Type)
<T> ApiResponse<T>	ApiClient.execute(okhttp3.Call call, Type returnType)	Execute HTTP call and deserialize the HTTP response body into the given return type.
<T> T	ApiClient.handleResponse(okhttp3.Response response, Type returnType)	Handle the given response, return the deserialized object when the response is successful.
okhttp3.RequestBody	ApiClient.serialize(Object obj, String contentType)	Serialize the given Java object into request body according to the object's class and the request Content-Type.
void	ApiClient.updateParamsForAuth(String[] authNames, List<Pair> queryParams, Map<String,String> headerParams, Map<String,String> cookieParams, String payload, String method, URI uri)	Update query and header parameters based on authentication settings.

com.alibaba.graphscope.interactive.openapi.api中ApiException的使用

抛出ApiException的com.alibaba.graphscope.interactive.openapi.api中的方法

修饰符和类型	方法	说明
String	GraphServiceEdgeManagementApi.addEdge(String graphId, EdgeRequest edgeRequest)	Add edge to the graph Add the edge to graph.
okhttp3.Call	GraphServiceEdgeManagementApi.addEdgeAsync(String graphId, EdgeRequest edgeRequest, ApiCallback<String> _callback)	Add edge to the graph (asynchronously) Add the edge to graph.
okhttp3.Call	GraphServiceEdgeManagementApi.addEdgeCall(String graphId, EdgeRequest edgeRequest, ApiCallback _callback)	Build call for addEdge
ApiResponse<String>	GraphServiceEdgeManagementApi.addEdgeWithHttpInfo(String graphId, EdgeRequest edgeRequest)	Add edge to the graph Add the edge to graph.
String	GraphServiceVertexManagementApi.addVertex(String graphId, VertexRequest vertexRequest)	Add vertex to the graph Add the provided vertex to the specified graph.
okhttp3.Call	GraphServiceVertexManagementApi.addVertexAsync(String graphId, VertexRequest vertexRequest, ApiCallback<String> _callback)	Add vertex to the graph (asynchronously) Add the provided vertex to the specified graph.
okhttp3.Call	GraphServiceVertexManagementApi.addVertexCall(String graphId, VertexRequest vertexRequest, ApiCallback _callback)	Build call for addVertex
ApiResponse<String>	GraphServiceVertexManagementApi.addVertexWithHttpInfo(String graphId, VertexRequest vertexRequest)	Add vertex to the graph Add the provided vertex to the specified graph.
JobResponse	AdminServiceGraphManagementApi.createDataloadingJob(String graphId, SchemaMapping schemaMapping)	Create a dataloading job
okhttp3.Call	AdminServiceGraphManagementApi.createDataloadingJobAsync(String graphId, SchemaMapping schemaMapping, ApiCallback<JobResponse> _callback)	(asynchronously) Create a dataloading job
okhttp3.Call	AdminServiceGraphManagementApi.createDataloadingJobCall(String graphId, SchemaMapping schemaMapping, ApiCallback _callback)	Build call for createDataloadingJob
ApiResponse<JobResponse>	AdminServiceGraphManagementApi.createDataloadingJobWithHttpInfo(String graphId, SchemaMapping schemaMapping)	Create a dataloading job
CreateGraphResponse	AdminServiceGraphManagementApi.createGraph(CreateGraphRequest createGraphRequest)	Create a new graph
okhttp3.Call	AdminServiceGraphManagementApi.createGraphAsync(CreateGraphRequest createGraphRequest, ApiCallback<CreateGraphResponse> _callback)	(asynchronously) Create a new graph
okhttp3.Call	AdminServiceGraphManagementApi.createGraphCall(CreateGraphRequest createGraphRequest, ApiCallback _callback)	Build call for createGraph
ApiResponse<CreateGraphResponse>	AdminServiceGraphManagementApi.createGraphWithHttpInfo(CreateGraphRequest createGraphRequest)	Create a new graph
CreateProcedureResponse	AdminServiceProcedureManagementApi.createProcedure(String graphId, CreateProcedureRequest createProcedureRequest)	Create a new procedure on a graph
okhttp3.Call	AdminServiceProcedureManagementApi.createProcedureAsync(String graphId, CreateProcedureRequest createProcedureRequest, ApiCallback<CreateProcedureResponse> _callback)	(asynchronously) Create a new procedure on a graph
okhttp3.Call	AdminServiceProcedureManagementApi.createProcedureCall(String graphId, CreateProcedureRequest createProcedureRequest, ApiCallback _callback)	Build call for createProcedure
ApiResponse<CreateProcedureResponse>	AdminServiceProcedureManagementApi.createProcedureWithHttpInfo(String graphId, CreateProcedureRequest createProcedureRequest)	Create a new procedure on a graph
String	GraphServiceEdgeManagementApi.deleteEdge(String graphId, String srcLabel, Object srcPrimaryKeyValue, String dstLabel, Object dstPrimaryKeyValue)	Remove edge from the graph Remove the edge from current graph.
okhttp3.Call	GraphServiceEdgeManagementApi.deleteEdgeAsync(String graphId, String srcLabel, Object srcPrimaryKeyValue, String dstLabel, Object dstPrimaryKeyValue, ApiCallback<String> _callback)	Remove edge from the graph (asynchronously) Remove the edge from current graph.
okhttp3.Call	GraphServiceEdgeManagementApi.deleteEdgeCall(String graphId, String srcLabel, Object srcPrimaryKeyValue, String dstLabel, Object dstPrimaryKeyValue, ApiCallback _callback)	Build call for deleteEdge
ApiResponse<String>	GraphServiceEdgeManagementApi.deleteEdgeWithHttpInfo(String graphId, String srcLabel, Object srcPrimaryKeyValue, String dstLabel, Object dstPrimaryKeyValue)	Remove edge from the graph Remove the edge from current graph.
String	AdminServiceGraphManagementApi.deleteGraph(String graphId)	Delete a graph by name
okhttp3.Call	AdminServiceGraphManagementApi.deleteGraphAsync(String graphId, ApiCallback<String> _callback)	(asynchronously) Delete a graph by name
okhttp3.Call	AdminServiceGraphManagementApi.deleteGraphCall(String graphId, ApiCallback _callback)	Build call for deleteGraph
ApiResponse<String>	AdminServiceGraphManagementApi.deleteGraphWithHttpInfo(String graphId)	Delete a graph by name
String	AdminServiceJobManagementApi.deleteJobById(String jobId)
okhttp3.Call	AdminServiceJobManagementApi.deleteJobByIdAsync(String jobId, ApiCallback<String> _callback)	(asynchronously)
okhttp3.Call	AdminServiceJobManagementApi.deleteJobByIdCall(String jobId, ApiCallback _callback)	Build call for deleteJobById
ApiResponse<String>	AdminServiceJobManagementApi.deleteJobByIdWithHttpInfo(String jobId)
String	AdminServiceProcedureManagementApi.deleteProcedure(String graphId, String procedureId)	Delete a procedure on a graph by name
okhttp3.Call	AdminServiceProcedureManagementApi.deleteProcedureAsync(String graphId, String procedureId, ApiCallback<String> _callback)	(asynchronously) Delete a procedure on a graph by name
okhttp3.Call	AdminServiceProcedureManagementApi.deleteProcedureCall(String graphId, String procedureId, ApiCallback _callback)	Build call for deleteProcedure
ApiResponse<String>	AdminServiceProcedureManagementApi.deleteProcedureWithHttpInfo(String graphId, String procedureId)	Delete a procedure on a graph by name
String	GraphServiceVertexManagementApi.deleteVertex(String graphId, String label, Object primaryKeyValue)	Remove vertex from the graph Remove the vertex from the specified graph.
okhttp3.Call	GraphServiceVertexManagementApi.deleteVertexAsync(String graphId, String label, Object primaryKeyValue, ApiCallback<String> _callback)	Remove vertex from the graph (asynchronously) Remove the vertex from the specified graph.
okhttp3.Call	GraphServiceVertexManagementApi.deleteVertexCall(String graphId, String label, Object primaryKeyValue, ApiCallback _callback)	Build call for deleteVertex
ApiResponse<String>	GraphServiceVertexManagementApi.deleteVertexWithHttpInfo(String graphId, String label, Object primaryKeyValue)	Remove vertex from the graph Remove the vertex from the specified graph.
EdgeData	GraphServiceEdgeManagementApi.getEdge(String graphId, String edgeLabel, String srcLabel, Object srcPrimaryKeyValue, String dstLabel, Object dstPrimaryKeyValue)	Get the edge's properties with src and dst vertex primary keys.
okhttp3.Call	GraphServiceEdgeManagementApi.getEdgeAsync(String graphId, String edgeLabel, String srcLabel, Object srcPrimaryKeyValue, String dstLabel, Object dstPrimaryKeyValue, ApiCallback<EdgeData> _callback)	Get the edge's properties with src and dst vertex primary keys.
okhttp3.Call	GraphServiceEdgeManagementApi.getEdgeCall(String graphId, String edgeLabel, String srcLabel, Object srcPrimaryKeyValue, String dstLabel, Object dstPrimaryKeyValue, ApiCallback _callback)	Build call for getEdge
ApiResponse<EdgeData>	GraphServiceEdgeManagementApi.getEdgeWithHttpInfo(String graphId, String edgeLabel, String srcLabel, Object srcPrimaryKeyValue, String dstLabel, Object dstPrimaryKeyValue)	Get the edge's properties with src and dst vertex primary keys.
GetGraphResponse	AdminServiceGraphManagementApi.getGraph(String graphId)	Get a graph by name
okhttp3.Call	AdminServiceGraphManagementApi.getGraphAsync(String graphId, ApiCallback<GetGraphResponse> _callback)	(asynchronously) Get a graph by name
okhttp3.Call	AdminServiceGraphManagementApi.getGraphCall(String graphId, ApiCallback _callback)	Build call for getGraph
ApiResponse<GetGraphResponse>	AdminServiceGraphManagementApi.getGraphWithHttpInfo(String graphId)	Get a graph by name
JobStatus	AdminServiceJobManagementApi.getJobById(String jobId)
okhttp3.Call	AdminServiceJobManagementApi.getJobByIdAsync(String jobId, ApiCallback<JobStatus> _callback)	(asynchronously)
okhttp3.Call	AdminServiceJobManagementApi.getJobByIdCall(String jobId, ApiCallback _callback)	Build call for getJobById
ApiResponse<JobStatus>	AdminServiceJobManagementApi.getJobByIdWithHttpInfo(String jobId)
GetProcedureResponse	AdminServiceProcedureManagementApi.getProcedure(String graphId, String procedureId)	Get a procedure by name
okhttp3.Call	AdminServiceProcedureManagementApi.getProcedureAsync(String graphId, String procedureId, ApiCallback<GetProcedureResponse> _callback)	(asynchronously) Get a procedure by name
okhttp3.Call	AdminServiceProcedureManagementApi.getProcedureCall(String graphId, String procedureId, ApiCallback _callback)	Build call for getProcedure
ApiResponse<GetProcedureResponse>	AdminServiceProcedureManagementApi.getProcedureWithHttpInfo(String graphId, String procedureId)	Get a procedure by name
GetGraphSchemaResponse	AdminServiceGraphManagementApi.getSchema(String graphId)	Get schema by graph name
okhttp3.Call	AdminServiceGraphManagementApi.getSchemaAsync(String graphId, ApiCallback<GetGraphSchemaResponse> _callback)	(asynchronously) Get schema by graph name
okhttp3.Call	AdminServiceGraphManagementApi.getSchemaCall(String graphId, ApiCallback _callback)	Build call for getSchema
ApiResponse<GetGraphSchemaResponse>	AdminServiceGraphManagementApi.getSchemaWithHttpInfo(String graphId)	Get schema by graph name
ServiceStatus	AdminServiceServiceManagementApi.getServiceStatus()	Get service status
okhttp3.Call	AdminServiceServiceManagementApi.getServiceStatusAsync(ApiCallback<ServiceStatus> _callback)	(asynchronously) Get service status
okhttp3.Call	AdminServiceServiceManagementApi.getServiceStatusCall(ApiCallback _callback)	Build call for getServiceStatus
ApiResponse<ServiceStatus>	AdminServiceServiceManagementApi.getServiceStatusWithHttpInfo()	Get service status
VertexData	GraphServiceVertexManagementApi.getVertex(String graphId, String label, Object primaryKeyValue)	Get the vertex's properties with vertex primary key.
okhttp3.Call	GraphServiceVertexManagementApi.getVertexAsync(String graphId, String label, Object primaryKeyValue, ApiCallback<VertexData> _callback)	Get the vertex's properties with vertex primary key.
okhttp3.Call	GraphServiceVertexManagementApi.getVertexCall(String graphId, String label, Object primaryKeyValue, ApiCallback _callback)	Build call for getVertex
ApiResponse<VertexData>	GraphServiceVertexManagementApi.getVertexWithHttpInfo(String graphId, String label, Object primaryKeyValue)	Get the vertex's properties with vertex primary key.
List<GetGraphResponse>	AdminServiceGraphManagementApi.listGraphs()	List all graphs
okhttp3.Call	AdminServiceGraphManagementApi.listGraphsAsync(ApiCallback<List<GetGraphResponse>> _callback)	(asynchronously) List all graphs
okhttp3.Call	AdminServiceGraphManagementApi.listGraphsCall(ApiCallback _callback)	Build call for listGraphs
ApiResponse<List<GetGraphResponse>>	AdminServiceGraphManagementApi.listGraphsWithHttpInfo()	List all graphs
List<JobStatus>	AdminServiceJobManagementApi.listJobs()
okhttp3.Call	AdminServiceJobManagementApi.listJobsAsync(ApiCallback<List<JobStatus>> _callback)	(asynchronously)
okhttp3.Call	AdminServiceJobManagementApi.listJobsCall(ApiCallback _callback)	Build call for listJobs
ApiResponse<List<JobStatus>>	AdminServiceJobManagementApi.listJobsWithHttpInfo()
List<GetProcedureResponse>	AdminServiceProcedureManagementApi.listProcedures(String graphId)	List all procedures
okhttp3.Call	AdminServiceProcedureManagementApi.listProceduresAsync(String graphId, ApiCallback<List<GetProcedureResponse>> _callback)	(asynchronously) List all procedures
okhttp3.Call	AdminServiceProcedureManagementApi.listProceduresCall(String graphId, ApiCallback _callback)	Build call for listProcedures
ApiResponse<List<GetProcedureResponse>>	AdminServiceProcedureManagementApi.listProceduresWithHttpInfo(String graphId)	List all procedures
byte[]	QueryServiceApi.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	QueryServiceApi.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	QueryServiceApi.procCallCall(String graphId, String xInteractiveRequestFormat, byte[] body, ApiCallback _callback)	Build call for procCall
byte[]	QueryServiceApi.procCallCurrent(String xInteractiveRequestFormat, byte[] body)	run queries on the running graph Submit a query to the running graph.
okhttp3.Call	QueryServiceApi.procCallCurrentAsync(String xInteractiveRequestFormat, byte[] body, ApiCallback<byte[]> _callback)	run queries on the running graph (asynchronously) Submit a query to the running graph.
okhttp3.Call	QueryServiceApi.procCallCurrentCall(String xInteractiveRequestFormat, byte[] body, ApiCallback _callback)	Build call for procCallCurrent
ApiResponse<byte[]>	QueryServiceApi.procCallCurrentWithHttpInfo(String xInteractiveRequestFormat, byte[] body)	run queries on the running graph Submit a query to the running graph.
ApiResponse<byte[]>	QueryServiceApi.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.
String	AdminServiceServiceManagementApi.restartService()	Start current service
okhttp3.Call	AdminServiceServiceManagementApi.restartServiceAsync(ApiCallback<String> _callback)	(asynchronously) Start current service
okhttp3.Call	AdminServiceServiceManagementApi.restartServiceCall(ApiCallback _callback)	Build call for restartService
ApiResponse<String>	AdminServiceServiceManagementApi.restartServiceWithHttpInfo()	Start current service
String	AdminServiceServiceManagementApi.startService(StartServiceRequest startServiceRequest)	Start service on a specified graph
okhttp3.Call	AdminServiceServiceManagementApi.startServiceAsync(StartServiceRequest startServiceRequest, ApiCallback<String> _callback)	(asynchronously) Start service on a specified graph
okhttp3.Call	AdminServiceServiceManagementApi.startServiceCall(StartServiceRequest startServiceRequest, ApiCallback _callback)	Build call for startService
ApiResponse<String>	AdminServiceServiceManagementApi.startServiceWithHttpInfo(StartServiceRequest startServiceRequest)	Start service on a specified graph
String	AdminServiceServiceManagementApi.stopService()	Stop current service
okhttp3.Call	AdminServiceServiceManagementApi.stopServiceAsync(ApiCallback<String> _callback)	(asynchronously) Stop current service
okhttp3.Call	AdminServiceServiceManagementApi.stopServiceCall(ApiCallback _callback)	Build call for stopService
ApiResponse<String>	AdminServiceServiceManagementApi.stopServiceWithHttpInfo()	Stop current service
String	GraphServiceEdgeManagementApi.updateEdge(String graphId, EdgeRequest edgeRequest)	Update edge's property Update the edge on the running graph.
okhttp3.Call	GraphServiceEdgeManagementApi.updateEdgeAsync(String graphId, EdgeRequest edgeRequest, ApiCallback<String> _callback)	Update edge's property (asynchronously) Update the edge on the running graph.
okhttp3.Call	GraphServiceEdgeManagementApi.updateEdgeCall(String graphId, EdgeRequest edgeRequest, ApiCallback _callback)	Build call for updateEdge
ApiResponse<String>	GraphServiceEdgeManagementApi.updateEdgeWithHttpInfo(String graphId, EdgeRequest edgeRequest)	Update edge's property Update the edge on the running graph.
String	AdminServiceProcedureManagementApi.updateProcedure(String graphId, String procedureId, UpdateProcedureRequest updateProcedureRequest)	Update procedure on a graph by name
okhttp3.Call	AdminServiceProcedureManagementApi.updateProcedureAsync(String graphId, String procedureId, UpdateProcedureRequest updateProcedureRequest, ApiCallback<String> _callback)	(asynchronously) Update procedure on a graph by name
okhttp3.Call	AdminServiceProcedureManagementApi.updateProcedureCall(String graphId, String procedureId, UpdateProcedureRequest updateProcedureRequest, ApiCallback _callback)	Build call for updateProcedure
ApiResponse<String>	AdminServiceProcedureManagementApi.updateProcedureWithHttpInfo(String graphId, String procedureId, UpdateProcedureRequest updateProcedureRequest)	Update procedure on a graph by name
String	GraphServiceVertexManagementApi.updateVertex(String graphId, VertexRequest vertexRequest)	Update vertex's property Remove the vertex from the specified graph.
okhttp3.Call	GraphServiceVertexManagementApi.updateVertexAsync(String graphId, VertexRequest vertexRequest, ApiCallback<String> _callback)	Update vertex's property (asynchronously) Remove the vertex from the specified graph.
okhttp3.Call	GraphServiceVertexManagementApi.updateVertexCall(String graphId, VertexRequest vertexRequest, ApiCallback _callback)	Build call for updateVertex
ApiResponse<String>	GraphServiceVertexManagementApi.updateVertexWithHttpInfo(String graphId, VertexRequest vertexRequest)	Update vertex's property Remove the vertex from the specified graph.

com.alibaba.graphscope.interactive.openapi.auth中ApiException的使用

抛出ApiException的com.alibaba.graphscope.interactive.openapi.auth中的方法

修饰符和类型	方法	说明
void	ApiKeyAuth.applyToParams(List<Pair> queryParams, Map<String,String> headerParams, Map<String,String> cookieParams, String payload, String method, URI uri)
void	Authentication.applyToParams(List<Pair> queryParams, Map<String,String> headerParams, Map<String,String> cookieParams, String payload, String method, URI uri)	Apply authentication settings to header and query params.
void	HttpBasicAuth.applyToParams(List<Pair> queryParams, Map<String,String> headerParams, Map<String,String> cookieParams, String payload, String method, URI uri)
void	HttpBearerAuth.applyToParams(List<Pair> queryParams, Map<String,String> headerParams, Map<String,String> cookieParams, String payload, String method, URI uri)