@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen") @Beta public class DeployUndeployRuleServiceApi extends AbstractOpenApiService
apiClient
Constructor and Description |
---|
DeployUndeployRuleServiceApi(ApiClient apiClient)
Instantiates this API class to invoke operations on the Rule Execution API for Cloud Foundry based on a given
ApiClient . |
DeployUndeployRuleServiceApi(HttpDestinationProperties httpDestination)
Instantiates this API class to invoke operations on the Rule Execution API for Cloud Foundry.
|
public DeployUndeployRuleServiceApi(@Nonnull HttpDestinationProperties httpDestination)
httpDestination
- The destination that API should be used with@Nullable public RuleServiceVersionDefinitionResult deployRuleServiceVersion(@Nonnull RuleServiceVersionDefinitionInput body) throws OpenApiRequestException
Deploy a version of a rule service
Deploys a version of a rule service to the business rules runtime. Rule service versions are read only and redeployment of the same version is not possible.
201 - Deployment of the rule service succeeded.
400 - Deployment of the rule service failed.
404 - Object not found
409 - Conflict
body
- JSON payload of rule service details to be deployedOpenApiRequestException
- if an error occurs while attempting to invoke the API@Nullable public WorkingsetRuleServiceDefinitionResult deployWorkingsetRuleService(@Nonnull WorkingsetRuleServiceDefinitionInput body) throws OpenApiRequestException
Deploy a working set rule service.
Deploys a working set rule service to the business rules runtime. The rule service should be in active state to deploy it. Redeployment is also supported.
201 - Deployment of the rule service succeeded.
400 - Deployment of the rule service failed.
500 - An exception occurred during deployment.
body
- JSON payload of rule service details to be deployedOpenApiRequestException
- if an error occurs while attempting to invoke the API@Nullable public RuleServiceVersionDefinitionResult readRuleServiceVersion(@Nonnull String ruleServiceId, @Nonnull String ruleServiceVersion) throws OpenApiRequestException
Retrive a deployed rule service version
Retrives the metadata of a deployed rule service with the specified rule service ID and rule service version from business rules runtime.
200 - Request for reading a deployed rule services of given version is completed successfully.
401 - Unauthorized. User does not have required authorization to execute this request.
404 - Object not found. The entity you are trying to read does not exist.
ruleServiceId
- Id of the RuleServiceruleServiceVersion
- Version of the RuleServiceOpenApiRequestException
- if an error occurs while attempting to invoke the API@Nullable public List<RuleServiceVersionDefinitionResult> readRuleServiceVersions(@Nonnull String ruleServiceId) throws OpenApiRequestException
Retrive all versions of a deployed rule service
Retrives the list of all deployed rule service versions' metadata for the specified rule service ID from business rules runtime.
200 - Request for reading the rule service versions deployed is completed successfully.
401 - Unauthorized. User does not have required authorization to execute this request.
404 - Object not found. The entity you are trying to read does not exist.
ruleServiceId
- Id of the RuleServiceOpenApiRequestException
- if an error occurs while attempting to invoke the API@Nullable public WorkingsetRuleServiceDefinitionResult readWorkingsetRuleService(@Nonnull String ruleServiceId) throws OpenApiRequestException
Retrive a deployed working set rule service
Retrives the metadata of a deployed working set rule service with the specified rule service ID from the business rules runtime.
200 - Request for reading a deployed rule services from working set is completed successfully.
401 - Unauthorized. User does not have required authorization to execute this request.
404 - Object not found. The entity you are trying to read does not exist.
ruleServiceId
- Id of the RuleServiceOpenApiRequestException
- if an error occurs while attempting to invoke the API@Nullable public List<WorkingsetRuleServiceDefinitionResult> readWorkingsetRuleServices() throws OpenApiRequestException
Retrive all the deployed working set rule services.
Retrives the metadata of all the deployed working set rule services from business rules runtime.
200 - Request for reading the deployed rule services from working set across project is completed successfully.
401 - Unauthorized. User does not have required authorization to execute this request.
OpenApiRequestException
- if an error occurs while attempting to invoke the API@Nonnull public OpenApiResponse undeployRuleServiceVersion(@Nonnull String ruleServiceId, @Nonnull String ruleServiceVersion) throws OpenApiRequestException
Undeploy a version of a rule service
Undeploys the rule service with the specified rule service ID and rule service version from the business rules runtime.
204 - Undeployment of the rule service succeeded.
404 - Object not found. The entity you are trying to Undeploy does not exist.
ruleServiceId
- Id of the RuleServiceruleServiceVersion
- Version of the RuleServiceOpenApiRequestException
- if an error occurs while attempting to invoke the API@Nonnull public OpenApiResponse undeployWorkingsetRuleService(@Nonnull String ruleServiceId) throws OpenApiRequestException
Undeploy the working set rule service
Undeploys the working set rule service with specified rule service ID from the business rules runtime.
204 - Undeployment of the rule service succeeded.
400 - Undeployment of the rule service failed.
404 - Object not found. The entity you are trying to Undeploy does not exist.
ruleServiceId
- Id of the RuleServiceOpenApiRequestException
- if an error occurs while attempting to invoke the APICopyright © 2021 SAP SE. All rights reserved.