Class ReactiveScopeEventingFunctionManager
EventingFunctions
.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiondeployFunction
(String name) Deploys anEventingFunction
identified by its name.deployFunction
(String name, DeployFunctionOptions options) Deploys anEventingFunction
identified by its name with custom options.dropFunction
(String name) Removes aEventingFunction
by its name if it exists.dropFunction
(String name, DropFunctionOptions options) Removes aEventingFunction
by its name if it exists with custom options.Retrieves helpful status information about all functions currently created on the cluster.functionsStatus
(FunctionsStatusOptions options) Retrieves helpful status information about all functions currently created on the cluster with custom options.Retrieves allEventingFunctions
currently stored on the server.getAllFunctions
(GetAllFunctionsOptions options) Retrieves allEventingFunctions
currently stored on the server with custom options.getFunction
(String name) Retrieves aEventingFunction
by its name.getFunction
(String name, GetFunctionOptions options) Retrieves aEventingFunction
by its name with custom options.pauseFunction
(String name) Pauses anEventingFunction
identified by its name.pauseFunction
(String name, PauseFunctionOptions options) Pauses anEventingFunction
identified by its name with custom options.resumeFunction
(String name) Resumes anEventingFunction
identified by its name.resumeFunction
(String name, ResumeFunctionOptions options) Resumes anEventingFunction
identified by its name with custom options.undeployFunction
(String name) Undeploys anEventingFunction
identified by its name.undeployFunction
(String name, UndeployFunctionOptions options) Undeploys anEventingFunction
identified by its name with custom options.upsertFunction
(EventingFunction function) Inserts or replaces aEventingFunction
.upsertFunction
(EventingFunction function, UpsertFunctionOptions options) Inserts or replaces aEventingFunction
with custom options.
-
Constructor Details
-
ReactiveScopeEventingFunctionManager
@Internal public ReactiveScopeEventingFunctionManager(AsyncScopeEventingFunctionManager asyncManager) Creates a newReactiveScopeEventingFunctionManager
.This API is not intended to be called by the user directly, use
ReactiveCluster.eventingFunctions()
instead.- Parameters:
asyncManager
- the underlying async manager that performs the ops.
-
-
Method Details
-
upsertFunction
Inserts or replaces aEventingFunction
.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
Mono
completing when the operation is applied or failed with an error. - Throws:
EventingFunctionCompilationFailureException
- (async) if the function body cannot be compiled.CollectionNotFoundException
- (async) if the specified collection or scope does not exist.BucketNotFoundException
- (async) if the specified bucket does not exist.EventingFunctionIdenticalKeyspaceException
- (async) if the source and metadata keyspace are the same.CouchbaseException
- (async) if any other generic unhandled/unexpected errors.
-
upsertFunction
Inserts or replaces aEventingFunction
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
Mono
completing when the operation is applied or failed with an error. - Throws:
EventingFunctionCompilationFailureException
- (async) if the function body cannot be compiled.CollectionNotFoundException
- (async) if the specified collection or scope does not exist.BucketNotFoundException
- (async) if the specified bucket does not exist.EventingFunctionIdenticalKeyspaceException
- (async) if the source and metadata keyspace are the same.CouchbaseException
- (async) if any other generic unhandled/unexpected errors.
-
getFunction
Retrieves aEventingFunction
by its name.- Parameters:
name
- the name of the function to retrieve.- Returns:
- a
Mono
completing with the eventing function found or failed with an error. - Throws:
EventingFunctionNotFoundException
- (async) if the function is not found on the server.CouchbaseException
- (async) if any other generic unhandled/unexpected errors.
-
getFunction
Retrieves aEventingFunction
by its name with custom options.- Parameters:
name
- the name of the function to retrieve.options
- the custom options to apply.- Returns:
- a
Mono
completing with the eventing function found or failed with an error. - Throws:
EventingFunctionNotFoundException
- (async) if the function is not found on the server.CouchbaseException
- (async) if any other generic unhandled/unexpected errors.
-
getAllFunctions
Retrieves allEventingFunctions
currently stored on the server.If no functions are found, an empty flux is returned.
- Returns:
- a
Flux
completing with all eventing functions found or failed with an error. - Throws:
CouchbaseException
- (async) if any other generic unhandled/unexpected errors.
-
getAllFunctions
Retrieves allEventingFunctions
currently stored on the server with custom options.If no functions are found, an empty flux is returned.
- Parameters:
options
- the custom options to apply.- Returns:
- a
Flux
completing with all eventing functions found or failed with an error. - Throws:
CouchbaseException
- (async) if any other generic unhandled/unexpected errors.
-
dropFunction
Removes aEventingFunction
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 aEventingFunctionNotDeployedException
can be thrown if a function does not exist.- Parameters:
name
- the name of the function to drop.- Returns:
- a
Mono
completing when the operation is applied or failed with an error. - Throws:
EventingFunctionNotFoundException
- (async) if the function is not found on the server.EventingFunctionNotDeployedException
- (async) if the function is not found on the server (see above).EventingFunctionDeployedException
- (async) if the function is currently deployed (undeploy first).CouchbaseException
- (async) if any other generic unhandled/unexpected errors.
-
dropFunction
Removes aEventingFunction
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 aEventingFunctionNotDeployedException
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
Mono
completing when the operation is applied or failed with an error. - Throws:
EventingFunctionNotFoundException
- (async) if the function is not found on the server.EventingFunctionNotDeployedException
- (async) if the function is not found on the server (see above).EventingFunctionDeployedException
- (async) if the function is currently deployed (undeploy first).CouchbaseException
- (async) if any other generic unhandled/unexpected errors.
-
deployFunction
Deploys anEventingFunction
identified by its name.Calling this method effectively moves the function from state
EventingFunctionDeploymentStatus.UNDEPLOYED
to stateEventingFunctionDeploymentStatus.DEPLOYED
.- Parameters:
name
- the name of the function to deploy.- Returns:
- a
Mono
completing when the operation is applied or failed with an error. - Throws:
EventingFunctionNotFoundException
- (async) if the function is not found on the server.EventingFunctionNotBootstrappedException
- (async) if the function is not bootstrapped yet (after creating it).CouchbaseException
- (async) if any other generic unhandled/unexpected errors.
-
deployFunction
Deploys anEventingFunction
identified by its name with custom options.Calling this method effectively moves the function from state
EventingFunctionDeploymentStatus.UNDEPLOYED
to stateEventingFunctionDeploymentStatus.DEPLOYED
.- Parameters:
name
- the name of the function to deploy.options
- the custom options to apply.- Returns:
- a
Mono
completing when the operation is applied or failed with an error. - Throws:
EventingFunctionNotFoundException
- (async) if the function is not found on the server.EventingFunctionNotBootstrappedException
- (async) if the function is not bootstrapped yet (after creating it).CouchbaseException
- (async) if any other generic unhandled/unexpected errors.
-
undeployFunction
Undeploys anEventingFunction
identified by its name.Calling this method effectively moves the function from state
EventingFunctionDeploymentStatus.DEPLOYED
to stateEventingFunctionDeploymentStatus.UNDEPLOYED
.Note that due to a bug on the server, depending on which version is used, both a
EventingFunctionNotFoundException
or aEventingFunctionNotDeployedException
can be thrown if a function does not exist.- Parameters:
name
- the name of the function to undeploy.- Returns:
- a
Mono
completing when the operation is applied or failed with an error. - Throws:
EventingFunctionNotFoundException
- (async) if the function is not found on the server.EventingFunctionNotDeployedException
- (async) if the function is not found on the server (see above).CouchbaseException
- (async) if any other generic unhandled/unexpected errors.
-
undeployFunction
Undeploys anEventingFunction
identified by its name with custom options.Calling this method effectively moves the function from state
EventingFunctionDeploymentStatus.DEPLOYED
to stateEventingFunctionDeploymentStatus.UNDEPLOYED
.Note that due to a bug on the server, depending on which version is used, both a
EventingFunctionNotFoundException
or aEventingFunctionNotDeployedException
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
Mono
completing when the operation is applied or failed with an error. - Throws:
EventingFunctionNotFoundException
- (async) if the function is not found on the server.EventingFunctionNotDeployedException
- (async) if the function is not found on the server (see above).CouchbaseException
- (async) if any other generic unhandled/unexpected errors.
-
pauseFunction
Pauses anEventingFunction
identified by its name.Calling this method effectively moves the function from state
EventingFunctionProcessingStatus.RUNNING
to stateEventingFunctionProcessingStatus.PAUSED
.- Parameters:
name
- the name of the function to pause.- Returns:
- a
Mono
completing when the operation is applied or failed with an error. - Throws:
EventingFunctionNotFoundException
- (async) if the function is not found on the server.EventingFunctionNotBootstrappedException
- (async) if the function is not bootstrapped yet (after creating it).CouchbaseException
- (async) if any other generic unhandled/unexpected errors.
-
pauseFunction
Pauses anEventingFunction
identified by its name with custom options.Calling this method effectively moves the function from state
EventingFunctionProcessingStatus.RUNNING
to stateEventingFunctionProcessingStatus.PAUSED
.- Parameters:
name
- the name of the function to pause.options
- the custom options to apply.- Returns:
- a
Mono
completing when the operation is applied or failed with an error. - Throws:
EventingFunctionNotFoundException
- (async) if the function is not found on the server.EventingFunctionNotBootstrappedException
- (async) if the function is not bootstrapped yet (after creating it).CouchbaseException
- (async) if any other generic unhandled/unexpected errors.
-
resumeFunction
Resumes anEventingFunction
identified by its name.Calling this method effectively moves the function from state
EventingFunctionProcessingStatus.PAUSED
to stateEventingFunctionProcessingStatus.RUNNING
.Note that due to a bug on the server, depending on which version is used, both a
EventingFunctionNotFoundException
or aEventingFunctionNotDeployedException
can be thrown if a function does not exist.- Parameters:
name
- the name of the function to resume.- Returns:
- a
Mono
completing when the operation is applied or failed with an error. - Throws:
EventingFunctionNotFoundException
- (async) if the function is not found on the server.EventingFunctionNotDeployedException
- (async) if the function is not found on the server (see above).CouchbaseException
- (async) if any other generic unhandled/unexpected errors.
-
resumeFunction
Resumes anEventingFunction
identified by its name with custom options.Calling this method effectively moves the function from state
EventingFunctionProcessingStatus.PAUSED
to stateEventingFunctionProcessingStatus.RUNNING
.Note that due to a bug on the server, depending on which version is used, both a
EventingFunctionNotFoundException
or aEventingFunctionNotDeployedException
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
Mono
completing when the operation is applied or failed with an error. - Throws:
EventingFunctionNotFoundException
- (async) if the function is not found on the server.EventingFunctionNotDeployedException
- (async) if the function is not found on the server (see above).CouchbaseException
- (async) if any other generic unhandled/unexpected errors.
-
functionsStatus
Retrieves helpful status information about all functions currently created on the cluster.- Returns:
- a
Mono
completing with the eventing status or failed with an error. - Throws:
CouchbaseException
- (async) if any other generic unhandled/unexpected errors.
-
functionsStatus
Retrieves helpful status information about all functions currently created on the cluster with custom options.- Parameters:
options
- the custom options to apply.- Returns:
- a
Mono
completing with the eventing status or failed with an error. - Throws:
CouchbaseException
- (async) if any other generic unhandled/unexpected errors.
-