Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.pulsar.client.admin;
import java.util.List;
import java.util.Set;
import java.util.concurrent.CompletableFuture;
import org.apache.pulsar.client.admin.PulsarAdminException.NotAuthorizedException;
import org.apache.pulsar.client.admin.PulsarAdminException.NotFoundException;
import org.apache.pulsar.client.admin.PulsarAdminException.PreconditionFailedException;
import org.apache.pulsar.common.functions.FunctionConfig;
import org.apache.pulsar.common.functions.FunctionDefinition;
import org.apache.pulsar.common.functions.FunctionState;
import org.apache.pulsar.common.functions.UpdateOptions;
import org.apache.pulsar.common.io.ConnectorDefinition;
import org.apache.pulsar.common.policies.data.FunctionInstanceStatsData;
import org.apache.pulsar.common.policies.data.FunctionStats;
import org.apache.pulsar.common.policies.data.FunctionStatus;
/**
* Admin interface for function management.
*/
public interface Functions {
/**
* Get the list of functions.
*
* Get the list of all the Pulsar functions.
*
* Response Example:
*
*
* ["f1", "f2", "f3"]
*
*
* @throws NotAuthorizedException
* Don't have admin permission
* @throws PulsarAdminException
* Unexpected error
*/
List getFunctions(String tenant, String namespace) throws PulsarAdminException;
/**
* Get the list of functions asynchronously.
*
* Get the list of all the Pulsar functions.
*
* Response Example:
*
*
* ["f1", "f2", "f3"]
*
*
*/
CompletableFuture> getFunctionsAsync(String tenant, String namespace);
/**
* Get the configuration for the specified function.
*
* Response Example:
*
*
*
* @param tenant
* Tenant name
* @param namespace
* Namespace name
* @param function
* Function name
*
* @return the function configuration
*
* @throws NotAuthorizedException
* You don't have admin permission to get the configuration of the cluster
* @throws NotFoundException
* Cluster doesn't exist
* @throws PulsarAdminException
* Unexpected error
*/
FunctionConfig getFunction(String tenant, String namespace, String function) throws PulsarAdminException;
/**
* Get the configuration for the specified function asynchronously.
*
* Response Example:
*
*
*
* @param tenant
* Tenant name
* @param namespace
* Namespace name
* @param function
* Function name
*
* @return the function configuration
*
*/
CompletableFuture getFunctionAsync(String tenant, String namespace, String function);
/**
* Create a new function.
*
* @param functionConfig
* the function configuration object
*
* @throws PulsarAdminException
* Unexpected error
*/
void createFunction(FunctionConfig functionConfig, String fileName) throws PulsarAdminException;
/**
* Create a new function asynchronously.
*
* @param functionConfig
* the function configuration object
*/
CompletableFuture createFunctionAsync(FunctionConfig functionConfig, String fileName);
/**
* Create a new function with package url.
*
* Create a new function by providing url from which fun-pkg can be downloaded. supported url: http/file
* eg:
* File: file:/dir/fileName.jar
* Http: http://www.repo.com/fileName.jar
*
* @param functionConfig
* the function configuration object
* @param pkgUrl
* url from which pkg can be downloaded
* @throws PulsarAdminException
*/
void createFunctionWithUrl(FunctionConfig functionConfig, String pkgUrl) throws PulsarAdminException;
/**
* Create a new function with package url asynchronously.
*
* Create a new function by providing url from which fun-pkg can be downloaded. supported url: http/file
* eg:
* File: file:/dir/fileName.jar
* Http: http://www.repo.com/fileName.jar
*
* @param functionConfig
* the function configuration object
* @param pkgUrl
* url from which pkg can be downloaded
*/
CompletableFuture createFunctionWithUrlAsync(FunctionConfig functionConfig, String pkgUrl);
/**
* Update the configuration for a function.
*
*
* @param functionConfig
* the function configuration object
*
* @throws NotAuthorizedException
* You don't have admin permission to create the cluster
* @throws NotFoundException
* Cluster doesn't exist
* @throws PulsarAdminException
* Unexpected error
*/
void updateFunction(FunctionConfig functionConfig, String fileName) throws PulsarAdminException;
/**
* Update the configuration for a function asynchronously.
*
*
* @param functionConfig
* the function configuration object
*/
CompletableFuture updateFunctionAsync(FunctionConfig functionConfig, String fileName);
/**
* Update the configuration for a function.
*
*
* @param functionConfig
* the function configuration object
* @param updateOptions
* options for the update operations
* @throws NotAuthorizedException
* You don't have admin permission to create the cluster
* @throws NotFoundException
* Cluster doesn't exist
* @throws PulsarAdminException
* Unexpected error
*/
void updateFunction(FunctionConfig functionConfig, String fileName, UpdateOptions updateOptions)
throws PulsarAdminException;
/**
* Update the configuration for a function asynchronously.
*
*
* @param functionConfig
* the function configuration object
* @param updateOptions
* options for the update operations
*/
CompletableFuture updateFunctionAsync(
FunctionConfig functionConfig, String fileName, UpdateOptions updateOptions);
/**
* Update the configuration for a function.
*
* Update a function by providing url from which fun-pkg can be downloaded. supported url: http/file
* eg:
* File: file:/dir/fileName.jar
* Http: http://www.repo.com/fileName.jar
*
* @param functionConfig
* the function configuration object
* @param pkgUrl
* url from which pkg can be downloaded
* @throws NotAuthorizedException
* You don't have admin permission to create the cluster
* @throws NotFoundException
* Cluster doesn't exist
* @throws PulsarAdminException
* Unexpected error
*/
void updateFunctionWithUrl(FunctionConfig functionConfig, String pkgUrl) throws PulsarAdminException;
/**
* Update the configuration for a function asynchronously.
*
* Update a function by providing url from which fun-pkg can be downloaded. supported url: http/file
* eg:
* File: file:/dir/fileName.jar
* Http: http://www.repo.com/fileName.jar
*
* @param functionConfig
* the function configuration object
* @param pkgUrl
* url from which pkg can be downloaded
*/
CompletableFuture updateFunctionWithUrlAsync(FunctionConfig functionConfig, String pkgUrl);
/**
* Update the configuration for a function.
*
* Update a function by providing url from which fun-pkg can be downloaded. supported url: http/file
* eg:
* File: file:/dir/fileName.jar
* Http: http://www.repo.com/fileName.jar
*
* @param functionConfig
* the function configuration object
* @param pkgUrl
* url from which pkg can be downloaded
* @param updateOptions
* options for the update operations
* @throws NotAuthorizedException
* You don't have admin permission to create the cluster
* @throws NotFoundException
* Cluster doesn't exist
* @throws PulsarAdminException
* Unexpected error
*/
void updateFunctionWithUrl(FunctionConfig functionConfig, String pkgUrl, UpdateOptions updateOptions)
throws PulsarAdminException;
/**
* Update the configuration for a function asynchronously.
*
* Update a function by providing url from which fun-pkg can be downloaded. supported url: http/file
* eg:
* File: file:/dir/fileName.jar
* Http: http://www.repo.com/fileName.jar
*
* @param functionConfig
* the function configuration object
* @param pkgUrl
* url from which pkg can be downloaded
* @param updateOptions
* options for the update operations
*/
CompletableFuture updateFunctionWithUrlAsync(
FunctionConfig functionConfig, String pkgUrl, UpdateOptions updateOptions);
/**
* Delete an existing function.
*
* Delete a function
*
* @param tenant
* Tenant name
* @param namespace
* Namespace name
* @param function
* Function name
*
* @throws NotAuthorizedException
* You don't have admin permission
* @throws NotFoundException
* Cluster does not exist
* @throws PreconditionFailedException
* Cluster is not empty
* @throws PulsarAdminException
* Unexpected error
*/
void deleteFunction(String tenant, String namespace, String function) throws PulsarAdminException;
/**
* Delete an existing function asynchronously.
*
* Delete a function
*
* @param tenant
* Tenant name
* @param namespace
* Namespace name
* @param function
* Function name
*/
CompletableFuture deleteFunctionAsync(String tenant, String namespace, String function);
/**
* Gets the current status of a function.
*
* @param tenant
* Tenant name
* @param namespace
* Namespace name
* @param function
* Function name
*
* @throws PulsarAdminException
* Unexpected error
*/
FunctionStatus getFunctionStatus(String tenant, String namespace, String function) throws PulsarAdminException;
/**
* Gets the current status of a function asynchronously.
*
* @param tenant
* Tenant name
* @param namespace
* Namespace name
* @param function
* Function name
*/
CompletableFuture getFunctionStatusAsync(String tenant, String namespace, String function);
/**
* Gets the current status of a function instance.
*
* @param tenant
* Tenant name
* @param namespace
* Namespace name
* @param function
* Function name
* @param id
* Function instance-id
* @return
* @throws PulsarAdminException
*/
FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData getFunctionStatus(
String tenant, String namespace, String function, int id)
throws PulsarAdminException;
/**
* Gets the current status of a function instance asynchronously.
*
* @param tenant
* Tenant name
* @param namespace
* Namespace name
* @param function
* Function name
* @param id
* Function instance-id
* @return
*/
CompletableFuture getFunctionStatusAsync(
String tenant, String namespace, String function, int id);
/**
* Gets the current stats of a function instance.
*
* @param tenant
* Tenant name
* @param namespace
* Namespace name
* @param function
* Function name
* @param id
* Function instance-id
* @return
* @throws PulsarAdminException
*/
FunctionInstanceStatsData getFunctionStats(
String tenant, String namespace, String function, int id)
throws PulsarAdminException;
/**
* Gets the current stats of a function instance asynchronously.
*
* @param tenant
* Tenant name
* @param namespace
* Namespace name
* @param function
* Function name
* @param id
* Function instance-id
* @return
*/
CompletableFuture getFunctionStatsAsync(
String tenant, String namespace, String function, int id);
/**
* Gets the current stats of a function.
*
* @param tenant
* Tenant name
* @param namespace
* Namespace name
* @param function
* Function name
* @return
* @throws PulsarAdminException
*/
FunctionStats getFunctionStats(String tenant, String namespace, String function)
throws PulsarAdminException;
/**
* Gets the current stats of a function asynchronously.
*
* @param tenant
* Tenant name
* @param namespace
* Namespace name
* @param function
* Function name
* @return
*/
CompletableFuture getFunctionStatsAsync(String tenant, String namespace, String function);
/**
* Restart function instance.
*
* @param tenant
* Tenant name
* @param namespace
* Namespace name
* @param function
* Function name
*
* @param instanceId
* Function instanceId
*
* @throws PulsarAdminException
* Unexpected error
*/
void restartFunction(String tenant, String namespace, String function, int instanceId) throws PulsarAdminException;
/**
* Restart function instance asynchronously.
*
* @param tenant
* Tenant name
* @param namespace
* Namespace name
* @param function
* Function name
*
* @param instanceId
* Function instanceId
*/
CompletableFuture restartFunctionAsync(String tenant, String namespace, String function, int instanceId);
/**
* Restart all function instances.
*
* @param tenant
* Tenant name
* @param namespace
* Namespace name
* @param function
* Function name
*
* @throws PulsarAdminException
* Unexpected error
*/
void restartFunction(String tenant, String namespace, String function) throws PulsarAdminException;
/**
* Restart all function instances asynchronously.
*
* @param tenant
* Tenant name
* @param namespace
* Namespace name
* @param function
* Function name
*/
CompletableFuture restartFunctionAsync(String tenant, String namespace, String function);
/**
* Stop function instance.
*
* @param tenant
* Tenant name
* @param namespace
* Namespace name
* @param function
* Function name
*
* @param instanceId
* Function instanceId
*
* @throws PulsarAdminException
* Unexpected error
*/
void stopFunction(String tenant, String namespace, String function, int instanceId) throws PulsarAdminException;
/**
* Stop function instance asynchronously.
*
* @param tenant
* Tenant name
* @param namespace
* Namespace name
* @param function
* Function name
*
* @param instanceId
* Function instanceId
*/
CompletableFuture stopFunctionAsync(String tenant, String namespace, String function, int instanceId);
/**
* Start all function instances.
*
* @param tenant
* Tenant name
* @param namespace
* Namespace name
* @param function
* Function name
*
* @throws PulsarAdminException
* Unexpected error
*/
void startFunction(String tenant, String namespace, String function) throws PulsarAdminException;
/**
* Start all function instances asynchronously.
*
* @param tenant
* Tenant name
* @param namespace
* Namespace name
* @param function
* Function name
*/
CompletableFuture startFunctionAsync(String tenant, String namespace, String function);
/**
* Start function instance.
*
* @param tenant
* Tenant name
* @param namespace
* Namespace name
* @param function
* Function name
*
* @param instanceId
* Function instanceId
*
* @throws PulsarAdminException
* Unexpected error
*/
void startFunction(String tenant, String namespace, String function, int instanceId) throws PulsarAdminException;
/**
* Start function instance asynchronously.
*
* @param tenant
* Tenant name
* @param namespace
* Namespace name
* @param function
* Function name
*
* @param instanceId
* Function instanceId
*/
CompletableFuture startFunctionAsync(String tenant, String namespace, String function, int instanceId);
/**
* Stop all function instances.
*
* @param tenant
* Tenant name
* @param namespace
* Namespace name
* @param function
* Function name
*
* @throws PulsarAdminException
* Unexpected error
*/
void stopFunction(String tenant, String namespace, String function) throws PulsarAdminException;
/**
* Stop all function instances asynchronously.
*
* @param tenant
* Tenant name
* @param namespace
* Namespace name
* @param function
* Function name
*/
CompletableFuture stopFunctionAsync(String tenant, String namespace, String function);
/**
* Triggers the function by writing to the input topic.
*
* @param tenant
* Tenant name
* @param namespace
* Namespace name
* @param function
* Function name
* @param triggerValue
* The input that will be written to input topic
* @param triggerFile
* The file which contains the input that will be written to input topic
*
* @throws PulsarAdminException
* Unexpected error
*/
String triggerFunction(
String tenant, String namespace, String function, String topic, String triggerValue, String triggerFile)
throws PulsarAdminException;
/**
* Triggers the function by writing to the input topic asynchronously.
*
* @param tenant
* Tenant name
* @param namespace
* Namespace name
* @param function
* Function name
* @param triggerValue
* The input that will be written to input topic
* @param triggerFile
* The file which contains the input that will be written to input topic
*/
CompletableFuture triggerFunctionAsync(
String tenant, String namespace, String function, String topic, String triggerValue, String triggerFile);
/**
* Upload Data.
*
* @param sourceFile
* dataFile that needs to be uploaded
* @param path
* Path where data should be stored
*
* @throws PulsarAdminException
* Unexpected error
*/
void uploadFunction(String sourceFile, String path) throws PulsarAdminException;
/**
* Upload Data asynchronously.
*
* @param sourceFile
* dataFile that needs to be uploaded
* @param path
* Path where data should be stored
*/
CompletableFuture uploadFunctionAsync(String sourceFile, String path);
/**
* Download Function Code.
*
* @param destinationFile
* file where data should be downloaded to
* @param path
* Path where data is located
*
* @throws PulsarAdminException
* Unexpected error
*/
void downloadFunction(String destinationFile, String path) throws PulsarAdminException;
/**
* Download Function Code.
*
* @param destinationFile
* file where data should be downloaded to
* @param path
* Path where data is located
*/
CompletableFuture downloadFunctionAsync(String destinationFile, String path);
/**
* Download Function Code.
*
* @param destinationFile
* file where data should be downloaded to
* @param tenant
* Tenant name
* @param namespace
* Namespace name
* @param function
* Function name
* @throws PulsarAdminException
*/
void downloadFunction(String destinationFile, String tenant, String namespace, String function)
throws PulsarAdminException;
/**
* Download Function Code asynchronously.
*
* @param destinationFile
* file where data should be downloaded to
* @param tenant
* Tenant name
* @param namespace
* Namespace name
* @param function
* Function name
*/
CompletableFuture downloadFunctionAsync(
String destinationFile, String tenant, String namespace, String function);
/**
* Download Function Code.
*
* @param destinationFile
* file where data should be downloaded to
* @param tenant
* Tenant name
* @param namespace
* Namespace name
* @param function
* Function name
* @param transformFunction
* Whether to download the transform function (for sources and sinks)
* @throws PulsarAdminException
*/
void downloadFunction(String destinationFile, String tenant, String namespace, String function,
boolean transformFunction) throws PulsarAdminException;
/**
* Download Function Code asynchronously.
*
* @param destinationFile
* file where data should be downloaded to
* @param tenant
* Tenant name
* @param namespace
* Namespace name
* @param function
* Function name
* @param transformFunction
* Whether to download the transform function (for sources and sinks)
*/
CompletableFuture downloadFunctionAsync(
String destinationFile, String tenant, String namespace, String function, boolean transformFunction);
/**
* Deprecated in favor of getting sources and sinks for their own APIs.
*
* Fetches a list of supported Pulsar IO connectors currently running in cluster mode
*
* @throws PulsarAdminException
* Unexpected error
*
*/
@Deprecated
List getConnectorsList() throws PulsarAdminException;
/**
* Deprecated in favor of getting sources and sinks for their own APIs.
*
* Fetches a list of supported Pulsar IO sources currently running in cluster mode
*
* @throws PulsarAdminException
* Unexpected error
*
*/
@Deprecated
Set getSources() throws PulsarAdminException;
/**
* Deprecated in favor of getting sources and sinks for their own APIs.
*
* Fetches a list of supported Pulsar IO sinks currently running in cluster mode
*
* @throws PulsarAdminException
* Unexpected error
*
*/
@Deprecated
Set getSinks() throws PulsarAdminException;
/**
* Fetches a list of supported Pulsar Functions currently running in cluster mode.
*
* @throws PulsarAdminException
* Unexpected error
*/
List getBuiltInFunctions() throws PulsarAdminException;
/**
* Fetches a list of supported Pulsar Functions currently running in cluster mode asynchronously.
*/
CompletableFuture> getBuiltInFunctionsAsync();
/**
* Fetch the current state associated with a Pulsar Function.
*
* Response Example:
*
*
* { "value : 12, version : 2"}
*
*
* @param tenant
* Tenant name
* @param namespace
* Namespace name
* @param function
* Function name
* @param key
* Key name of State
*
* @return the function configuration
*
* @throws NotAuthorizedException
* You don't have admin permission to get the configuration of the cluster
* @throws NotFoundException
* Cluster doesn't exist
* @throws PulsarAdminException
* Unexpected error
*/
FunctionState getFunctionState(String tenant, String namespace, String function, String key)
throws PulsarAdminException;
/**
* Fetch the current state associated with a Pulsar Function asynchronously.
*
* Response Example:
*
*
* { "value : 12, version : 2"}
*
*
* @param tenant
* Tenant name
* @param namespace
* Namespace name
* @param function
* Function name
* @param key
* Key name of State
*
* @return the function configuration
*/
CompletableFuture getFunctionStateAsync(
String tenant, String namespace, String function, String key);
/**
* Puts the given state associated with a Pulsar Function.
*
* Response Example:
*
*
* { "value : 12, version : 2"}
*
*
* @param tenant
* Tenant name
* @param namespace
* Namespace name
* @param function
* Function name
* @param state
* FunctionState
**
* @throws NotAuthorizedException
* You don't have admin permission to get the configuration of the cluster
* @throws NotFoundException
* Cluster doesn't exist
* @throws PulsarAdminException
* Unexpected error
*/
void putFunctionState(String tenant, String namespace, String function, FunctionState state)
throws PulsarAdminException;
/**
* Puts the given state associated with a Pulsar Function asynchronously.
*
* Response Example:
*
*
* { "value : 12, version : 2"}
*
*
* @param tenant
* Tenant name
* @param namespace
* Namespace name
* @param function
* Function name
* @param state
* FunctionState
*/
CompletableFuture putFunctionStateAsync(
String tenant, String namespace, String function, FunctionState state);
/**
* Reload the available built-in functions.
*
* @throws PulsarAdminException
* Unexpected error
*/
void reloadBuiltInFunctions() throws PulsarAdminException;
/**
* Reload the available built-in functions.
*/
CompletableFuture reloadBuiltInFunctionsAsync();
}
