VertexBuilder (Oracle Graph Java API Reference for Property Graph Release 24.2 (F95689-01))

Type Parameters:

VID - the vertex ID type

All Superinterfaces:

GraphBuilder<VID>

All Known Subinterfaces:

VertexModifier<VID>

All Known Implementing Classes:

VertexBuilderImpl, VertexModifierImpl
```
public interface VertexBuilder<VID>
extends GraphBuilder<VID>
```
A vertex builder for defining vertices added with the GraphBuilderImpl.

See Also:

GraphBuilderImpl

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`VertexBuilder<VID>`	`addLabel(java.lang.String label)`	Adds the given label to this vertex
`VID`	`getId()`	Gets the id of the element (vertex or edge) this builder belongs to
`boolean`	`isIgnored()`	Whether this vertex builder ignores method calls `true` or if it performs calls as usual `false`.
`VertexBuilder<VID>`	`setProperty(java.lang.String key, java.lang.Object value)`	Sets the property value of this vertex with the given `key` to the given `value`.

Methods inherited from interface oracle.pgx.api.GraphBuilder
addEdge, addEdge, addEdge, addEdge, addEdge, addEdge, addVertex, addVertex, build, build, buildAsync, buildAsync, getConfigParameter, resetEdge, resetEdge, resetVertex, resetVertex, setConfigParameter, setDataSourceVersion, setRetainEdgeIds, setRetainIds, setRetainVertexIds

- Method Detail
  - setProperty
```
VertexBuilder<VID> setProperty(java.lang.String key,
                               java.lang.Object value)
```
    Sets the property value of this vertex with the given key to the given value. The first time this method is called, the type of value defines the type of the property.
    
    Parameters:
    
    key - the property key
    
    value - the value of the vertex property
    
    Returns:
    
    this vertex builder
  - addLabel
```
VertexBuilder<VID> addLabel(java.lang.String label)
```
    Adds the given label to this vertex
    
    Parameters:
    
    label - the label to be added
    
    Returns:
    
    this vertex builder
  - getId
```
VID getId()
```
    Gets the id of the element (vertex or edge) this builder belongs to
    
    Returns:
    
    the id of the element
  - isIgnored
```
boolean isIgnored()
```
    Whether this vertex builder ignores method calls true or if it performs calls as usual false. Some issues, such as incompatible changes in a changeset, can be configured to be ignored. In that case, additional method calls on the returned vertex builder object will be ignored.
    
    Returns:
    
    whether method calls are ignored
    
    Since:
    
    20.2.0