com.couchbase.client.java.manager.eventing

Class AsyncScopeEventingFunctionManager

java.lang.Object

com.couchbase.client.java.manager.eventing.AsyncScopeEventingFunctionManager

@Stability.Volatile
public class AsyncScopeEventingFunctionManager
extends Object

Performs management operations on EventingFunctions.

Constructor Summary

Constructors

Constructor and Description
AsyncScopeEventingFunctionManager(com.couchbase.client.core.Core core, AsyncCluster cluster, com.couchbase.client.core.api.manager.CoreBucketAndScope scope) Creates a new AsyncScopeEventingFunctionManager.

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Void>	deployFunction(String name) Deploys an EventingFunction identified by its name.
CompletableFuture<Void>	deployFunction(String name, DeployFunctionOptions options) Deploys an EventingFunction identified by its name with custom options.
CompletableFuture<Void>	dropFunction(String name) Removes a EventingFunction by its name if it exists.
CompletableFuture<Void>	dropFunction(String name, DropFunctionOptions options) Removes a EventingFunction by its name if it exists with custom options.
CompletableFuture<EventingStatus>	functionsStatus() Retrieves helpful status information about all functions currently created on the cluster.
CompletableFuture<EventingStatus>	functionsStatus(FunctionsStatusOptions options) Retrieves helpful status information about all functions currently created on the cluster with custom options.
CompletableFuture<List<EventingFunction>>	getAllFunctions() Retrieves all EventingFunctions currently stored on the server.
CompletableFuture<List<EventingFunction>>	getAllFunctions(GetAllFunctionsOptions options) Retrieves all EventingFunctions currently stored on the server with custom options.
CompletableFuture<EventingFunction>	getFunction(String name) Retrieves a EventingFunction by its name.
CompletableFuture<EventingFunction>	getFunction(String name, GetFunctionOptions options) Retrieves a EventingFunction by its name with custom options.
CompletableFuture<Void>	pauseFunction(String name) Pauses an EventingFunction identified by its name.
CompletableFuture<Void>	pauseFunction(String name, PauseFunctionOptions options) Pauses an EventingFunction identified by its name with custom options.
CompletableFuture<Void>	resumeFunction(String name) Resumes an EventingFunction identified by its name.
CompletableFuture<Void>	resumeFunction(String name, ResumeFunctionOptions options) Resumes an EventingFunction identified by its name with custom options.
CompletableFuture<Void>	undeployFunction(String name) Undeploys an EventingFunction identified by its name.
CompletableFuture<Void>	undeployFunction(String name, UndeployFunctionOptions options) Undeploys an EventingFunction identified by its name with custom options.
CompletableFuture<Void>	upsertFunction(EventingFunction function) Inserts or replaces a EventingFunction.
CompletableFuture<Void>	upsertFunction(EventingFunction function, UpsertFunctionOptions options) Inserts or replaces a EventingFunction with custom options.

Methods inherited from class java.lang.Object

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

Constructor Detail

AsyncScopeEventingFunctionManager

@Stability.Internal
public AsyncScopeEventingFunctionManager(com.couchbase.client.core.Core core,
                                                             AsyncCluster cluster,
                                                             @Nullable
                                                             com.couchbase.client.core.api.manager.CoreBucketAndScope scope)

Creates a new AsyncScopeEventingFunctionManager.

This API is not intended to be called by the user directly, use AsyncCluster.eventingFunctions() instead.

Parameters:

core - the internal core reference.

Method Detail

upsertFunction

public CompletableFuture<Void> upsertFunction(EventingFunction function)

Inserts or replaces a EventingFunction.

The eventing management API defines that if a function is stored which name does not exist yet, it will be inserted. If the name already exists, the function will be replaced with its new equivalent and the properties changed.

Operations which change the runtime-state of a function (i.e. deploy / undeploy / pause / resume) should not be modified through this method, but rather by using those methods directly (i.e. deployFunction(String)).

Parameters:

function - the function to be inserted or replaced.

Returns:

a CompletableFuture completing when the operation is applied or failed with an error.

Throws:

com.couchbase.client.core.error.EventingFunctionCompilationFailureException - (async) if the function body cannot be compiled.

com.couchbase.client.core.error.CollectionNotFoundException - (async) if the specified collection or scope does not exist.

