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

类 GraphServiceVertexManagementApi

java.lang.Object

com.alibaba.graphscope.interactive.openapi.api.GraphServiceVertexManagementApi

public class GraphServiceVertexManagementApi
extends Object

构造器概要

构造器

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

方法概要

修饰符和类型	方法	说明
String	addVertex(String graphId, VertexRequest vertexRequest)	Add vertex to the graph Add the provided vertex to the specified graph.
okhttp3.Call	addVertexAsync(String graphId, VertexRequest vertexRequest, ApiCallback<String> _callback)	Add vertex to the graph (asynchronously) Add the provided vertex to the specified graph.
okhttp3.Call	addVertexCall(String graphId, VertexRequest vertexRequest, ApiCallback _callback)	Build call for addVertex
ApiResponse<String>	addVertexWithHttpInfo(String graphId, VertexRequest vertexRequest)	Add vertex to the graph Add the provided vertex to the specified graph.
String	deleteVertex(String graphId, String label, Object primaryKeyValue)	Remove vertex from the graph Remove the vertex from the specified graph.
okhttp3.Call	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	deleteVertexCall(String graphId, String label, Object primaryKeyValue, ApiCallback _callback)	Build call for deleteVertex
ApiResponse<String>	deleteVertexWithHttpInfo(String graphId, String label, Object primaryKeyValue)	Remove vertex from the graph Remove the vertex from the specified graph.
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
VertexData	getVertex(String graphId, String label, Object primaryKeyValue)	Get the vertex's properties with vertex primary key.
okhttp3.Call	getVertexAsync(String graphId, String label, Object primaryKeyValue, ApiCallback<VertexData> _callback)	Get the vertex's properties with vertex primary key.
okhttp3.Call	getVertexCall(String graphId, String label, Object primaryKeyValue, ApiCallback _callback)	Build call for getVertex
ApiResponse<VertexData>	getVertexWithHttpInfo(String graphId, String label, Object primaryKeyValue)	Get the vertex's properties with vertex primary key.
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)
String	updateVertex(String graphId, VertexRequest vertexRequest)	Update vertex's property Remove the vertex from the specified graph.
okhttp3.Call	updateVertexAsync(String graphId, VertexRequest vertexRequest, ApiCallback<String> _callback)	Update vertex's property (asynchronously) Remove the vertex from the specified graph.
okhttp3.Call	updateVertexCall(String graphId, VertexRequest vertexRequest, ApiCallback _callback)	Build call for updateVertex
ApiResponse<String>	updateVertexWithHttpInfo(String graphId, VertexRequest vertexRequest)	Update vertex's property Remove the vertex from the specified graph.

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

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

构造器详细资料

GraphServiceVertexManagementApi

public GraphServiceVertexManagementApi()

GraphServiceVertexManagementApi

public GraphServiceVertexManagementApi(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)

addVertexCall

public okhttp3.Call addVertexCall(String graphId,
                                  VertexRequest vertexRequest,
                                  ApiCallback _callback)
                           throws ApiException

Build call for addVertex

参数:

graphId - (required)

