Skip to content

README.md

Latest commit

 

History

History
158 lines (116 loc) · 7.7 KB

README.md

File metadata and controls

158 lines (116 loc) · 7.7 KB

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.appscode.voyager</groupId>
    <artifactId>client-java</artifactId>
    <version>1.0-SNAPSHOT</version>
    <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "com.appscode.voyager:client-java:1.0-SNAPSHOT"

Others

At first generate the JAR by executing:

mvn package

Then manually install the following JARs:

  • target/client-java-1.0-SNAPSHOT.jar
  • target/lib/*.jar

Getting Started

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

import com.appscode.voyager.client.*;
import com.appscode.voyager.client.auth.*;
import com.appscode.voyager.client.models.*;
import com.appscode.voyager.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/
VoyagerAppscodeComApi getAPIGroup GET /apis/voyager.appscode.com/
VoyagerAppscodeComV1beta1Api createNamespacedCertificate POST /apis/voyager.appscode.com/v1beta1/namespaces/{namespace}/certificates
VoyagerAppscodeComV1beta1Api createNamespacedIngress POST /apis/voyager.appscode.com/v1beta1/namespaces/{namespace}/ingresses
VoyagerAppscodeComV1beta1Api deleteCollectionNamespacedCertificate DELETE /apis/voyager.appscode.com/v1beta1/namespaces/{namespace}/certificates
VoyagerAppscodeComV1beta1Api deleteCollectionNamespacedIngress DELETE /apis/voyager.appscode.com/v1beta1/namespaces/{namespace}/ingresses
VoyagerAppscodeComV1beta1Api deleteNamespacedCertificate DELETE /apis/voyager.appscode.com/v1beta1/namespaces/{namespace}/certificates/{name}
VoyagerAppscodeComV1beta1Api deleteNamespacedIngress DELETE /apis/voyager.appscode.com/v1beta1/namespaces/{namespace}/ingresses/{name}
VoyagerAppscodeComV1beta1Api getAPIResources GET /apis/voyager.appscode.com/v1beta1/
VoyagerAppscodeComV1beta1Api listCertificateForAllNamespaces GET /apis/voyager.appscode.com/v1beta1/certificates
VoyagerAppscodeComV1beta1Api listIngressForAllNamespaces GET /apis/voyager.appscode.com/v1beta1/ingresses
VoyagerAppscodeComV1beta1Api listNamespacedCertificate GET /apis/voyager.appscode.com/v1beta1/namespaces/{namespace}/certificates
VoyagerAppscodeComV1beta1Api listNamespacedIngress GET /apis/voyager.appscode.com/v1beta1/namespaces/{namespace}/ingresses
VoyagerAppscodeComV1beta1Api patchNamespacedCertificate PATCH /apis/voyager.appscode.com/v1beta1/namespaces/{namespace}/certificates/{name}
VoyagerAppscodeComV1beta1Api patchNamespacedIngress PATCH /apis/voyager.appscode.com/v1beta1/namespaces/{namespace}/ingresses/{name}
VoyagerAppscodeComV1beta1Api readNamespacedCertificate GET /apis/voyager.appscode.com/v1beta1/namespaces/{namespace}/certificates/{name}
VoyagerAppscodeComV1beta1Api readNamespacedIngress GET /apis/voyager.appscode.com/v1beta1/namespaces/{namespace}/ingresses/{name}
VoyagerAppscodeComV1beta1Api replaceNamespacedCertificate PUT /apis/voyager.appscode.com/v1beta1/namespaces/{namespace}/certificates/{name}
VoyagerAppscodeComV1beta1Api replaceNamespacedIngress PUT /apis/voyager.appscode.com/v1beta1/namespaces/{namespace}/ingresses/{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