UdfFunctionConfig.Field (Graph Java API Reference for Property Graph (Javadoc) Release 21.1 (F32791-01))

java.lang.Object
- java.lang.Enum<UdfFunctionConfig.Field>
- - oracle.pgx.config.UdfFunctionConfig.Field

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<UdfFunctionConfig.Field>, ConfigField

Enclosing class:

UdfFunctionConfig
```
public static enum UdfFunctionConfig.Field
extends java.lang.Enum<UdfFunctionConfig.Field>
implements ConfigField
```
Fields of PGX User Defined Function Config

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ARGUMENTS` list of arguments
`FUNCTION_NAME` name of the function used as identifier in PGX
`IMPLEMENTATION_REFERENCE` reference to the UDF implementation on the classpath
`LANGUAGE` language the function is implemented in
`NAMESPACE` namespace of the function in PGX
`RETURN_TYPE` return type of the function
`SOURCE_CODE` source code of the function provided inline
`SOURCE_FUNCTION_NAME` name of the function in the source language
`SOURCE_LOCATION` source code of the function provided as a unified resource identifier, either pointing to a a local file (relative to the location of this config or absolute), a web resource (prefix `http://'` or `https://`), a HDFS path (prefix `hdfs:`) or a classpath (prefix `classpath:/` or `jar:`)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Object`	`getDefaultVal()` Gets the default value of this field.
`java.util.List<java.lang.String>`	`getKeyAliases()` Gets the key aliases of this field which are also recognized during parsing.
`java.util.List<java.lang.String>`	`getSingletonListKeyAliases()` Gets the key aliases of this field which contain single values for lists and are also recognized during parsing.
`java.lang.Class<?>`	`getType()` Gets the type of this field.
`boolean`	`isArray()` Checks if this field is an array.
`boolean`	`isHidden()` Checks if this field should be hidden.
`boolean`	`isPath()` Checks if this field is a path.
`boolean`	`isRequired()` Checks if this field is required.
`boolean`	`isSensitive()` Checks if this field holds a sensitive data.
`java.lang.String`	`toKey()` Get the key of this field, which is how this field is represented in serialized form.
`java.lang.String`	`toString()`
`static UdfFunctionConfig.Field`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static UdfFunctionConfig.Field[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.pgx.config.ConfigField
isEnum, isPrimitive

- Enum Constant Detail
  - ARGUMENTS
```
public static final UdfFunctionConfig.Field ARGUMENTS
```
    list of arguments
  - FUNCTION_NAME
```
public static final UdfFunctionConfig.Field FUNCTION_NAME
```
    name of the function used as identifier in PGX
  - IMPLEMENTATION_REFERENCE
```
public static final UdfFunctionConfig.Field IMPLEMENTATION_REFERENCE
```
    reference to the UDF implementation on the classpath
  - LANGUAGE
```
public static final UdfFunctionConfig.Field LANGUAGE
```
    language the function is implemented in
  - NAMESPACE
```
public static final UdfFunctionConfig.Field NAMESPACE
```
    namespace of the function in PGX
  - RETURN_TYPE
```
public static final UdfFunctionConfig.Field RETURN_TYPE
```
    return type of the function
  - SOURCE_CODE
```
public static final UdfFunctionConfig.Field SOURCE_CODE
```
    source code of the function provided inline
  - SOURCE_FUNCTION_NAME
```
public static final UdfFunctionConfig.Field SOURCE_FUNCTION_NAME
```
    name of the function in the source language
  - SOURCE_LOCATION
```
public static final UdfFunctionConfig.Field SOURCE_LOCATION
```
    source code of the function provided as a unified resource identifier, either pointing to a a local file (relative to the location of this config or absolute), a web resource (prefix http://' or https://), a HDFS path (prefix hdfs:) or a classpath (prefix classpath:/ or jar:)
- Method Detail
  - getDefaultVal
```
public java.lang.Object getDefaultVal()
```
    Description copied from interface: ConfigField
    
    Gets the default value of this field.
    
    Specified by:
    
    getDefaultVal in interface ConfigField
    
    Returns:
    
    the default value
  - getKeyAliases
```
public java.util.List<java.lang.String> getKeyAliases()
```
    Description copied from interface: ConfigField
    
    Gets the key aliases of this field which are also recognized during parsing.
    
    Specified by:
    
    getKeyAliases in interface ConfigField
    
    Returns:
    
    the key aliases
  - getSingletonListKeyAliases
```
public java.util.List<java.lang.String> getSingletonListKeyAliases()
```
    Description copied from interface: ConfigField
    
    Gets the key aliases of this field which contain single values for lists and are also recognized during parsing.
    
    Specified by:
    
    getSingletonListKeyAliases in interface ConfigField
    
    Returns:
    
    the singleton list key aliases
  - getType
```
public java.lang.Class<?> getType()
```
    Description copied from interface: ConfigField
    
    Gets the type of this field.
    
    Specified by:
    
    getType in interface ConfigField
    
    Returns:
    
    the type
  - isArray
```
public boolean isArray()
```
    Description copied from interface: ConfigField
    
    Checks if this field is an array.
    
    Specified by:
    
    isArray in interface ConfigField
    
    Returns:
    
    true, if array
  - isHidden
```
public boolean isHidden()
```
    Description copied from interface: ConfigField
    
    Checks if this field should be hidden. Hidden fields are used to hid desired field from the user and only allow it for internal usage.
    
    Specified by:
    
    isHidden in interface ConfigField
    
    Returns:
    
    true if field should be hidden, false otherwise
  - isPath
```
public boolean isPath()
```
    Description copied from interface: ConfigField
    
    Checks if this field is a path.
    
    Specified by:
    
    isPath in interface ConfigField
    
    Returns:
    
    true, if path
  - isRequired
```
public boolean isRequired()
```
    Description copied from interface: ConfigField
    
    Checks if this field is required.
    
    Specified by:
    
    isRequired in interface ConfigField
    
    Returns:
    
    true, if required
  - isSensitive
```
public boolean isSensitive()
```
    Description copied from interface: ConfigField
    
    Checks if this field holds a sensitive data.
    
    Specified by:
    
    isSensitive in interface ConfigField
    
    Returns:
    
    true, if use for sensitive data
  - toKey
```
public java.lang.String toKey()
```
    Description copied from interface: ConfigField
    
    Get the key of this field, which is how this field is represented in serialized form.
    
    Specified by:
    
    toKey in interface ConfigField
    
    Returns:
    
    the key.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Enum<UdfFunctionConfig.Field>
  - valueOf
```
public static UdfFunctionConfig.Field valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - values
```
public static UdfFunctionConfig.Field[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (UdfFunctionConfig.Field c : UdfFunctionConfig.Field.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared

Enum UdfFunctionConfig.Field

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Methods inherited from interface oracle.pgx.config.ConfigField

Enum Constant Detail

ARGUMENTS

FUNCTION_NAME

IMPLEMENTATION_REFERENCE

LANGUAGE

NAMESPACE

RETURN_TYPE

SOURCE_CODE

SOURCE_FUNCTION_NAME

SOURCE_LOCATION

Method Detail

getDefaultVal

getKeyAliases

getSingletonListKeyAliases

getType

isArray

isHidden

isPath

isRequired

isSensitive

toKey

toString

valueOf

values