Package com.couchbase.client.java.manager.eventing

Class EventingFunctionSettings.Builder

java.lang.Object

com.couchbase.client.java.manager.eventing.EventingFunctionSettings.Builder

Enclosing class:

EventingFunctionSettings

public static class EventingFunctionSettings.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
EventingFunctionSettings.Builder	appLogDir(String appLogDir)	Directory to write content of log() message files.
EventingFunctionSettings.Builder	appLogMaxFiles(long appLogMaxFiles)	Number of log() message files to retain when rotating.
EventingFunctionSettings.Builder	appLogMaxSize(long appLogMaxSize)	Rotate logs when file grows to this size in bytes approximately.
EventingFunctionSettings.Builder	bucketCacheAge(long bucketCacheAge)	Time in milliseconds after which a cached bucket object is considered stale.
EventingFunctionSettings.Builder	bucketCacheSize(long bucketCacheSize)	Maximum size in bytes the bucket cache can grow to.
EventingFunctionSettings	build()	Builds the EventingFunctionSettings.
EventingFunctionSettings.Builder	checkpointInterval(Duration checkpointInterval)	Number of seconds before writing a progress checkpoint.
EventingFunctionSettings.Builder	cppWorkerThreadCount(long cppWorkerThreadCount)	Number of threads each worker utilizes.
EventingFunctionSettings.Builder	curlMaxAllowedRespSize(long curlMaxAllowedRespSize)	Maximum allowable curl call response in 'MegaBytes'.
EventingFunctionSettings.Builder	dcpStreamBoundary(EventingFunctionDcpBoundary dcpStreamBoundary)	Indicates where to start dcp stream from (beginning of time, present point).
EventingFunctionSettings.Builder	description(String description)	Free form text for user to describe the handler.
EventingFunctionSettings.Builder	enableAppLogRotation(boolean enableAppLogRotation)	Enable rotating this handlers log() message files.
EventingFunctionSettings.Builder	executionTimeout(Duration executionTimeout)	Maximum time the handler can run before it is forcefully terminated.
EventingFunctionSettings.Builder	handlerFooters(List<String> handlerFooters)	Code to automatically append to bottom of handler code.
EventingFunctionSettings.Builder	handlerHeaders(List<String> handlerHeaders)	Code to automatically prepend to top of handler code.
EventingFunctionSettings.Builder	languageCompatibility(EventingFunctionLanguageCompatibility languageCompatibility)	Eventing language version this handler assumes in terms of syntax and behavior.
EventingFunctionSettings.Builder	lcbInstCapacity(long lcbInstCapacity)	Maximum number of libcouchbase connections that may be opened and pooled.
EventingFunctionSettings.Builder	lcbRetryCount(long lcbRetryCount)	Number of retries of retriable libcouchbase failures.
EventingFunctionSettings.Builder	lcbTimeout(Duration lcbTimeout)	Maximum time the lcb command is waited until completion before we terminate the request.
EventingFunctionSettings.Builder	logLevel(EventingFunctionLogLevel logLevel)	Level of detail in system logging.
EventingFunctionSettings.Builder	numTimerPartitions(long numTimerPartitions)	Number of timer shards.
EventingFunctionSettings.Builder	queryConsistency(QueryScanConsistency queryConsistency)	Consistency level used by n1ql statements in the handler.
EventingFunctionSettings.Builder	queryPrepareAll(boolean queryPrepareAll)	Automatically prepare all n1ql statements in the handler.
EventingFunctionSettings.Builder	sockBatchSize(long sockBatchSize)	Batch size for messages from producer to consumer.
EventingFunctionSettings.Builder	tickDuration(Duration tickDuration)	Duration to log stats from this handler.
EventingFunctionSettings.Builder	timerContextSize(long timerContextSize)	Size limit of timer context object.
EventingFunctionSettings.Builder	userPrefix(String userPrefix)	Key prefix for all data stored in metadata by this handler.
EventingFunctionSettings.Builder	workerCount(long workerCount)	Number of worker processes handler utilizes on each eventing node.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

checkpointInterval

public EventingFunctionSettings.Builder checkpointInterval(Duration checkpointInterval)

Number of seconds before writing a progress checkpoint.

Parameters:

checkpointInterval - number of seconds before writing a progress checkpoint.