vertexRequest - Add vertex to graph. (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 created vertex	-
400	Invalid input vertex	-
404	Graph not found	-
409	Vertex already exists	-
500	Server internal error	-

addVertex

public String addVertex(String graphId,
                        VertexRequest vertexRequest)
                 throws ApiException

Add vertex to the graph Add the provided vertex to the specified graph.

参数:

graphId - (required)

vertexRequest - Add vertex to graph. (optional)

返回:

String

抛出:

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 created vertex	-
400	Invalid input vertex	-
404	Graph not found	-
409	Vertex already exists	-
500	Server internal error	-

addVertexWithHttpInfo

public ApiResponse<String> addVertexWithHttpInfo(String graphId,
                                                 VertexRequest vertexRequest)
                                          throws ApiException

Add vertex to the graph Add the provided vertex to the specified graph.

参数:

graphId - (required)

vertexRequest - Add vertex to graph. (optional)

返回:

ApiResponse<String>

抛出:

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 created vertex	-
400	Invalid input vertex	-
404	Graph not found	-
409	Vertex already exists	-
500	Server internal error	-

addVertexAsync

public okhttp3.Call addVertexAsync(String graphId,
                                   VertexRequest vertexRequest,
                                   ApiCallback<String> _callback)
                            throws ApiException

Add vertex to the graph (asynchronously) Add the provided vertex to the specified graph.

参数:

graphId - (required)

vertexRequest - Add vertex to graph. (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 created vertex	-
400	Invalid input vertex	-
404	Graph not found	-
409	Vertex already exists	-
500	Server internal error	-

deleteVertexCall

public okhttp3.Call deleteVertexCall(String graphId,
                                     String label,
                                     Object primaryKeyValue,
                                     ApiCallback _callback)
                              throws ApiException

Build call for deleteVertex

参数:

graphId - (required)

label - The label name of querying vertex. (required)

primaryKeyValue - The value of the querying vertex's primary key (required)

_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 delete vertex	-
400	Invalid input vertex	-
404	Vertex not exists or Graph not exits.	-
500	Server internal error	-

deleteVertex

public String deleteVertex(String graphId,
                           String label,
                           Object primaryKeyValue)
                    throws ApiException

Remove vertex from the graph Remove the vertex from the specified graph.

参数:

graphId - (required)

label - The label name of querying vertex. (required)

primaryKeyValue - The value of the querying vertex's primary key (required)

返回:

String

抛出:

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 delete vertex	-
400	Invalid input vertex	-
404	Vertex not exists or Graph not exits.	-
500	Server internal error	-

deleteVertexWithHttpInfo

public ApiResponse<String> deleteVertexWithHttpInfo(String graphId,
                                                    String label,
                                                    Object primaryKeyValue)
                                             throws ApiException

Remove vertex from the graph Remove the vertex from the specified graph.

参数:

graphId - (required)

label - The label name of querying vertex. (required)

primaryKeyValue - The value of the querying vertex's primary key (required)

返回:

ApiResponse<String>

抛出:

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 delete vertex	-
400	Invalid input vertex	-
404	Vertex not exists or Graph not exits.	-
500	Server internal error	-

deleteVertexAsync

public okhttp3.Call deleteVertexAsync(String graphId,
                                      String label,
                                      Object primaryKeyValue,
                                      ApiCallback<String> _callback)
                               throws ApiException

Remove vertex from the graph (asynchronously) Remove the vertex from the specified graph.

参数:

graphId - (required)

label - The label name of querying vertex. (required)

primaryKeyValue - The value of the querying vertex's primary key (required)

_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 delete vertex	-
400	Invalid input vertex	-
404	Vertex not exists or Graph not exits.	-
500	Server internal error	-

getVertexCall

public okhttp3.Call getVertexCall(String graphId,
                                  String label,
                                  Object primaryKeyValue,
                                  ApiCallback _callback)
                           throws ApiException

Build call for getVertex

参数:

graphId - The name of the graph (required)

label - The label name of querying vertex. (required)

primaryKeyValue - The primary key value of querying vertex. (required)

_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	Found vertex	-
400	Bad input parameter	-
404	Vertex not found or graph not found	-
500	Server internal error	-

getVertex

public VertexData getVertex(String graphId,
                            String label,
                            Object primaryKeyValue)
                     throws ApiException

Get the vertex's properties with vertex primary key. Get the properties for the specified vertex. example: ```http GET /endpoint?param1=value1&param2=value2 HTTP/1.1 Host: example.com ```

参数:

graphId - The name of the graph (required)

label - The label name of querying vertex. (required)

primaryKeyValue - The primary key value of querying vertex. (required)

返回:

VertexData

抛出:

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	Found vertex	-
400	Bad input parameter	-
404	Vertex not found or graph not found	-
500	Server internal error	-

getVertexWithHttpInfo

public ApiResponse<VertexData> getVertexWithHttpInfo(String graphId,
                                                     String label,
                                                     Object primaryKeyValue)
                                              throws ApiException

Get the vertex's properties with vertex primary key. Get the properties for the specified vertex. example: ```http GET /endpoint?param1=value1&param2=value2 HTTP/1.1 Host: example.com ```

参数:

graphId - The name of the graph (required)

label - The label name of querying vertex. (required)

primaryKeyValue - The primary key value of querying vertex. (required)

返回:

ApiResponse<VertexData>

抛出:

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	Found vertex	-
400	Bad input parameter	-
404	Vertex not found or graph not found	-
500	Server internal error	-

getVertexAsync

public okhttp3.Call getVertexAsync(String graphId,
                                   String label,
                                   Object primaryKeyValue,
                                   ApiCallback<VertexData> _callback)
                            throws ApiException

Get the vertex's properties with vertex primary key. (asynchronously) Get the properties for the specified vertex. example: ```http GET /endpoint?param1=value1&param2=value2 HTTP/1.1 Host: example.com ```

参数:

graphId - The name of the graph (required)

label - The label name of querying vertex. (required)

primaryKeyValue - The primary key value of querying vertex. (required)

_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	Found vertex	-
400	Bad input parameter	-
404	Vertex not found or graph not found	-
500	Server internal error	-

updateVertexCall

public okhttp3.Call updateVertexCall(String graphId,
                                     VertexRequest vertexRequest,
                                     ApiCallback _callback)
                              throws ApiException

Build call for updateVertex

参数:

graphId - (required)

vertexRequest - (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 update vertex	-
400	Invalid input paramters	-
404	Vertex not exists	-
500	Server internal error	-

updateVertex

public String updateVertex(String graphId,
                           VertexRequest vertexRequest)
                    throws ApiException

Update vertex's property Remove the vertex from the specified graph.

参数:

graphId - (required)

vertexRequest - (optional)

返回:

String

抛出:

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 update vertex	-
400	Invalid input paramters	-
404	Vertex not exists	-
500	Server internal error	-

updateVertexWithHttpInfo

public ApiResponse<String> updateVertexWithHttpInfo(String graphId,
                                                    VertexRequest vertexRequest)
                                             throws ApiException

Update vertex's property Remove the vertex from the specified graph.

参数:

graphId - (required)

vertexRequest - (optional)

返回:

ApiResponse<String>

抛出:

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 update vertex	-
400	Invalid input paramters	-
404	Vertex not exists	-
500	Server internal error	-

updateVertexAsync

public okhttp3.Call updateVertexAsync(String graphId,
                                      VertexRequest vertexRequest,
                                      ApiCallback<String> _callback)
                               throws ApiException

Update vertex's property (asynchronously) Remove the vertex from the specified graph.

参数:

graphId - (required)

vertexRequest - (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 update vertex	-
400	Invalid input paramters	-
404	Vertex not exists	-
500	Server internal error	-