Skip to content

Commit

Permalink
Add Native Method
Browse files Browse the repository at this point in the history
  • Loading branch information
franklupo committed Oct 25, 2017
1 parent 9737536 commit 9b3d01d
Show file tree
Hide file tree
Showing 3 changed files with 9,265 additions and 1,952 deletions.
36 changes: 22 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
# eve2pve-api-java

ProxmoVE Client API JAVA

[ProxmoxVE Api](https://pve.proxmox.com/pve-docs/api-viewer/)

```
```text
______ __ _ _ ________
/ ____/___ / /____ _________ _____(_)_______ | | / / ____/
/ __/ / __ \/ __/ _ \/ ___/ __ \/ ___/ / ___/ _ \ | | / / __/
Expand All @@ -14,44 +15,51 @@ ProxmoVE Client API JAVA
(Made in Italy)
```

# General
## General

The client is generated from a JSON Api on ProxmoxVE.

# Result
## Result

The result is class **Result** and contain methods:

* **getResponse()** returned from ProxmoxVE (data,errors,...) JSONObject
* **responseInError** (bool) : Contains errors from ProxmoxVE.
* **getStatusCode()** (int) : Status code of the HTTP response.
* **getReasonPhrase()** (string): The reason phrase which typically is sent by servers together with the status code.
* **isSuccessStatusCode()** (bool) : Gets a value that indicates if the HTTP response was successful.
* **getError()** (string) : Get error.

# Main features
## Main features

* Easy to learn
* Method named
* Method no named rest (same parameters)
* getRest
* setRest
* createRest
* deleteRest
* Full method generated from documentation
* Comment any method and parameters
* Parameters indexed eg [n] is structured in array index and value
* Tree structure
* client.getNodes().get("pve1").getQemu().vmlist().getResponse().getJSONArray("data")
* client.getNodes().get("pve1").getQemu().vmlist().getResponse().getJSONArray("data")
* Return data Proxmox VE
* Return result status
* getStatusCode
* getReasonPhrase
* isSuccessStatusCode
* getStatusCode
* getReasonPhrase
* isSuccessStatusCode
* Wait task finish task
* waitForTaskToFinish
* waitForTaskToFinish
* Method directry access
* get
* post
* put
* delete
* get
* set
* create
* delete
* Login return bool if access
* Return Result class more information

# Usage
## Usage

```java

Expand Down
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>com.enterpriseve.proxmoxve.api</groupId>
<artifactId>eve2pve-api-java</artifactId>
<version>1.0.3</version>
<version>1.0.4</version>
<packaging>jar</packaging>
<dependencies>
<dependency>
Expand Down
Loading

0 comments on commit 9b3d01d

Please sign in to comment.