Package step.functions.packages.client
Interface FunctionPackageClient
- All Superinterfaces:
AutoCloseable
,Closeable
- All Known Implementing Classes:
RemoteFunctionPackageClientImpl
-
Method Summary
Modifier and TypeMethodDescriptionvoid
deleteKeywordPackage
(String packageId) Delete an existing Keyword packagelookupPackageByResourceName
(String resourceName) Deprecated.This service has been removed.newKeywordPackage
(File packageLibraryFile, File packageFile, Map<String, String> packageAttributes, String trackingField) Creates a new Keyword packagenewKeywordPackageWithLibReference
(LibFileReference packageLib, File packageFile, Map<String, String> packageAttributes, String trackingField) Creates a new Keyword packageupdateKeywordPackageById
(FunctionPackage previousPackage, File packageLibraryFile, File packageFile, Map<String, String> packageAttributes, String trackingField) Update an existing Keyword package identified by its ObjectIdupdateKeywordPackageWithLibReference
(FunctionPackage previousPackage, LibFileReference packageLib, File packageFile, Map<String, String> packageAttributes, String trackingField) Update an existing Keyword package identified by its ObjectIdupdateResourceBasedKeywordPackage
(File packageLibraryFile, File packageFile, Map<String, String> packageAttributes) Deprecated.This service has been removed.
-
Method Details
-
newKeywordPackage
FunctionPackage newKeywordPackage(File packageLibraryFile, File packageFile, Map<String, String> packageAttributes, String trackingField) throws IOExceptionCreates a new Keyword package- Parameters:
packageLibraryFile
- a ZippackageFile
- the Jar/DLL file containing the Keyword definitions. The file will be uploaded to the ControllerpackageAttributes
- the attributes of the Keyword (ex: version, app, etc)trackingField
- (optional) the attribute to determine the uniqueness of the function package- Returns:
- the newly created
FunctionPackage
- Throws:
IOException
- in case of any error
-
updateKeywordPackageById
FunctionPackage updateKeywordPackageById(FunctionPackage previousPackage, File packageLibraryFile, File packageFile, Map<String, String> packageAttributes, String trackingField) throws IOExceptionUpdate an existing Keyword package identified by its ObjectId- Parameters:
previousPackage
- the older version of theFunctionPackage
obtained at creation time (i.e returned by newKeywordPackage)packageLibraryFile
- a ZippackageFile
- the Jar/DLL file containing the Keyword definitions. The file will be uploaded to the ControllerpackageAttributes
- (optional) the attributes the keyword package can be identified with, by default the resource name will be usedtrackingField
- (optional) the attribute to determine the uniqueness of the function package- Returns:
- the updated
FunctionPackage
- Throws:
IOException
- in case of any error
-
newKeywordPackageWithLibReference
FunctionPackage newKeywordPackageWithLibReference(LibFileReference packageLib, File packageFile, Map<String, String> packageAttributes, String trackingField) throws IOExceptionCreates a new Keyword package- Parameters:
packageLib
- the zip with additional libraries (the binary file to be loaded to the Controller or id of the already uploaded resource).packageFile
- the Jar/DLL file containing the Keyword definitions. The file will be uploaded to the ControllerpackageAttributes
- the attributes of the Keyword (ex: version, app, etc)trackingField
- (optional) the attribute to determine the uniqueness of the function package- Returns:
- the newly created
FunctionPackage
- Throws:
IOException
- in case of any error
-
updateKeywordPackageWithLibReference
FunctionPackage updateKeywordPackageWithLibReference(FunctionPackage previousPackage, LibFileReference packageLib, File packageFile, Map<String, String> packageAttributes, String trackingField) throws IOExceptionUpdate an existing Keyword package identified by its ObjectId- Parameters:
previousPackage
- the older version of theFunctionPackage
obtained at creation time (i.e returned by newKeywordPackage)packageLib
- the zip with additional libraries (the binary file to be loaded to the Controller or id of the already uploaded resource).packageFile
- the Jar/DLL file containing the Keyword definitions. The file will be uploaded to the ControllerpackageAttributes
- (optional) the attributes the keyword package can be identified with, by default the resource name will be usedtrackingField
- (optional) the attribute to determine the uniqueness of the function package- Returns:
- the updated
FunctionPackage
- Throws:
IOException
- in case of any error
-
deleteKeywordPackage
Delete an existing Keyword package- Parameters:
packageId
- the ID of the package
-
updateResourceBasedKeywordPackage
FunctionPackage updateResourceBasedKeywordPackage(File packageLibraryFile, File packageFile, Map<String, String> packageAttributes) throws IOExceptionDeprecated.This service has been removed. Lookup by resourceName isn't supported anymore. Use updateKeywordPackageById instead.Update an existing Keyword package with a new version of the resource(s), the package is implicitly managed via resource name Warning: if multiple resources are created with the same name, or if multiple keyword packages reference the same resource, only the first match will be updated.- Parameters:
packageLibraryFile
- a ZippackageFile
- the Jar/DLL file containing the Keyword definitions. The file will be uploaded to the ControllerpackageAttributes
- (optional) the attributes the keyword package can be identified with, by default the resource name will be used- Returns:
- the updated
FunctionPackage
- Throws:
IOException
- in case of any error
-
lookupPackageByResourceName
Deprecated.This service has been removed. Lookup by resourceName isn't supported anymore. Use addOrUpdateKeywordPackage instead.Retrieve aFunctionPackage
object based on the resourceName associated with it. Warning: if multiple resources are created with the same name, or if multiple keyword packages reference the same resource, only the first match will be updated.- Parameters:
resourceName
- the name of the Resource that the searchedFunctionPackage
relies on- Returns:
- the corresponding
FunctionPackage
, if any match occurred - Throws:
IOException
- in case of any error
-