com.couchbase.client.core.error.BucketNotFoundException - (async) if the specified bucket does not exist.

com.couchbase.client.core.error.EventingFunctionIdenticalKeyspaceException - (async) if the source and metadata keyspace are the same.

com.couchbase.client.core.error.CouchbaseException - (async) if any other generic unhandled/unexpected errors.

upsertFunction

public CompletableFuture<Void> upsertFunction(EventingFunction function,
                                              UpsertFunctionOptions options)

Inserts or replaces a EventingFunction with custom options.

The eventing management API defines that if a function is stored which name does not exist yet, it will be inserted. If the name already exists, the function will be replaced with its new equivalent and the properties changed.

Operations which change the runtime-state of a function (i.e. deploy / undeploy / pause / resume) should not be modified through this method, but rather by using those methods directly (i.e. deployFunction(String)).

Parameters:

function - the function to be inserted or replaced.

options - the custom options to apply.

Returns:

a CompletableFuture completing when the operation is applied or failed with an error.

Throws:

com.couchbase.client.core.error.EventingFunctionCompilationFailureException - (async) if the function body cannot be compiled.

com.couchbase.client.core.error.CollectionNotFoundException - (async) if the specified collection or scope does not exist.

com.couchbase.client.core.error.BucketNotFoundException - (async) if the specified bucket does not exist.

com.couchbase.client.core.error.EventingFunctionIdenticalKeyspaceException - (async) if the source and metadata keyspace are the same.

com.couchbase.client.core.error.CouchbaseException - (async) if any other generic unhandled/unexpected errors.

getFunction

public CompletableFuture<EventingFunction> getFunction(String name)

Retrieves a EventingFunction by its name.

Parameters:

name - the name of the function to retrieve.

Returns:

a CompletableFuture completing with the eventing function found or failed with an error.

Throws:

com.couchbase.client.core.error.EventingFunctionNotFoundException - (async) if the function is not found on the server.

com.couchbase.client.core.error.CouchbaseException - (async) if any other generic unhandled/unexpected errors.

getFunction

public CompletableFuture<EventingFunction> getFunction(String name,
                                                       GetFunctionOptions options)

Retrieves a EventingFunction by its name with custom options.

Parameters:

name - the name of the function to retrieve.

options - the custom options to apply.

Returns:

a CompletableFuture completing with the eventing function found or failed with an error.

Throws:

com.couchbase.client.core.error.EventingFunctionNotFoundException - (async) if the function is not found on the server.

com.couchbase.client.core.error.CouchbaseException - (async) if any other generic unhandled/unexpected errors.

getAllFunctions

public CompletableFuture<List<EventingFunction>> getAllFunctions()

Retrieves all EventingFunctions currently stored on the server.

If no functions are found, an empty list is returned.

Returns:

a CompletableFuture completing with all eventing functions found or failed with an error.

Throws:

com.couchbase.client.core.error.CouchbaseException - (async) if any other generic unhandled/unexpected errors.

getAllFunctions

public CompletableFuture<List<EventingFunction>> getAllFunctions(GetAllFunctionsOptions options)

Retrieves all EventingFunctions currently stored on the server with custom options.

If no functions are found, an empty list is returned.

Parameters:

options - the custom options to apply.

Returns:

a CompletableFuture completing with all eventing functions found or failed with an error.

Throws:

com.couchbase.client.core.error.CouchbaseException - (async) if any other generic unhandled/unexpected errors.

dropFunction

public CompletableFuture<Void> dropFunction(String name)

Removes a EventingFunction by its name if it exists.

Note that due to a bug on the server, depending on which version is used, both a EventingFunctionNotFoundException or a EventingFunctionNotDeployedException can be thrown if a function does not exist.

Parameters:

name - the name of the function to drop.

Returns:

a CompletableFuture completing when the operation is applied or failed with an error.

Throws:

com.couchbase.client.core.error.EventingFunctionNotFoundException - (async) if the function is not found on the server.

com.couchbase.client.core.error.EventingFunctionNotDeployedException - (async) if the function is not found on the server (see above).

com.couchbase.client.core.error.EventingFunctionDeployedException - (async) if the function is currently deployed (undeploy first).

com.couchbase.client.core.error.CouchbaseException - (async) if any other generic unhandled/unexpected errors.

dropFunction

