Skip to content

Commit a5a27b9

Browse files
Generate serverupdate
1 parent 428416a commit a5a27b9

31 files changed

+9255
-0
lines changed

services/serverupdate/README.md

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
# STACKIT Java SDK for STACKIT Server Update Management API
2+
3+
- API version: 2.0
4+
5+
API endpoints for Server Update Operations on STACKIT Servers.
6+
7+
8+
This package is part of the STACKIT Java SDK. For additional information, please visit the [GitHub repository](https://github.com/stackitcloud/stackit-sdk-java) of the SDK.
9+
10+
## Installation from Maven Central (recommended)
11+
12+
The release artifacts for this SDK submodule are available on [Maven Central](https://central.sonatype.com/artifact/cloud.stackit.sdk/serverupdate).
13+
14+
### Maven users
15+
16+
Add this dependency to your project's POM:
17+
18+
```xml
19+
<dependency>
20+
<groupId>cloud.stackit.sdk</groupId>
21+
<artifactId>serverupdate</artifactId>
22+
<version><SDK_VERSION></version>
23+
<scope>compile</scope>
24+
</dependency>
25+
```
26+
27+
### Gradle users
28+
29+
Add this dependency to your project's build file:
30+
31+
```groovy
32+
repositories {
33+
mavenCentral()
34+
}
35+
36+
dependencies {
37+
implementation "cloud.stackit.sdk:serverupdate:<SDK_VERSION>"
38+
}
39+
```
40+
41+
## Installation from local build
42+
43+
Building the API client library requires:
44+
1. Java SDK (version 11 to 21 should be supported) installed on your system
45+
46+
To install the API client library to your local Maven repository, simply execute:
47+
48+
```shell
49+
./gradlew services:serverupdate:publishToMavenLocal
50+
```
51+
52+
### Maven users
53+
54+
Add this dependency to your project's POM:
55+
56+
```xml
57+
<dependency>
58+
<groupId>cloud.stackit.sdk</groupId>
59+
<artifactId>serverupdate</artifactId>
60+
<version><SDK_VERSION></version>
61+
<scope>compile</scope>
62+
</dependency>
63+
```
64+
65+
### Gradle users
66+
67+
Add this dependency to your project's build file:
68+
69+
```groovy
70+
repositories {
71+
mavenLocal()
72+
}
73+
74+
dependencies {
75+
implementation "cloud.stackit.sdk:serverupdate:<SDK_VERSION>"
76+
}
77+
```
78+
79+
## Getting Started
80+
81+
See the [serverupdate examples](https://github.com/stackitcloud/stackit-sdk-java/tree/main/examples/serverupdate/src/main/java/cloud/stackit/sdk/serverupdate/examples).
82+
83+
## Recommendation
84+
85+
It's recommended to create an instance of `ApiClient` per thread in a multithreaded environment to avoid any potential issues.

services/serverupdate/build.gradle

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
2+
ext {
3+
jakarta_annotation_version = "1.3.5"
4+
}
5+
6+
dependencies {
7+
implementation "com.google.code.findbugs:jsr305:3.0.2"
8+
implementation 'com.squareup.okhttp3:okhttp:4.12.0'
9+
implementation 'com.squareup.okhttp3:logging-interceptor:4.12.0'
10+
implementation 'com.google.code.gson:gson:2.9.1'
11+
implementation 'io.gsonfire:gson-fire:1.9.0'
12+
implementation 'jakarta.ws.rs:jakarta.ws.rs-api:2.1.6'
13+
implementation 'org.openapitools:jackson-databind-nullable:0.2.6'
14+
implementation group: 'org.apache.commons', name: 'commons-lang3', version: '3.17.0'
15+
implementation "jakarta.annotation:jakarta.annotation-api:$jakarta_annotation_version"
16+
testImplementation 'org.junit.jupiter:junit-jupiter-api:5.10.3'
17+
testImplementation 'org.mockito:mockito-core:3.12.4'
18+
testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.10.3'
19+
}
Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
/*
2+
* STACKIT Server Update Management API
3+
* API endpoints for Server Update Operations on STACKIT Servers.
4+
*
5+
* The version of the OpenAPI document: 2.0
6+
* Contact: [email protected]
7+
*
8+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9+
* https://openapi-generator.tech
10+
* Do not edit the class manually.
11+
*/
12+
13+
package cloud.stackit.sdk.serverupdate;
14+
15+
import cloud.stackit.sdk.core.exception.ApiException;
16+
import java.util.List;
17+
import java.util.Map;
18+
19+
/**
20+
* Callback for asynchronous API call.
21+
*
22+
* @param <T> The return type
23+
*/
24+
public interface ApiCallback<T> {
25+
/**
26+
* This is called when the API call fails.
27+
*
28+
* @param e The exception causing the failure
29+
* @param statusCode Status code of the response if available, otherwise it would be 0
30+
* @param responseHeaders Headers of the response if available, otherwise it would be null
31+
*/
32+
void onFailure(ApiException e, int statusCode, Map<String, List<String>> responseHeaders);
33+
34+
/**
35+
* This is called when the API call succeeded.
36+
*
37+
* @param result The result deserialized from response
38+
* @param statusCode Status code of the response
39+
* @param responseHeaders Headers of the response
40+
*/
41+
void onSuccess(T result, int statusCode, Map<String, List<String>> responseHeaders);
42+
43+
/**
44+
* This is called when the API upload processing.
45+
*
46+
* @param bytesWritten bytes Written
47+
* @param contentLength content length of request body
48+
* @param done write end
49+
*/
50+
void onUploadProgress(long bytesWritten, long contentLength, boolean done);
51+
52+
/**
53+
* This is called when the API download processing.
54+
*
55+
* @param bytesRead bytes Read
56+
* @param contentLength content length of the response
57+
* @param done Read end
58+
*/
59+
void onDownloadProgress(long bytesRead, long contentLength, boolean done);
60+
}

0 commit comments

Comments
 (0)