Skip to content

Latest commit

 

History

History
228 lines (186 loc) · 17.3 KB

README.md

File metadata and controls

228 lines (186 loc) · 17.3 KB
Raw

client-java

Requirements

Building the API client library requires Maven to be installed.

Installation

To install the API client library to your local Maven repository, simply execute:

mvn install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn deploy

Refer to the official documentation for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
    <groupId>com.kubedb</groupId>
    <artifactId>client-java</artifactId>
    <version>1.0.0</version>
    <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "com.kubedb:client-java:1.0.0"

Others

At first generate the JAR by executing:

mvn package

Then manually install the following JARs:

  • target/client-java-1.0.0.jar
  • target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

import com.kubedb.client.*;
import com.kubedb.client.auth.*;
import com.kubedb.client.models.*;
import com.kubedb.client.apis.ApisApi;

import java.io.File;
import java.util.*;

public class ApisApiExample {

    public static void main(String[] args) {
        
        ApisApi apiInstance = new ApisApi();
        try {
            V1APIGroupList result = apiInstance.getAPIVersions();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApisApi#getAPIVersions");
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

All URIs are relative to https://localhost

Class Method HTTP request Description
ApisApi getAPIVersions GET /apis/
KubedbComApi getAPIGroup GET /apis/kubedb.com/
KubedbComV1alpha1Api createNamespacedDormantDatabase POST /apis/kubedb.com/v1alpha1/namespaces/{namespace}/dormantdatabases
KubedbComV1alpha1Api createNamespacedElasticsearch POST /apis/kubedb.com/v1alpha1/namespaces/{namespace}/elasticsearches
KubedbComV1alpha1Api createNamespacedMemcached POST /apis/kubedb.com/v1alpha1/namespaces/{namespace}/memcacheds
KubedbComV1alpha1Api createNamespacedMongoDB POST /apis/kubedb.com/v1alpha1/namespaces/{namespace}/mongodbs
KubedbComV1alpha1Api createNamespacedMySQL POST /apis/kubedb.com/v1alpha1/namespaces/{namespace}/mysqls
KubedbComV1alpha1Api createNamespacedPostgres POST /apis/kubedb.com/v1alpha1/namespaces/{namespace}/postgreses
KubedbComV1alpha1Api createNamespacedRedis POST /apis/kubedb.com/v1alpha1/namespaces/{namespace}/redises
KubedbComV1alpha1Api createNamespacedSnapshot POST /apis/kubedb.com/v1alpha1/namespaces/{namespace}/snapshots
KubedbComV1alpha1Api deleteCollectionNamespacedDormantDatabase DELETE /apis/kubedb.com/v1alpha1/namespaces/{namespace}/dormantdatabases
KubedbComV1alpha1Api deleteCollectionNamespacedElasticsearch DELETE /apis/kubedb.com/v1alpha1/namespaces/{namespace}/elasticsearches
KubedbComV1alpha1Api deleteCollectionNamespacedMemcached DELETE /apis/kubedb.com/v1alpha1/namespaces/{namespace}/memcacheds
KubedbComV1alpha1Api deleteCollectionNamespacedMongoDB DELETE /apis/kubedb.com/v1alpha1/namespaces/{namespace}/mongodbs
KubedbComV1alpha1Api deleteCollectionNamespacedMySQL DELETE /apis/kubedb.com/v1alpha1/namespaces/{namespace}/mysqls
KubedbComV1alpha1Api deleteCollectionNamespacedPostgres DELETE /apis/kubedb.com/v1alpha1/namespaces/{namespace}/postgreses
KubedbComV1alpha1Api deleteCollectionNamespacedRedis DELETE /apis/kubedb.com/v1alpha1/namespaces/{namespace}/redises
KubedbComV1alpha1Api deleteCollectionNamespacedSnapshot DELETE /apis/kubedb.com/v1alpha1/namespaces/{namespace}/snapshots
KubedbComV1alpha1Api deleteNamespacedDormantDatabase DELETE /apis/kubedb.com/v1alpha1/namespaces/{namespace}/dormantdatabases/{name}
KubedbComV1alpha1Api deleteNamespacedElasticsearch DELETE /apis/kubedb.com/v1alpha1/namespaces/{namespace}/elasticsearches/{name}
KubedbComV1alpha1Api deleteNamespacedMemcached DELETE /apis/kubedb.com/v1alpha1/namespaces/{namespace}/memcacheds/{name}
KubedbComV1alpha1Api deleteNamespacedMongoDB DELETE /apis/kubedb.com/v1alpha1/namespaces/{namespace}/mongodbs/{name}
KubedbComV1alpha1Api deleteNamespacedMySQL DELETE /apis/kubedb.com/v1alpha1/namespaces/{namespace}/mysqls/{name}
KubedbComV1alpha1Api deleteNamespacedPostgres DELETE /apis/kubedb.com/v1alpha1/namespaces/{namespace}/postgreses/{name}
KubedbComV1alpha1Api deleteNamespacedRedis DELETE /apis/kubedb.com/v1alpha1/namespaces/{namespace}/redises/{name}
KubedbComV1alpha1Api deleteNamespacedSnapshot DELETE /apis/kubedb.com/v1alpha1/namespaces/{namespace}/snapshots/{name}
KubedbComV1alpha1Api getAPIResources GET /apis/kubedb.com/v1alpha1/
KubedbComV1alpha1Api listDormantDatabaseForAllNamespaces GET /apis/kubedb.com/v1alpha1/dormantdatabases
KubedbComV1alpha1Api listElasticsearchForAllNamespaces GET /apis/kubedb.com/v1alpha1/elasticsearches
KubedbComV1alpha1Api listMemcachedForAllNamespaces GET /apis/kubedb.com/v1alpha1/memcacheds
KubedbComV1alpha1Api listMongoDBForAllNamespaces GET /apis/kubedb.com/v1alpha1/mongodbs
KubedbComV1alpha1Api listMySQLForAllNamespaces GET /apis/kubedb.com/v1alpha1/mysqls
KubedbComV1alpha1Api listNamespacedDormantDatabase GET /apis/kubedb.com/v1alpha1/namespaces/{namespace}/dormantdatabases
KubedbComV1alpha1Api listNamespacedElasticsearch GET /apis/kubedb.com/v1alpha1/namespaces/{namespace}/elasticsearches
KubedbComV1alpha1Api listNamespacedMemcached GET /apis/kubedb.com/v1alpha1/namespaces/{namespace}/memcacheds
KubedbComV1alpha1Api listNamespacedMongoDB GET /apis/kubedb.com/v1alpha1/namespaces/{namespace}/mongodbs
KubedbComV1alpha1Api listNamespacedMySQL GET /apis/kubedb.com/v1alpha1/namespaces/{namespace}/mysqls
KubedbComV1alpha1Api listNamespacedPostgres GET /apis/kubedb.com/v1alpha1/namespaces/{namespace}/postgreses
KubedbComV1alpha1Api listNamespacedRedis GET /apis/kubedb.com/v1alpha1/namespaces/{namespace}/redises
KubedbComV1alpha1Api listNamespacedSnapshot GET /apis/kubedb.com/v1alpha1/namespaces/{namespace}/snapshots
KubedbComV1alpha1Api listPostgresForAllNamespaces GET /apis/kubedb.com/v1alpha1/postgreses
KubedbComV1alpha1Api listRedisForAllNamespaces GET /apis/kubedb.com/v1alpha1/redises
KubedbComV1alpha1Api listSnapshotForAllNamespaces GET /apis/kubedb.com/v1alpha1/snapshots
KubedbComV1alpha1Api patchNamespacedDormantDatabase PATCH /apis/kubedb.com/v1alpha1/namespaces/{namespace}/dormantdatabases/{name}
KubedbComV1alpha1Api patchNamespacedElasticsearch PATCH /apis/kubedb.com/v1alpha1/namespaces/{namespace}/elasticsearches/{name}
KubedbComV1alpha1Api patchNamespacedMemcached PATCH /apis/kubedb.com/v1alpha1/namespaces/{namespace}/memcacheds/{name}
KubedbComV1alpha1Api patchNamespacedMongoDB PATCH /apis/kubedb.com/v1alpha1/namespaces/{namespace}/mongodbs/{name}
KubedbComV1alpha1Api patchNamespacedMySQL PATCH /apis/kubedb.com/v1alpha1/namespaces/{namespace}/mysqls/{name}
KubedbComV1alpha1Api patchNamespacedPostgres PATCH /apis/kubedb.com/v1alpha1/namespaces/{namespace}/postgreses/{name}
KubedbComV1alpha1Api patchNamespacedRedis PATCH /apis/kubedb.com/v1alpha1/namespaces/{namespace}/redises/{name}
KubedbComV1alpha1Api patchNamespacedSnapshot PATCH /apis/kubedb.com/v1alpha1/namespaces/{namespace}/snapshots/{name}
KubedbComV1alpha1Api readNamespacedDormantDatabase GET /apis/kubedb.com/v1alpha1/namespaces/{namespace}/dormantdatabases/{name}
KubedbComV1alpha1Api readNamespacedElasticsearch GET /apis/kubedb.com/v1alpha1/namespaces/{namespace}/elasticsearches/{name}
KubedbComV1alpha1Api readNamespacedMemcached GET /apis/kubedb.com/v1alpha1/namespaces/{namespace}/memcacheds/{name}
KubedbComV1alpha1Api readNamespacedMongoDB GET /apis/kubedb.com/v1alpha1/namespaces/{namespace}/mongodbs/{name}
KubedbComV1alpha1Api readNamespacedMySQL GET /apis/kubedb.com/v1alpha1/namespaces/{namespace}/mysqls/{name}
KubedbComV1alpha1Api readNamespacedPostgres GET /apis/kubedb.com/v1alpha1/namespaces/{namespace}/postgreses/{name}
KubedbComV1alpha1Api readNamespacedRedis GET /apis/kubedb.com/v1alpha1/namespaces/{namespace}/redises/{name}
KubedbComV1alpha1Api readNamespacedSnapshot GET /apis/kubedb.com/v1alpha1/namespaces/{namespace}/snapshots/{name}
KubedbComV1alpha1Api replaceNamespacedDormantDatabase PUT /apis/kubedb.com/v1alpha1/namespaces/{namespace}/dormantdatabases/{name}
KubedbComV1alpha1Api replaceNamespacedElasticsearch PUT /apis/kubedb.com/v1alpha1/namespaces/{namespace}/elasticsearches/{name}
KubedbComV1alpha1Api replaceNamespacedMemcached PUT /apis/kubedb.com/v1alpha1/namespaces/{namespace}/memcacheds/{name}
KubedbComV1alpha1Api replaceNamespacedMongoDB PUT /apis/kubedb.com/v1alpha1/namespaces/{namespace}/mongodbs/{name}
KubedbComV1alpha1Api replaceNamespacedMySQL PUT /apis/kubedb.com/v1alpha1/namespaces/{namespace}/mysqls/{name}
KubedbComV1alpha1Api replaceNamespacedPostgres PUT /apis/kubedb.com/v1alpha1/namespaces/{namespace}/postgreses/{name}
KubedbComV1alpha1Api replaceNamespacedRedis PUT /apis/kubedb.com/v1alpha1/namespaces/{namespace}/redises/{name}
KubedbComV1alpha1Api replaceNamespacedSnapshot PUT /apis/kubedb.com/v1alpha1/namespaces/{namespace}/snapshots/{name}

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization. Authentication schemes defined for the API:

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author

[email protected]