client-java

June 23, 2018 ยท View on GitHub

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

ClassMethodHTTP requestDescription
ApisApigetAPIVersionsGET /apis/
KubedbComApigetAPIGroupGET /apis/kubedb.com/
KubedbComV1alpha1ApicreateNamespacedDormantDatabasePOST /apis/kubedb.com/v1alpha1/namespaces/{namespace}/dormantdatabases
KubedbComV1alpha1ApicreateNamespacedElasticsearchPOST /apis/kubedb.com/v1alpha1/namespaces/{namespace}/elasticsearches
KubedbComV1alpha1ApicreateNamespacedMemcachedPOST /apis/kubedb.com/v1alpha1/namespaces/{namespace}/memcacheds
KubedbComV1alpha1ApicreateNamespacedMongoDBPOST /apis/kubedb.com/v1alpha1/namespaces/{namespace}/mongodbs
KubedbComV1alpha1ApicreateNamespacedMySQLPOST /apis/kubedb.com/v1alpha1/namespaces/{namespace}/mysqls
KubedbComV1alpha1ApicreateNamespacedPostgresPOST /apis/kubedb.com/v1alpha1/namespaces/{namespace}/postgreses
KubedbComV1alpha1ApicreateNamespacedRedisPOST /apis/kubedb.com/v1alpha1/namespaces/{namespace}/redises
KubedbComV1alpha1ApicreateNamespacedSnapshotPOST /apis/kubedb.com/v1alpha1/namespaces/{namespace}/snapshots
KubedbComV1alpha1ApideleteCollectionNamespacedDormantDatabaseDELETE /apis/kubedb.com/v1alpha1/namespaces/{namespace}/dormantdatabases
KubedbComV1alpha1ApideleteCollectionNamespacedElasticsearchDELETE /apis/kubedb.com/v1alpha1/namespaces/{namespace}/elasticsearches
KubedbComV1alpha1ApideleteCollectionNamespacedMemcachedDELETE /apis/kubedb.com/v1alpha1/namespaces/{namespace}/memcacheds
KubedbComV1alpha1ApideleteCollectionNamespacedMongoDBDELETE /apis/kubedb.com/v1alpha1/namespaces/{namespace}/mongodbs
KubedbComV1alpha1ApideleteCollectionNamespacedMySQLDELETE /apis/kubedb.com/v1alpha1/namespaces/{namespace}/mysqls
KubedbComV1alpha1ApideleteCollectionNamespacedPostgresDELETE /apis/kubedb.com/v1alpha1/namespaces/{namespace}/postgreses
KubedbComV1alpha1ApideleteCollectionNamespacedRedisDELETE /apis/kubedb.com/v1alpha1/namespaces/{namespace}/redises
KubedbComV1alpha1ApideleteCollectionNamespacedSnapshotDELETE /apis/kubedb.com/v1alpha1/namespaces/{namespace}/snapshots
KubedbComV1alpha1ApideleteNamespacedDormantDatabaseDELETE /apis/kubedb.com/v1alpha1/namespaces/{namespace}/dormantdatabases/{name}
KubedbComV1alpha1ApideleteNamespacedElasticsearchDELETE /apis/kubedb.com/v1alpha1/namespaces/{namespace}/elasticsearches/{name}
KubedbComV1alpha1ApideleteNamespacedMemcachedDELETE /apis/kubedb.com/v1alpha1/namespaces/{namespace}/memcacheds/{name}
KubedbComV1alpha1ApideleteNamespacedMongoDBDELETE /apis/kubedb.com/v1alpha1/namespaces/{namespace}/mongodbs/{name}
KubedbComV1alpha1ApideleteNamespacedMySQLDELETE /apis/kubedb.com/v1alpha1/namespaces/{namespace}/mysqls/{name}
KubedbComV1alpha1ApideleteNamespacedPostgresDELETE /apis/kubedb.com/v1alpha1/namespaces/{namespace}/postgreses/{name}
KubedbComV1alpha1ApideleteNamespacedRedisDELETE /apis/kubedb.com/v1alpha1/namespaces/{namespace}/redises/{name}
KubedbComV1alpha1ApideleteNamespacedSnapshotDELETE /apis/kubedb.com/v1alpha1/namespaces/{namespace}/snapshots/{name}
KubedbComV1alpha1ApigetAPIResourcesGET /apis/kubedb.com/v1alpha1/
KubedbComV1alpha1ApilistDormantDatabaseForAllNamespacesGET /apis/kubedb.com/v1alpha1/dormantdatabases
KubedbComV1alpha1ApilistElasticsearchForAllNamespacesGET /apis/kubedb.com/v1alpha1/elasticsearches
KubedbComV1alpha1ApilistMemcachedForAllNamespacesGET /apis/kubedb.com/v1alpha1/memcacheds
KubedbComV1alpha1ApilistMongoDBForAllNamespacesGET /apis/kubedb.com/v1alpha1/mongodbs
KubedbComV1alpha1ApilistMySQLForAllNamespacesGET /apis/kubedb.com/v1alpha1/mysqls
KubedbComV1alpha1ApilistNamespacedDormantDatabaseGET /apis/kubedb.com/v1alpha1/namespaces/{namespace}/dormantdatabases
KubedbComV1alpha1ApilistNamespacedElasticsearchGET /apis/kubedb.com/v1alpha1/namespaces/{namespace}/elasticsearches
KubedbComV1alpha1ApilistNamespacedMemcachedGET /apis/kubedb.com/v1alpha1/namespaces/{namespace}/memcacheds
KubedbComV1alpha1ApilistNamespacedMongoDBGET /apis/kubedb.com/v1alpha1/namespaces/{namespace}/mongodbs
KubedbComV1alpha1ApilistNamespacedMySQLGET /apis/kubedb.com/v1alpha1/namespaces/{namespace}/mysqls
KubedbComV1alpha1ApilistNamespacedPostgresGET /apis/kubedb.com/v1alpha1/namespaces/{namespace}/postgreses
KubedbComV1alpha1ApilistNamespacedRedisGET /apis/kubedb.com/v1alpha1/namespaces/{namespace}/redises
KubedbComV1alpha1ApilistNamespacedSnapshotGET /apis/kubedb.com/v1alpha1/namespaces/{namespace}/snapshots
KubedbComV1alpha1ApilistPostgresForAllNamespacesGET /apis/kubedb.com/v1alpha1/postgreses
KubedbComV1alpha1ApilistRedisForAllNamespacesGET /apis/kubedb.com/v1alpha1/redises
KubedbComV1alpha1ApilistSnapshotForAllNamespacesGET /apis/kubedb.com/v1alpha1/snapshots
KubedbComV1alpha1ApipatchNamespacedDormantDatabasePATCH /apis/kubedb.com/v1alpha1/namespaces/{namespace}/dormantdatabases/{name}
KubedbComV1alpha1ApipatchNamespacedElasticsearchPATCH /apis/kubedb.com/v1alpha1/namespaces/{namespace}/elasticsearches/{name}
KubedbComV1alpha1ApipatchNamespacedMemcachedPATCH /apis/kubedb.com/v1alpha1/namespaces/{namespace}/memcacheds/{name}
KubedbComV1alpha1ApipatchNamespacedMongoDBPATCH /apis/kubedb.com/v1alpha1/namespaces/{namespace}/mongodbs/{name}
KubedbComV1alpha1ApipatchNamespacedMySQLPATCH /apis/kubedb.com/v1alpha1/namespaces/{namespace}/mysqls/{name}
KubedbComV1alpha1ApipatchNamespacedPostgresPATCH /apis/kubedb.com/v1alpha1/namespaces/{namespace}/postgreses/{name}
KubedbComV1alpha1ApipatchNamespacedRedisPATCH /apis/kubedb.com/v1alpha1/namespaces/{namespace}/redises/{name}
KubedbComV1alpha1ApipatchNamespacedSnapshotPATCH /apis/kubedb.com/v1alpha1/namespaces/{namespace}/snapshots/{name}
KubedbComV1alpha1ApireadNamespacedDormantDatabaseGET /apis/kubedb.com/v1alpha1/namespaces/{namespace}/dormantdatabases/{name}
KubedbComV1alpha1ApireadNamespacedElasticsearchGET /apis/kubedb.com/v1alpha1/namespaces/{namespace}/elasticsearches/{name}
KubedbComV1alpha1ApireadNamespacedMemcachedGET /apis/kubedb.com/v1alpha1/namespaces/{namespace}/memcacheds/{name}
KubedbComV1alpha1ApireadNamespacedMongoDBGET /apis/kubedb.com/v1alpha1/namespaces/{namespace}/mongodbs/{name}
KubedbComV1alpha1ApireadNamespacedMySQLGET /apis/kubedb.com/v1alpha1/namespaces/{namespace}/mysqls/{name}
KubedbComV1alpha1ApireadNamespacedPostgresGET /apis/kubedb.com/v1alpha1/namespaces/{namespace}/postgreses/{name}
KubedbComV1alpha1ApireadNamespacedRedisGET /apis/kubedb.com/v1alpha1/namespaces/{namespace}/redises/{name}
KubedbComV1alpha1ApireadNamespacedSnapshotGET /apis/kubedb.com/v1alpha1/namespaces/{namespace}/snapshots/{name}
KubedbComV1alpha1ApireplaceNamespacedDormantDatabasePUT /apis/kubedb.com/v1alpha1/namespaces/{namespace}/dormantdatabases/{name}
KubedbComV1alpha1ApireplaceNamespacedElasticsearchPUT /apis/kubedb.com/v1alpha1/namespaces/{namespace}/elasticsearches/{name}
KubedbComV1alpha1ApireplaceNamespacedMemcachedPUT /apis/kubedb.com/v1alpha1/namespaces/{namespace}/memcacheds/{name}
KubedbComV1alpha1ApireplaceNamespacedMongoDBPUT /apis/kubedb.com/v1alpha1/namespaces/{namespace}/mongodbs/{name}
KubedbComV1alpha1ApireplaceNamespacedMySQLPUT /apis/kubedb.com/v1alpha1/namespaces/{namespace}/mysqls/{name}
KubedbComV1alpha1ApireplaceNamespacedPostgresPUT /apis/kubedb.com/v1alpha1/namespaces/{namespace}/postgreses/{name}
KubedbComV1alpha1ApireplaceNamespacedRedisPUT /apis/kubedb.com/v1alpha1/namespaces/{namespace}/redises/{name}
KubedbComV1alpha1ApireplaceNamespacedSnapshotPUT /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

hello@appscode.com