@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen") @Beta public class RuleServicesApi extends AbstractOpenApiService
apiClient
Constructor and Description |
---|
RuleServicesApi(ApiClient apiClient)
Instantiates this API class to invoke operations on the Rule Authoring API for Cloud Foundry based on a given
ApiClient . |
RuleServicesApi(HttpDestinationProperties httpDestination)
Instantiates this API class to invoke operations on the Rule Authoring API for Cloud Foundry.
|
Modifier and Type | Method and Description |
---|---|
RuleService |
addRuleService(String id,
RuleService body)
Create a rule service
|
OpenApiResponse |
deleteRuleService(String id,
String objectId)
Delete a rule service of a project
|
RuleService |
readRevisionedRuleServices(String id,
String revision)
Retrieve all the rule services of the highest semantic version of a project for a given revision.
|
RuleService |
readRevisionedRuleServices(String id,
String revision,
List<String> name)
Retrieve all the rule services of the highest semantic version of a project for a given revision.
|
RuleService |
readRuleService(String id,
String objectId)
Retrieve a rule service of a project
|
List<RuleService> |
readRuleservices(String id)
Retrieve all the rule services of a project
|
List<RuleService> |
readRuleservices(String id,
List<String> name,
Integer $skip,
Integer $top)
Retrieve all the rule services of a project
|
RuleService |
readVersionedRuleServices(String id,
String version)
Retrieve all the rule services of a project given version id
|
RuleService |
readVersionedRuleServices(String id,
String version,
List<String> name)
Retrieve all the rule services of a project given version id
|
RuleService |
updateRuleService(String id,
String objectId)
Update a rule service of a project
|
RuleService |
updateRuleService(String id,
String objectId,
RuleService body)
Update a rule service of a project
|
public RuleServicesApi(@Nonnull HttpDestinationProperties httpDestination)
httpDestination
- The destination that API should be used with@Nullable public RuleService addRuleService(@Nonnull String id, @Nonnull RuleService body) throws OpenApiRequestException
Create a rule service
Creates a rule service for the project with the specified project ID.
201 - Created. The rule service has been added successfully to the given project.
400 - Bad Request. ID of the project in the URL path and in JSON payload does not match.
401 - Unauthorized. User does not have required authorization to execute this request.
409 - Conflict. A rule service with name specified in JSON payload already exists in the given project.
id
- The project ID to which the rule service should be added. The ID is 32 characters long.body
- JSON payload of the rule service.OpenApiRequestException
- if an error occurs while attempting to invoke the API@Nonnull public OpenApiResponse deleteRuleService(@Nonnull String id, @Nonnull String objectId) throws OpenApiRequestException
Delete a rule service of a project
Deletes a rule service with the specified rule service ID of the project with the specified project ID.
204 - Rule service deleted successfully from the given project.
401 - Unauthorized. User does not have required authorization to execute this request.
404 - Object not found. The entity you are trying to delete does not exist.
id
- ID of the project from which the rule service should be deleted. The ID is 32 characters long.objectId
- ID of the data object. The ID is 32 characters long.OpenApiRequestException
- if an error occurs while attempting to invoke the API@Nullable public RuleService readRevisionedRuleServices(@Nonnull String id, @Nonnull String revision, @Nullable List<String> name) throws OpenApiRequestException
Retrieve all the rule services of the highest semantic version of a project for a given revision.
Retrieves all the rule services of the highest semantic version of a project for a given revision.
200 - Request for reading revisioned rule services of a given project is completed.
401 - Unauthorized. User does not have required authorization to execute this request.
404 - Project not found. The project you are trying to read does not exist.
id
- (Required) ID of the project. The ID is 32 characters long.revision
- (Required) Revision of the project.name
- (Optional The name of the rule service. Retrieves the rule service with the specified name. You can
provide multiple names to retrieve multiple rule services.OpenApiRequestException
- if an error occurs while attempting to invoke the API@Nullable public RuleService readRevisionedRuleServices(@Nonnull String id, @Nonnull String revision) throws OpenApiRequestException
Retrieve all the rule services of the highest semantic version of a project for a given revision.
Retrieves all the rule services of the highest semantic version of a project for a given revision.
200 - Request for reading revisioned rule services of a given project is completed.
401 - Unauthorized. User does not have required authorization to execute this request.
404 - Project not found. The project you are trying to read does not exist.
id
- ID of the project. The ID is 32 characters long.revision
- Revision of the project.OpenApiRequestException
- if an error occurs while attempting to invoke the API@Nullable public RuleService readRuleService(@Nonnull String id, @Nonnull String objectId) throws OpenApiRequestException
Retrieve a rule service of a project
Retrieves a rule service with the specified rule service ID of the project with the specified project ID.
200 - Request for reading the rule service belonging to the given project is completed successfully.
401 - Unauthorized. User does not have required authorization to execute this request.
404 - Project not found. The project you are trying to read does not exist.
id
- ID of the project. The ID is 32 characters long.objectId
- ID of the rule service. The ID is 32 characters long.OpenApiRequestException
- if an error occurs while attempting to invoke the API@Nullable public List<RuleService> readRuleservices(@Nonnull String id, @Nullable List<String> name, @Nullable Integer $skip, @Nullable Integer $top) throws OpenApiRequestException
Retrieve all the rule services of a project
Retrieves all the rule services of a project with specified project ID.
200 - Request for reading the rule services belonging to the given project is completed successfully.
401 - Unauthorized. User does not have required authorization to execute this request.
404 - Project not found. The project you are trying to read does not exist.
id
- (Required) ID of the project. The ID is 32 characters long.name
- (Optional The name of the rule service. Retrieves the rule service with the specified name. You can
provide multiple names to retrieve multiple rule services.$skip
- (Optional, default to 0) The number of rule services you want to skip from the beginning while
fetching them. If $skip is not specified, no rule services are skipped. The records are implicitly
sorted by the rule service name in ascending order. You can use this parameter only once. For
example: To fetch the rule service starting from 101 until 150, set $skip=100 and
$top=50. Also, refer to the $top parameter.$top
- (Optional, default to 100) The number of rule services you want to fetch from the beginning. If not
specified, 100 rule services are returned. The records are implicitly sorted by the rule service name
in ascending order. You can use this parameter only once. For example: To fetch the rule
services starting from 101 until 150, set $skip=100 and $top=50. Also, refer to the $skip
parameter.OpenApiRequestException
- if an error occurs while attempting to invoke the API@Nullable public List<RuleService> readRuleservices(@Nonnull String id) throws OpenApiRequestException
Retrieve all the rule services of a project
Retrieves all the rule services of a project with specified project ID.
200 - Request for reading the rule services belonging to the given project is completed successfully.
401 - Unauthorized. User does not have required authorization to execute this request.
404 - Project not found. The project you are trying to read does not exist.
id
- ID of the project. The ID is 32 characters long.OpenApiRequestException
- if an error occurs while attempting to invoke the API@Nullable public RuleService readVersionedRuleServices(@Nonnull String id, @Nonnull String version, @Nullable List<String> name) throws OpenApiRequestException
Retrieve all the rule services of a project given version id
Retrieves all the rule services given version id with the specified project ID.
200 - Request for reading versioned rule services belonging to a given project is completed successfully.
401 - Unauthorized. User does not have required authorization to execute this request.
404 - Project not found. The project you are trying to read does not exist.
id
- (Required) ID of the project. The ID is 32 characters long.version
- (Required) Version ID of the project. The ID is 18 digits long.name
- (Optional The name of the rule service. Retrieves the rule service with the specified name. You can
provide multiple names to retrieve multiple rule services.OpenApiRequestException
- if an error occurs while attempting to invoke the API@Nullable public RuleService readVersionedRuleServices(@Nonnull String id, @Nonnull String version) throws OpenApiRequestException
Retrieve all the rule services of a project given version id
Retrieves all the rule services given version id with the specified project ID.
200 - Request for reading versioned rule services belonging to a given project is completed successfully.
401 - Unauthorized. User does not have required authorization to execute this request.
404 - Project not found. The project you are trying to read does not exist.
id
- ID of the project. The ID is 32 characters long.version
- Version ID of the project. The ID is 18 digits long.OpenApiRequestException
- if an error occurs while attempting to invoke the API@Nullable public RuleService updateRuleService(@Nonnull String id, @Nonnull String objectId, @Nullable RuleService body) throws OpenApiRequestException
Update a rule service of a project
Updates a rule service with the specified rule service ID of the project with the specified project ID.
200 - Request to update the rule service belonging to a given project is completed successfully.
400 - Bad Request. ID of the project or of the rule service provided in the URL path and in JSON payload do not match.
401 - Unauthorized. User does not have required authorization to execute this request.
404 - Object not found. The entity you are trying to update does not exist.
409 - Conflict. A rule service with name specified in JSON payload already exists in the given project.
id
- (Required) ID of the project. The ID is 32 characters long.objectId
- (Required) ID of the rule service. The ID is 32 characters long.body
- (Optional) JSON payload of the rule service.OpenApiRequestException
- if an error occurs while attempting to invoke the API@Nullable public RuleService updateRuleService(@Nonnull String id, @Nonnull String objectId) throws OpenApiRequestException
Update a rule service of a project
Updates a rule service with the specified rule service ID of the project with the specified project ID.
200 - Request to update the rule service belonging to a given project is completed successfully.
400 - Bad Request. ID of the project or of the rule service provided in the URL path and in JSON payload do not match.
401 - Unauthorized. User does not have required authorization to execute this request.
404 - Object not found. The entity you are trying to update does not exist.
409 - Conflict. A rule service with name specified in JSON payload already exists in the given project.
id
- ID of the project. The ID is 32 characters long.objectId
- ID of the rule service. The ID is 32 characters long.OpenApiRequestException
- if an error occurs while attempting to invoke the APICopyright © 2021 SAP SE. All rights reserved.