@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen") @Beta public class ManagedSystemsApi extends AbstractOpenApiService
apiClient
Constructor and Description |
---|
ManagedSystemsApi(ApiClient apiClient)
Instantiates this API class to invoke operations on the Rule Authoring API for Cloud Foundry based on a given
ApiClient . |
ManagedSystemsApi(HttpDestinationProperties httpDestination)
Instantiates this API class to invoke operations on the Rule Authoring API for Cloud Foundry.
|
Modifier and Type | Method and Description |
---|---|
ManagedSystemResponseObject |
addManagedSystem(ManagedSystemObject body)
Create a system.
|
OpenApiResponse |
deleteManagedSystem(String managedsystemName)
Delete a managed system.
|
ManagedSystemResponseObject |
getManagedSystem(String managedsystemName)
Retrieve the metadata of a managed system
|
List<ManagedSystemResponseObject> |
getManagedSystems()
Retrieve all managed systems
|
ManagedSystemObject |
updateManagedSystem(String managedsystemName)
Update the metadata of a managed system
|
ManagedSystemObject |
updateManagedSystem(String managedsystemName,
ManagedSystemObject body)
Update the metadata of a managed system
|
public ManagedSystemsApi(@Nonnull HttpDestinationProperties httpDestination)
httpDestination
- The destination that API should be used with@Nullable public ManagedSystemResponseObject addManagedSystem(@Nonnull ManagedSystemObject body) throws OpenApiRequestException
Create a system.
Creates a managed system. A system represents a remote system where a rule service can be deployed. It contains information about target system in the form of destination and context path.
201 - Created
401 - Unauthorized. User does not have required authorization to execute this request.
409 - Conflict. A system with name specified in JSON payload already exists.
body
- JSON payload of the system.OpenApiRequestException
- if an error occurs while attempting to invoke the API@Nonnull public OpenApiResponse deleteManagedSystem(@Nonnull String managedsystemName) throws OpenApiRequestException
Delete a managed system.
Deletes a managed system with the specified managed system name.
204 - system deleted successfully from the Rule Repository.
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.
managedsystemName
- name of the system that should be deleted.OpenApiRequestException
- if an error occurs while attempting to invoke the API@Nullable public ManagedSystemResponseObject getManagedSystem(@Nonnull String managedsystemName) throws OpenApiRequestException
Retrieve the metadata of a managed system
Retrieves all the meta data of a managed system with the specified managed system name.
200 - Ok
401 - Unauthorized. User does not have required authorization to execute this request.
managedsystemName
- name of the system.OpenApiRequestException
- if an error occurs while attempting to invoke the API@Nullable public List<ManagedSystemResponseObject> getManagedSystems() throws OpenApiRequestException
Retrieve all managed systems
Retrieves all the managed system. A system represents a remote system where a rule service can be deployed. It contains information about target system in the form of destination and context path.
200 - OK
401 - Unauthorized. User does not have required authorization to execute this request.
OpenApiRequestException
- if an error occurs while attempting to invoke the API@Nullable public ManagedSystemObject updateManagedSystem(@Nonnull String managedsystemName, @Nullable ManagedSystemObject body) throws OpenApiRequestException
Update the metadata of a managed system
Updates the metadata of the managed system with the specified managed system name.
200 - Request to update the system 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 system with updated name specified in JSON payload already exists.
managedsystemName
- (Required) name of the system.body
- (Optional) JSON payload of the system.OpenApiRequestException
- if an error occurs while attempting to invoke the API@Nullable public ManagedSystemObject updateManagedSystem(@Nonnull String managedsystemName) throws OpenApiRequestException
Update the metadata of a managed system
Updates the metadata of the managed system with the specified managed system name.
200 - Request to update the system 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 system with updated name specified in JSON payload already exists.
managedsystemName
- name of the system.OpenApiRequestException
- if an error occurs while attempting to invoke the APICopyright © 2021 SAP SE. All rights reserved.