@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen") @Beta public class RulesetsApi extends AbstractOpenApiService
apiClient
Constructor and Description |
---|
RulesetsApi(ApiClient apiClient)
Instantiates this API class to invoke operations on the Rule Authoring API for Cloud Foundry based on a given
ApiClient . |
RulesetsApi(HttpDestinationProperties httpDestination)
Instantiates this API class to invoke operations on the Rule Authoring API for Cloud Foundry.
|
Modifier and Type | Method and Description |
---|---|
Ruleset |
addRuleSet(String id,
Ruleset body)
Create a ruleset
|
OpenApiResponse |
deleteRuleSet(String id,
String objectId)
Delete a ruleset of a project
|
Ruleset |
readRevisionedRuleset(String id,
String revision)
Retrieve all the rulesets of the highest semantic version of a project for a given revision.
|
Ruleset |
readRevisionedRuleset(String id,
String revision,
List<String> name)
Retrieve all the rulesets of the highest semantic version of a project for a given revision.
|
Ruleset |
readRuleSet(String id,
String objectId)
Retrieve a ruleset of a project
|
List<Ruleset> |
readRulesets(String id)
Retrieve all the rulesets of a project
|
List<Ruleset> |
readRulesets(String id,
List<String> name,
Integer $skip,
Integer $top)
Retrieve all the rulesets of a project
|
Ruleset |
readVersionedRuleset(String id,
String version)
Retrieve all the rulesets of a project given version id
|
Ruleset |
readVersionedRuleset(String id,
String version,
List<String> name)
Retrieve all the rulesets of a project given version id
|
Ruleset |
updateRuleset(String id,
String objectId)
Updates a ruleset of a project
|
Ruleset |
updateRuleset(String id,
String objectId,
Ruleset body)
Updates a ruleset of a project
|
public RulesetsApi(@Nonnull HttpDestinationProperties httpDestination)
httpDestination
- The destination that API should be used with@Nullable public Ruleset addRuleSet(@Nonnull String id, @Nonnull Ruleset body) throws OpenApiRequestException
Create a ruleset
Creates a ruleset for the project with the specified project ID.
201 - Created. The ruleset 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 ruleset with name specified in JSON payload already exists in the given project.
id
- ID of the project to which the ruleset should be added. The ID is 32 characters long.body
- JSON payload of the ruleset.OpenApiRequestException
- if an error occurs while attempting to invoke the API@Nonnull public OpenApiResponse deleteRuleSet(@Nonnull String id, @Nonnull String objectId) throws OpenApiRequestException
Delete a ruleset of a project
Deletes a ruleset with the specified rule set ID of the project with the specified project ID.
204 - Ruleset 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 ruleset should be deleted. The ID is 32 characters long.objectId
- ID of the ruleset. The ID is 32 characters long.OpenApiRequestException
- if an error occurs while attempting to invoke the API@Nullable public Ruleset readRevisionedRuleset(@Nonnull String id, @Nonnull String revision, @Nullable List<String> name) throws OpenApiRequestException
Retrieve all the rulesets of the highest semantic version of a project for a given revision.
Retrieves all the rulesets of the highest semantic version of a project for a given revision.
200 - Request for reading revisioned rulesets 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 ruleset. Retrieves the ruleset with the specified name. You can provide
multiple names to retrieve multiple rulesets.OpenApiRequestException
- if an error occurs while attempting to invoke the API@Nullable public Ruleset readRevisionedRuleset(@Nonnull String id, @Nonnull String revision) throws OpenApiRequestException
Retrieve all the rulesets of the highest semantic version of a project for a given revision.
Retrieves all the rulesets of the highest semantic version of a project for a given revision.
200 - Request for reading revisioned rulesets 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 Ruleset readRuleSet(@Nonnull String id, @Nonnull String objectId) throws OpenApiRequestException
Retrieve a ruleset of a project
Retrieves a ruleset with the specified rule set ID of the project with the specified project ID.
200 - Request for reading the ruleset belonging to a given project 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.
id
- ID of the project. The ID is 32 characters long.objectId
- ID of the ruleset. The ID is 32 characters long.OpenApiRequestException
- if an error occurs while attempting to invoke the API@Nullable public List<Ruleset> readRulesets(@Nonnull String id, @Nullable List<String> name, @Nullable Integer $skip, @Nullable Integer $top) throws OpenApiRequestException
Retrieve all the rulesets of a project
Retrieves all the rulesets of the project with the specified project ID.
200 - Request for reading the rulesets 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.name
- (Optional The name of the ruleset. Retrieves the rulesets with the specified name. You can provide
multiple names to retrieve multiple rulesets.$skip
- (Optional, default to 0) The number of rulesets you want to skip from the beginning while fetching
them. If $skip is not specified, no rulesets are skipped. The records are implicitly sorted by the
ruleset name in ascending order. You can use this parameter only once. For example: To fetch
the rulesets 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 rulesets you want to fetch from the beginning. If not
specified, 100 rulesets are returned. The records are implicitly sorted by the ruleset name in
ascending order. You can use this parameter only once. For example: To fetch the rulesets
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<Ruleset> readRulesets(@Nonnull String id) throws OpenApiRequestException
Retrieve all the rulesets of a project
Retrieves all the rulesets of the project with the specified project ID.
200 - Request for reading the rulesets 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.OpenApiRequestException
- if an error occurs while attempting to invoke the API@Nullable public Ruleset readVersionedRuleset(@Nonnull String id, @Nonnull String version, @Nullable List<String> name) throws OpenApiRequestException
Retrieve all the rulesets of a project given version id
Retrieves all the rulesets given version id with the specified project ID.
200 - Request for reading versioned rulesets 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 ruleset. Retrieves the ruleset with the specified name. You can provide
multiple names to retrieve multiple rulesets.OpenApiRequestException
- if an error occurs while attempting to invoke the API@Nullable public Ruleset readVersionedRuleset(@Nonnull String id, @Nonnull String version) throws OpenApiRequestException
Retrieve all the rulesets of a project given version id
Retrieves all the rulesets given version id with the specified project ID.
200 - Request for reading versioned rulesets 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 Ruleset updateRuleset(@Nonnull String id, @Nonnull String objectId, @Nullable Ruleset body) throws OpenApiRequestException
Updates a ruleset of a project
Updates a ruleset with the specified rule set ID of the project with the specified project ID.
200 - Request to update the ruleset belonging to a given project 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 update does not exist.
409 - Conflict. A ruleset 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 ruleset. The ID is 32 characters long.body
- (Optional) JSON payload of the ruleset.OpenApiRequestException
- if an error occurs while attempting to invoke the API@Nullable public Ruleset updateRuleset(@Nonnull String id, @Nonnull String objectId) throws OpenApiRequestException
Updates a ruleset of a project
Updates a ruleset with the specified rule set ID of the project with the specified project ID.
200 - Request to update the ruleset belonging to a given project 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 update does not exist.
409 - Conflict. A ruleset 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 ruleset. The ID is 32 characters long.OpenApiRequestException
- if an error occurs while attempting to invoke the APICopyright © 2021 SAP SE. All rights reserved.