public CompletableFuture<Void> dropFunction(String name,
                                            DropFunctionOptions options)

Removes a EventingFunction by its name if it exists with custom options.

Note that due to a bug on the server, depending on which version is used, both a EventingFunctionNotFoundException or a EventingFunctionNotDeployedException can be thrown if a function does not exist.

Parameters:

name - the name of the function to drop.

options - the custom options to apply.

Returns:

a CompletableFuture completing when the operation is applied or failed with an error.

Throws:

com.couchbase.client.core.error.EventingFunctionNotFoundException - (async) if the function is not found on the server.

com.couchbase.client.core.error.EventingFunctionNotDeployedException - (async) if the function is not found on the server (see above).

com.couchbase.client.core.error.EventingFunctionDeployedException - (async) if the function is currently deployed (undeploy first).

com.couchbase.client.core.error.CouchbaseException - (async) if any other generic unhandled/unexpected errors.

deployFunction

public CompletableFuture<Void> deployFunction(String name)

Deploys an EventingFunction identified by its name.

Calling this method effectively moves the function from state EventingFunctionDeploymentStatus.UNDEPLOYED to state EventingFunctionDeploymentStatus.DEPLOYED.

Parameters:

name - the name of the function to deploy.

Returns:

a CompletableFuture completing when the operation is applied or failed with an error.

Throws:

com.couchbase.client.core.error.EventingFunctionNotFoundException - (async) if the function is not found on the server.

com.couchbase.client.core.error.EventingFunctionNotBootstrappedException - (async) if the function is not bootstrapped yet (after creating it).

com.couchbase.client.core.error.CouchbaseException - (async) if any other generic unhandled/unexpected errors.

deployFunction

public CompletableFuture<Void> deployFunction(String name,
                                              DeployFunctionOptions options)

Deploys an EventingFunction identified by its name with custom options.

Calling this method effectively moves the function from state EventingFunctionDeploymentStatus.UNDEPLOYED to state EventingFunctionDeploymentStatus.DEPLOYED.

Parameters:

name - the name of the function to deploy.

options - the custom options to apply.

Returns:

a CompletableFuture completing when the operation is applied or failed with an error.

Throws:

com.couchbase.client.core.error.EventingFunctionNotFoundException - (async) if the function is not found on the server.

com.couchbase.client.core.error.EventingFunctionNotBootstrappedException - (async) if the function is not bootstrapped yet (after creating it).

com.couchbase.client.core.error.CouchbaseException - (async) if any other generic unhandled/unexpected errors.

undeployFunction

public CompletableFuture<Void> undeployFunction(String name)

Undeploys an EventingFunction identified by its name.

Calling this method effectively moves the function from state EventingFunctionDeploymentStatus.DEPLOYED to state EventingFunctionDeploymentStatus.UNDEPLOYED.

Note that due to a bug on the server, depending on which version is used, both a EventingFunctionNotFoundException or a EventingFunctionNotDeployedException can be thrown if a function does not exist.

Parameters:

name - the name of the function to undeploy.

Returns:

a CompletableFuture completing when the operation is applied or failed with an error.

Throws:

com.couchbase.client.core.error.EventingFunctionNotFoundException - (async) if the function is not found on the server.

com.couchbase.client.core.error.EventingFunctionNotDeployedException - (async) if the function is not found on the server (see above).

com.couchbase.client.core.error.CouchbaseException - (async) if any other generic unhandled/unexpected errors.

undeployFunction

public CompletableFuture<Void> undeployFunction(String name,
                                                UndeployFunctionOptions options)

Undeploys an EventingFunction identified by its name with custom options.

Calling this method effectively moves the function from state EventingFunctionDeploymentStatus.DEPLOYED to state EventingFunctionDeploymentStatus.UNDEPLOYED.

Note that due to a bug on the server, depending on which version is used, both a EventingFunctionNotFoundException or a EventingFunctionNotDeployedException can be thrown if a function does not exist.

Parameters:

name - the name of the function to undeploy.

options - the custom options to apply.

Returns:

a CompletableFuture completing when the operation is applied or failed with an error.

Throws:

com.couchbase.client.core.error.EventingFunctionNotFoundException - (async) if the function is not found on the server.

com.couchbase.client.core.error.EventingFunctionNotDeployedException - (async) if the function is not found on the server (see above).

