ForeignKeyColumnDescriptor (Oracle Graph Java API Reference for Property Graph Release 25.2 (G28992-01))

All Known Implementing Classes:

ForeignKeyColumnConfig
```
@BetaApi
public interface ForeignKeyColumnDescriptor
```
Descriptor for a foreign key relation.

Since:

25.2.0

Method Summary

All Methods Static Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`java.lang.String`	`getName()`	Get the name of the foreign key column.
`java.lang.String`	`getReferences()`	Get the name of the key column in the references provider, e.g., the source- or destination-vertex provider.
`static ForeignKeyColumnDescriptor`	`of(java.lang.String name, java.lang.String referencedColumn)`	Create an (immutable) instance of a foreign key column descriptor.

- Method Detail
  - getName
```
java.lang.String getName()
```
    Get the name of the foreign key column.
    
    Returns:
    
    The key column name.
  - getReferences
```
@Nullable
java.lang.String getReferences()
```
    Get the name of the key column in the references provider, e.g., the source- or destination-vertex provider. This can be null, in case the source- or destination-vertex provider only has a single key column. In this case, it is assumed that this column is being referred to.
    
    Returns:
    
    The name of the referenced key column.
  - of
```
static ForeignKeyColumnDescriptor of(java.lang.String name,
                                     java.lang.String referencedColumn)
```
    Create an (immutable) instance of a foreign key column descriptor.
    
    Parameters:
    
    name - Name of the foreign key column.
    
    referencedColumn - Name of the column referenced (can be null, if there is only one column).
    
    Returns:
    
    A foreign key column descriptor instance.