UdfFunctionConfigBuilder (Oracle Graph Java API Reference Release 20.3 (F15858-03))

java.lang.Object
- oracle.pgx.config.UdfFunctionConfigBuilder

@Generated(value={"common/config/src/templates/ConfigBuilder.stg","common/config/config.gradle"})
public final class UdfFunctionConfigBuilder
extends java.lang.Object

Builder for UdfFunctionConfig.

Constructor Summary

Constructors
Constructor and Description
`UdfFunctionConfigBuilder()` Constructs an empty UdfFunctionConfigBuilder
`UdfFunctionConfigBuilder(java.util.Map<UdfFunctionConfig.Field,java.lang.Object> values)` Constructs a UdfFunctionConfigBuilder initialized with the values from the given map
`UdfFunctionConfigBuilder(UdfFunctionConfig config)` Constructs a UdfFunctionConfigBuilder initialized with the values from the given config
`UdfFunctionConfigBuilder(UdfFunctionConfigBuilder builder)` Constructs a UdfFunctionConfigBuilder initialized with the values from the given builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UdfFunctionConfig`	`build()` Builds the UdfFunctionConfig with a `parentPath` of `null`.
`UdfFunctionConfig`	`build(java.lang.String parentPath)` Builds the UdfFunctionConfig.
`static UdfFunctionConfig`	`buildUdfFunctionConfig(java.util.function.Consumer<UdfFunctionConfigBuilder> builderSetup)` Builds a `UdfFunctionConfig` in-place
`UdfFunctionConfigBuilder`	`clear()` Clears all values from the builder
`java.util.Map<UdfFunctionConfig.Field,java.lang.Object>`	`getValues()`
`UdfFunctionConfigBuilder`	`putAll(java.util.Map<UdfFunctionConfig.Field,java.lang.Object> values)` Puts all values from the given map into this builder.
`UdfFunctionConfigBuilder`	`putAll(UdfFunctionConfig config)` Puts all values from the given config into this builder
`UdfFunctionConfigBuilder`	`setArguments(java.lang.Object... arguments)` list of arguments
`UdfFunctionConfigBuilder`	`setFunctionName(java.lang.String functionName)` name of the function used as identifier in PGX
`UdfFunctionConfigBuilder`	`setImplementationReference(java.lang.String implementationReference)` reference to the UDF implementation on the classpath
`UdfFunctionConfigBuilder`	`setLanguage(UdfLanguage language)` language the function is implemented in
`UdfFunctionConfigBuilder`	`setNamespace(java.lang.String namespace)` namespace of the function in PGX
`UdfFunctionConfigBuilder`	`setReturnType(PropertyType returnType)` return type of the function
`UdfFunctionConfigBuilder`	`setSourceCode(java.lang.String sourceCode)` source code of the function provided inline
`UdfFunctionConfigBuilder`	`setSourceFunctionName(java.lang.String sourceFunctionName)` name of the function in the source language
`UdfFunctionConfigBuilder`	`setSourceLocation(java.lang.String sourceLocation)` 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:`)
`java.io.InputStream`	`toInputStream()`
`java.lang.String`	`toString()`

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

- Constructor Detail
  - UdfFunctionConfigBuilder
```
public UdfFunctionConfigBuilder()
```
    Constructs an empty UdfFunctionConfigBuilder
  - UdfFunctionConfigBuilder
```
public UdfFunctionConfigBuilder(java.util.Map<UdfFunctionConfig.Field,java.lang.Object> values)
```
    Constructs a UdfFunctionConfigBuilder initialized with the values from the given map
    
    Parameters:
    
    values - a map containing configuration values
  - UdfFunctionConfigBuilder
```
public UdfFunctionConfigBuilder(UdfFunctionConfig config)
```
    Constructs a UdfFunctionConfigBuilder initialized with the values from the given config
    
    Parameters:
    
    config - the configuration to take the values from
  - UdfFunctionConfigBuilder
```
public UdfFunctionConfigBuilder(UdfFunctionConfigBuilder builder)
```
    Constructs a UdfFunctionConfigBuilder initialized with the values from the given builder
    
    Parameters:
    
    builder - the builder to take the values from
- Method Detail
  - build
```
public UdfFunctionConfig build()
```
    Builds the UdfFunctionConfig with a parentPath of null.
    
    Returns:
    
    An instance of UdfFunctionConfig
    
    See Also:
    
    build(String)
  - build
```
public UdfFunctionConfig build(java.lang.String parentPath)
```
    Builds the UdfFunctionConfig.
    
    Parameters:
    
    parentPath - if not null, resolves relative paths against this parentPath
    
    Returns:
    
    an instance of UdfFunctionConfig
  - buildUdfFunctionConfig
```
public static UdfFunctionConfig buildUdfFunctionConfig(java.util.function.Consumer<UdfFunctionConfigBuilder> builderSetup)
```
    Builds a UdfFunctionConfig in-place
    
    Parameters:
    
    builderSetup - a consumer to setup a newly created UdfFunctionConfig
  - clear
```
public UdfFunctionConfigBuilder clear()
```
    Clears all values from the builder
  - getValues
```
public java.util.Map<UdfFunctionConfig.Field,java.lang.Object> getValues()
```
    Returns:
    
    the raw config values
  - putAll
```
public UdfFunctionConfigBuilder putAll(java.util.Map<UdfFunctionConfig.Field,java.lang.Object> values)
```
    Puts all values from the given map into this builder.
    
    Parameters:
    
    values - the values to put in the builder
  - putAll
```
public UdfFunctionConfigBuilder putAll(UdfFunctionConfig config)
```
    Puts all values from the given config into this builder
    
    Parameters:
    
    config - the config to take the values from
  - setArguments
```
public UdfFunctionConfigBuilder setArguments(java.lang.Object... arguments)
```
    list of arguments
    
    Parameters:
    
    arguments - argument
  - setFunctionName
```
public UdfFunctionConfigBuilder setFunctionName(java.lang.String functionName)
```
    name of the function used as identifier in PGX
  - setImplementationReference
```
public UdfFunctionConfigBuilder setImplementationReference(java.lang.String implementationReference)
```
    reference to the UDF implementation on the classpath
  - setLanguage
```
public UdfFunctionConfigBuilder setLanguage(UdfLanguage language)
```
    language the function is implemented in
  - setNamespace
```
public UdfFunctionConfigBuilder setNamespace(java.lang.String namespace)
```
    namespace of the function in PGX
  - setReturnType
```
public UdfFunctionConfigBuilder setReturnType(PropertyType returnType)
```
    return type of the function
  - setSourceCode
```
public UdfFunctionConfigBuilder setSourceCode(java.lang.String sourceCode)
```
    source code of the function provided inline
  - setSourceFunctionName
```
public UdfFunctionConfigBuilder setSourceFunctionName(java.lang.String sourceFunctionName)
```
    name of the function in the source language
  - setSourceLocation
```
public UdfFunctionConfigBuilder setSourceLocation(java.lang.String sourceLocation)
```
    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:)
  - toInputStream
```
public java.io.InputStream toInputStream()
```
    Returns:
    
    an InputStream representing the config
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class UdfFunctionConfigBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UdfFunctionConfigBuilder

UdfFunctionConfigBuilder

UdfFunctionConfigBuilder

UdfFunctionConfigBuilder

Method Detail

build

build

buildUdfFunctionConfig

clear

getValues

putAll

putAll

setArguments

setFunctionName

setImplementationReference

setLanguage

setNamespace

setReturnType

setSourceCode

setSourceFunctionName

setSourceLocation

toInputStream

toString