com.couchbase.client.core.error.CouchbaseException - (async) if any other generic unhandled/unexpected errors.

pauseFunction

public CompletableFuture<Void> pauseFunction(String name)

Pauses an EventingFunction identified by its name.

Calling this method effectively moves the function from state EventingFunctionProcessingStatus.RUNNING to state EventingFunctionProcessingStatus.PAUSED.

Parameters:

name - the name of the function to pause.

Returns:

a CompletableFuture completing when the operation is applied or failed with an error.

Throws:

com.couchbase.client.core.error.EventingFunctionNotFoundException - (async) if the function is not found on the server.

com.couchbase.client.core.error.EventingFunctionNotBootstrappedException - (async) if the function is not bootstrapped yet (after creating it).

com.couchbase.client.core.error.CouchbaseException - (async) if any other generic unhandled/unexpected errors.

pauseFunction

public CompletableFuture<Void> pauseFunction(String name,
                                             PauseFunctionOptions options)

Pauses an EventingFunction identified by its name with custom options.

Calling this method effectively moves the function from state EventingFunctionProcessingStatus.RUNNING to state EventingFunctionProcessingStatus.PAUSED.

Parameters:

name - the name of the function to pause.

options - the custom options to apply.

Returns:

a CompletableFuture completing when the operation is applied or failed with an error.

Throws:

com.couchbase.client.core.error.EventingFunctionNotFoundException - (async) if the function is not found on the server.

com.couchbase.client.core.error.EventingFunctionNotBootstrappedException - (async) if the function is not bootstrapped yet (after creating it).

com.couchbase.client.core.error.CouchbaseException - (async) if any other generic unhandled/unexpected errors.

resumeFunction

public CompletableFuture<Void> resumeFunction(String name)

Resumes an EventingFunction identified by its name.

Calling this method effectively moves the function from state EventingFunctionProcessingStatus.PAUSED to state EventingFunctionProcessingStatus.RUNNING.

Note that due to a bug on the server, depending on which version is used, both a EventingFunctionNotFoundException or a EventingFunctionNotDeployedException can be thrown if a function does not exist.

Parameters:

name - the name of the function to resume.

Returns:

a CompletableFuture completing when the operation is applied or failed with an error.

Throws:

com.couchbase.client.core.error.EventingFunctionNotFoundException - (async) if the function is not found on the server.

com.couchbase.client.core.error.EventingFunctionNotDeployedException - (async) if the function is not found on the server (see above).

com.couchbase.client.core.error.CouchbaseException - (async) if any other generic unhandled/unexpected errors.

resumeFunction

public CompletableFuture<Void> resumeFunction(String name,
                                              ResumeFunctionOptions options)

Resumes an EventingFunction identified by its name with custom options.

Calling this method effectively moves the function from state EventingFunctionProcessingStatus.PAUSED to state EventingFunctionProcessingStatus.RUNNING.

Note that due to a bug on the server, depending on which version is used, both a EventingFunctionNotFoundException or a EventingFunctionNotDeployedException can be thrown if a function does not exist.

Parameters:

name - the name of the function to resume.

options - the custom options to apply.

Returns:

a CompletableFuture completing when the operation is applied or failed with an error.

Throws:

com.couchbase.client.core.error.EventingFunctionNotFoundException - (async) if the function is not found on the server.

com.couchbase.client.core.error.EventingFunctionNotDeployedException - (async) if the function is not found on the server (see above).

com.couchbase.client.core.error.CouchbaseException - (async) if any other generic unhandled/unexpected errors.

functionsStatus

public CompletableFuture<EventingStatus> functionsStatus()

Retrieves helpful status information about all functions currently created on the cluster.

Returns:

a CompletableFuture completing with the eventing status or failed with an error.

Throws:

com.couchbase.client.core.error.CouchbaseException - (async) if any other generic unhandled/unexpected errors.

functionsStatus

public CompletableFuture<EventingStatus> functionsStatus(FunctionsStatusOptions options)

Retrieves helpful status information about all functions currently created on the cluster with custom options.

Parameters:

options - the custom options to apply.

Returns:

a CompletableFuture completing with the eventing status or failed with an error.

Throws:

com.couchbase.client.core.error.CouchbaseException - (async) if any other generic unhandled/unexpected errors.