Returns:

this EventingFunctionSettings.Builder for chaining purposes.

appLogMaxFiles

public EventingFunctionSettings.Builder appLogMaxFiles(long appLogMaxFiles)

Number of log() message files to retain when rotating.

Parameters:

appLogMaxFiles - number of log() message files to retain when rotating.

Returns:

this EventingFunctionSettings.Builder for chaining purposes.

appLogMaxSize

public EventingFunctionSettings.Builder appLogMaxSize(long appLogMaxSize)

Rotate logs when file grows to this size in bytes approximately.

Parameters:

appLogMaxSize - rotate logs when file grows to this size in bytes approximately.

Returns:

this EventingFunctionSettings.Builder for chaining purposes.

appLogDir

public EventingFunctionSettings.Builder appLogDir(String appLogDir)

Directory to write content of log() message files.

Parameters:

appLogDir - directory to write content of log() message files.

Returns:

this EventingFunctionSettings.Builder for chaining purposes.

enableAppLogRotation

public EventingFunctionSettings.Builder enableAppLogRotation(boolean enableAppLogRotation)

Enable rotating this handlers log() message files.

Parameters:

enableAppLogRotation - enable rotating this handlers log() message files.

Returns:

this EventingFunctionSettings.Builder for chaining purposes.

handlerFooters

public EventingFunctionSettings.Builder handlerFooters(List<String> handlerFooters)

Code to automatically append to bottom of handler code.

Parameters:

handlerFooters - code to automatically append to bottom of handler code.

Returns:

this EventingFunctionSettings.Builder for chaining purposes.

handlerHeaders

public EventingFunctionSettings.Builder handlerHeaders(List<String> handlerHeaders)

Code to automatically prepend to top of handler code.

Parameters:

handlerHeaders - code to automatically prepend to top of handler code.

Returns:

this EventingFunctionSettings.Builder for chaining purposes.

queryPrepareAll

public EventingFunctionSettings.Builder queryPrepareAll(boolean queryPrepareAll)

Automatically prepare all n1ql statements in the handler.

Parameters:

queryPrepareAll - automatically prepare all n1ql statements in the handler.

Returns:

this EventingFunctionSettings.Builder for chaining purposes.

workerCount

public EventingFunctionSettings.Builder workerCount(long workerCount)

Number of worker processes handler utilizes on each eventing node.

Parameters:

workerCount - number of worker processes handler utilizes on each eventing node.

Returns:

this EventingFunctionSettings.Builder for chaining purposes.

cppWorkerThreadCount

public EventingFunctionSettings.Builder cppWorkerThreadCount(long cppWorkerThreadCount)

Number of threads each worker utilizes.

Parameters:

cppWorkerThreadCount - number of threads each worker utilizes.

Returns:

this EventingFunctionSettings.Builder for chaining purposes.

dcpStreamBoundary

public EventingFunctionSettings.Builder dcpStreamBoundary(EventingFunctionDcpBoundary dcpStreamBoundary)

Indicates where to start dcp stream from (beginning of time, present point).

Parameters:

dcpStreamBoundary - indicates where to start dcp stream from (beginning of time, present point).

Returns:

this EventingFunctionSettings.Builder for chaining purposes.

description

public EventingFunctionSettings.Builder description(String description)

Free form text for user to describe the handler. no functional role.

Parameters:

description - free form text for user to describe the handler. no functional role.

Returns:

this EventingFunctionSettings.Builder for chaining purposes.

logLevel

public EventingFunctionSettings.Builder logLevel(EventingFunctionLogLevel logLevel)

Level of detail in system logging.

Parameters:

logLevel - level of detail in system logging.

Returns:

this EventingFunctionSettings.Builder for chaining purposes.

languageCompatibility

public EventingFunctionSettings.Builder languageCompatibility(EventingFunctionLanguageCompatibility languageCompatibility)

Eventing language version this handler assumes in terms of syntax and behavior.

Parameters:

languageCompatibility - eventing language version this handler assumes in terms of syntax and behavior.

Returns:

this EventingFunctionSettings.Builder for chaining purposes.

executionTimeout

public EventingFunctionSettings.Builder executionTimeout(Duration executionTimeout)

Maximum time the handler can run before it is forcefully terminated.

Parameters:

executionTimeout - maximum time the handler can run before it is forcefully terminated.

Returns:

this EventingFunctionSettings.Builder for chaining purposes.

lcbInstCapacity

public EventingFunctionSettings.Builder lcbInstCapacity(long lcbInstCapacity)

Maximum number of libcouchbase connections that may be opened and pooled.

Parameters:

lcbInstCapacity - maximum number of libcouchbase connections that may be opened and pooled.

Returns:

this EventingFunctionSettings.Builder for chaining purposes.

lcbRetryCount

public EventingFunctionSettings.Builder lcbRetryCount(long lcbRetryCount)

Number of retries of retriable libcouchbase failures. 0 keeps trying till execution_timeout.

Parameters:

lcbRetryCount - number of retries of retriable libcouchbase failures. 0 keeps trying till execution_timeout.

Returns:

this EventingFunctionSettings.Builder for chaining purposes.

lcbTimeout

public EventingFunctionSettings.Builder lcbTimeout(Duration lcbTimeout)

Maximum time the lcb command is waited until completion before we terminate the request.

Parameters:

lcbTimeout - maximum time the lcb command is waited until completion before we terminate the request.

Returns:

this EventingFunctionSettings.Builder for chaining purposes.

queryConsistency

public EventingFunctionSettings.Builder queryConsistency(QueryScanConsistency queryConsistency)

Consistency level used by n1ql statements in the handler.

Parameters:

queryConsistency - consistency level used by n1ql statements in the handler.

Returns:

this EventingFunctionSettings.Builder for chaining purposes.

numTimerPartitions

public EventingFunctionSettings.Builder numTimerPartitions(long numTimerPartitions)

Number of timer shards. defaults to number of vbuckets.

Parameters:

numTimerPartitions - number of timer shards. defaults to number of vbuckets.

Returns:

this EventingFunctionSettings.Builder for chaining purposes.

sockBatchSize

public EventingFunctionSettings.Builder sockBatchSize(long sockBatchSize)

Batch size for messages from producer to consumer. normally, this must not be specified.

Parameters:

sockBatchSize - batch size for messages from producer to consumer. normally, this must not be specified.

Returns:

this EventingFunctionSettings.Builder for chaining purposes.

tickDuration

public EventingFunctionSettings.Builder tickDuration(Duration tickDuration)

Duration to log stats from this handler.

Parameters:

tickDuration - duration to log stats from this handler.

Returns:

this EventingFunctionSettings.Builder for chaining purposes.

timerContextSize

public EventingFunctionSettings.Builder timerContextSize(long timerContextSize)

Size limit of timer context object.

Parameters:

timerContextSize - size limit of timer context object.

Returns:

this EventingFunctionSettings.Builder for chaining purposes.

userPrefix

public EventingFunctionSettings.Builder userPrefix(String userPrefix)

Key prefix for all data stored in metadata by this handler.

Parameters:

userPrefix - key prefix for all data stored in metadata by this handler.

Returns:

this EventingFunctionSettings.Builder for chaining purposes.

bucketCacheSize

public EventingFunctionSettings.Builder bucketCacheSize(long bucketCacheSize)

Maximum size in bytes the bucket cache can grow to.

Parameters:

bucketCacheSize - maximum size in bytes the bucket cache can grow to.

Returns:

this EventingFunctionSettings.Builder for chaining purposes.

bucketCacheAge

public EventingFunctionSettings.Builder bucketCacheAge(long bucketCacheAge)

Time in milliseconds after which a cached bucket object is considered stale.

Parameters:

bucketCacheAge - time in milliseconds after which a cached bucket object is considered stale.

Returns:

this EventingFunctionSettings.Builder for chaining purposes.

curlMaxAllowedRespSize

public EventingFunctionSettings.Builder curlMaxAllowedRespSize(long curlMaxAllowedRespSize)

Maximum allowable curl call response in 'MegaBytes'.

Setting the value to 0 lifts the upper limit off. This parameter affects v8 engine stability since it defines the maximum amount of heap space acquired by a curl call.

Parameters:

curlMaxAllowedRespSize - maximum allowable curl call response in 'MegaBytes'.

Returns:

this EventingFunctionSettings.Builder for chaining purposes.

build

public EventingFunctionSettings build()

Builds the EventingFunctionSettings.