@Stability.Volatile public class AsyncScopeEventingFunctionManager extends Object
EventingFunctions.| Constructor and Description |
|---|
AsyncScopeEventingFunctionManager(com.couchbase.client.core.Core core,
AsyncCluster cluster,
com.couchbase.client.core.api.manager.CoreBucketAndScope scope)
Creates a new
AsyncScopeEventingFunctionManager. |
@Stability.Internal
public AsyncScopeEventingFunctionManager(com.couchbase.client.core.Core core,
AsyncCluster cluster,
@Nullable
com.couchbase.client.core.api.manager.CoreBucketAndScope scope)
AsyncScopeEventingFunctionManager.
This API is not intended to be called by the user directly, use AsyncCluster.eventingFunctions()
instead.
core - the internal core reference.public CompletableFuture<Void> upsertFunction(EventingFunction function)
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)).
function - the function to be inserted or replaced.CompletableFuture completing when the operation is applied or failed with an error.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.public CompletableFuture<Void> upsertFunction(EventingFunction function, UpsertFunctionOptions options)
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)).
function - the function to be inserted or replaced.options - the custom options to apply.CompletableFuture completing when the operation is applied or failed with an error.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.public CompletableFuture<EventingFunction> getFunction(String name)
EventingFunction by its name.name - the name of the function to retrieve.CompletableFuture completing with the eventing function found or failed with an error.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.public CompletableFuture<EventingFunction> getFunction(String name, GetFunctionOptions options)
EventingFunction by its name with custom options.name - the name of the function to retrieve.options - the custom options to apply.CompletableFuture completing with the eventing function found or failed with an error.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.public CompletableFuture<List<EventingFunction>> getAllFunctions()
EventingFunctions currently stored on the server.
If no functions are found, an empty list is returned.
CompletableFuture completing with all eventing functions found or failed with an error.com.couchbase.client.core.error.CouchbaseException - (async) if any other generic unhandled/unexpected errors.public CompletableFuture<List<EventingFunction>> getAllFunctions(GetAllFunctionsOptions options)
EventingFunctions currently stored on the server with custom options.
If no functions are found, an empty list is returned.
options - the custom options to apply.CompletableFuture completing with all eventing functions found or failed with an error.com.couchbase.client.core.error.CouchbaseException - (async) if any other generic unhandled/unexpected errors.public CompletableFuture<Void> dropFunction(String name)
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.
name - the name of the function to drop.CompletableFuture completing when the operation is applied or failed with an error.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.public CompletableFuture<Void> dropFunction(String name, DropFunctionOptions options)
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.
name - the name of the function to drop.options - the custom options to apply.CompletableFuture completing when the operation is applied or failed with an error.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.public CompletableFuture<Void> deployFunction(String name)
EventingFunction identified by its name.
Calling this method effectively moves the function from state EventingFunctionDeploymentStatus.UNDEPLOYED
to state EventingFunctionDeploymentStatus.DEPLOYED.
name - the name of the function to deploy.CompletableFuture completing when the operation is applied or failed with an error.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.public CompletableFuture<Void> deployFunction(String name, DeployFunctionOptions options)
EventingFunction identified by its name with custom options.
Calling this method effectively moves the function from state EventingFunctionDeploymentStatus.UNDEPLOYED
to state EventingFunctionDeploymentStatus.DEPLOYED.
name - the name of the function to deploy.options - the custom options to apply.CompletableFuture completing when the operation is applied or failed with an error.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.public CompletableFuture<Void> undeployFunction(String name)
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.
name - the name of the function to undeploy.CompletableFuture completing when the operation is applied or failed with an error.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.public CompletableFuture<Void> undeployFunction(String name, UndeployFunctionOptions options)
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.
name - the name of the function to undeploy.options - the custom options to apply.CompletableFuture completing when the operation is applied or failed with an error.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.public CompletableFuture<Void> pauseFunction(String name)
EventingFunction identified by its name.
Calling this method effectively moves the function from state EventingFunctionProcessingStatus.RUNNING
to state EventingFunctionProcessingStatus.PAUSED.
name - the name of the function to pause.CompletableFuture completing when the operation is applied or failed with an error.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.public CompletableFuture<Void> pauseFunction(String name, PauseFunctionOptions options)
EventingFunction identified by its name with custom options.
Calling this method effectively moves the function from state EventingFunctionProcessingStatus.RUNNING
to state EventingFunctionProcessingStatus.PAUSED.
name - the name of the function to pause.options - the custom options to apply.CompletableFuture completing when the operation is applied or failed with an error.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.public CompletableFuture<Void> resumeFunction(String name)
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.
name - the name of the function to resume.CompletableFuture completing when the operation is applied or failed with an error.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.public CompletableFuture<Void> resumeFunction(String name, ResumeFunctionOptions options)
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.
name - the name of the function to resume.options - the custom options to apply.CompletableFuture completing when the operation is applied or failed with an error.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.public CompletableFuture<EventingStatus> functionsStatus()
CompletableFuture completing with the eventing status or failed with an error.com.couchbase.client.core.error.CouchbaseException - (async) if any other generic unhandled/unexpected errors.public CompletableFuture<EventingStatus> functionsStatus(FunctionsStatusOptions options)
options - the custom options to apply.CompletableFuture completing with the eventing status or failed with an error.com.couchbase.client.core.error.CouchbaseException - (async) if any other generic unhandled/unexpected errors.Copyright © 2024 Couchbase, Inc.. All rights reserved.