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.appscode.searchlight</groupId>
    <artifactId>client-java</artifactId>
    <version>0.1.0</version>
    <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "com.appscode.searchlight:client-java:0.1.0"

Others

At first generate the JAR by executing:

mvn package

Then manually install the following JARs:

target/client-java-0.1.0.jar
target/lib/*.jar

Getting Started

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


import com.appscode.searchlight.client.*;
import com.appscode.searchlight.client.auth.*;
import com.appscode.searchlight.client.models.*;
import com.appscode.searchlight.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
ApisApi	getAPIVersions	GET /apis/
IncidentsMonitoringAppscodeComApi	getAPIGroup	GET /apis/incidents.monitoring.appscode.com/
IncidentsMonitoringAppscodeComV1alpha1Api	createNamespacedAcknowledgement	POST /apis/incidents.monitoring.appscode.com/v1alpha1/namespaces/{namespace}/acknowledgements
IncidentsMonitoringAppscodeComV1alpha1Api	deleteNamespacedAcknowledgement	DELETE /apis/incidents.monitoring.appscode.com/v1alpha1/namespaces/{namespace}/acknowledgements/{name}
IncidentsMonitoringAppscodeComV1alpha1Api	getAPIResources	GET /apis/incidents.monitoring.appscode.com/v1alpha1/
MonitoringAppscodeComApi	getAPIGroup	GET /apis/monitoring.appscode.com/
MonitoringAppscodeComV1alpha1Api	createNamespacedClusterAlert	POST /apis/monitoring.appscode.com/v1alpha1/namespaces/{namespace}/clusteralerts
MonitoringAppscodeComV1alpha1Api	createNamespacedIncident	POST /apis/monitoring.appscode.com/v1alpha1/namespaces/{namespace}/incidents
MonitoringAppscodeComV1alpha1Api	createNamespacedNodeAlert	POST /apis/monitoring.appscode.com/v1alpha1/namespaces/{namespace}/nodealerts
MonitoringAppscodeComV1alpha1Api	createNamespacedPodAlert	POST /apis/monitoring.appscode.com/v1alpha1/namespaces/{namespace}/podalerts
MonitoringAppscodeComV1alpha1Api	createNamespacedSearchlightPlugin	POST /apis/monitoring.appscode.com/v1alpha1/namespaces/{namespace}/searchlightplugins
MonitoringAppscodeComV1alpha1Api	deleteCollectionNamespacedClusterAlert	DELETE /apis/monitoring.appscode.com/v1alpha1/namespaces/{namespace}/clusteralerts
MonitoringAppscodeComV1alpha1Api	deleteCollectionNamespacedIncident	DELETE /apis/monitoring.appscode.com/v1alpha1/namespaces/{namespace}/incidents
MonitoringAppscodeComV1alpha1Api	deleteCollectionNamespacedNodeAlert	DELETE /apis/monitoring.appscode.com/v1alpha1/namespaces/{namespace}/nodealerts
MonitoringAppscodeComV1alpha1Api	deleteCollectionNamespacedPodAlert	DELETE /apis/monitoring.appscode.com/v1alpha1/namespaces/{namespace}/podalerts
MonitoringAppscodeComV1alpha1Api	deleteCollectionNamespacedSearchlightPlugin	DELETE /apis/monitoring.appscode.com/v1alpha1/namespaces/{namespace}/searchlightplugins
MonitoringAppscodeComV1alpha1Api	deleteNamespacedClusterAlert	DELETE /apis/monitoring.appscode.com/v1alpha1/namespaces/{namespace}/clusteralerts/{name}
MonitoringAppscodeComV1alpha1Api	deleteNamespacedIncident	DELETE /apis/monitoring.appscode.com/v1alpha1/namespaces/{namespace}/incidents/{name}
MonitoringAppscodeComV1alpha1Api	deleteNamespacedNodeAlert	DELETE /apis/monitoring.appscode.com/v1alpha1/namespaces/{namespace}/nodealerts/{name}
MonitoringAppscodeComV1alpha1Api	deleteNamespacedPodAlert	DELETE /apis/monitoring.appscode.com/v1alpha1/namespaces/{namespace}/podalerts/{name}
MonitoringAppscodeComV1alpha1Api	deleteNamespacedSearchlightPlugin	DELETE /apis/monitoring.appscode.com/v1alpha1/namespaces/{namespace}/searchlightplugins/{name}
MonitoringAppscodeComV1alpha1Api	getAPIResources	GET /apis/monitoring.appscode.com/v1alpha1/
MonitoringAppscodeComV1alpha1Api	listClusterAlertForAllNamespaces	GET /apis/monitoring.appscode.com/v1alpha1/clusteralerts
MonitoringAppscodeComV1alpha1Api	listIncidentForAllNamespaces	GET /apis/monitoring.appscode.com/v1alpha1/incidents
MonitoringAppscodeComV1alpha1Api	listNamespacedClusterAlert	GET /apis/monitoring.appscode.com/v1alpha1/namespaces/{namespace}/clusteralerts
MonitoringAppscodeComV1alpha1Api	listNamespacedIncident	GET /apis/monitoring.appscode.com/v1alpha1/namespaces/{namespace}/incidents
MonitoringAppscodeComV1alpha1Api	listNamespacedNodeAlert	GET /apis/monitoring.appscode.com/v1alpha1/namespaces/{namespace}/nodealerts
MonitoringAppscodeComV1alpha1Api	listNamespacedPodAlert	GET /apis/monitoring.appscode.com/v1alpha1/namespaces/{namespace}/podalerts
MonitoringAppscodeComV1alpha1Api	listNamespacedSearchlightPlugin	GET /apis/monitoring.appscode.com/v1alpha1/namespaces/{namespace}/searchlightplugins
MonitoringAppscodeComV1alpha1Api	listNodeAlertForAllNamespaces	GET /apis/monitoring.appscode.com/v1alpha1/nodealerts
MonitoringAppscodeComV1alpha1Api	listPodAlertForAllNamespaces	GET /apis/monitoring.appscode.com/v1alpha1/podalerts
MonitoringAppscodeComV1alpha1Api	listSearchlightPluginForAllNamespaces	GET /apis/monitoring.appscode.com/v1alpha1/searchlightplugins
MonitoringAppscodeComV1alpha1Api	patchNamespacedClusterAlert	PATCH /apis/monitoring.appscode.com/v1alpha1/namespaces/{namespace}/clusteralerts/{name}
MonitoringAppscodeComV1alpha1Api	patchNamespacedIncident	PATCH /apis/monitoring.appscode.com/v1alpha1/namespaces/{namespace}/incidents/{name}
MonitoringAppscodeComV1alpha1Api	patchNamespacedNodeAlert	PATCH /apis/monitoring.appscode.com/v1alpha1/namespaces/{namespace}/nodealerts/{name}
MonitoringAppscodeComV1alpha1Api	patchNamespacedPodAlert	PATCH /apis/monitoring.appscode.com/v1alpha1/namespaces/{namespace}/podalerts/{name}
MonitoringAppscodeComV1alpha1Api	patchNamespacedSearchlightPlugin	PATCH /apis/monitoring.appscode.com/v1alpha1/namespaces/{namespace}/searchlightplugins/{name}
MonitoringAppscodeComV1alpha1Api	readNamespacedClusterAlert	GET /apis/monitoring.appscode.com/v1alpha1/namespaces/{namespace}/clusteralerts/{name}
MonitoringAppscodeComV1alpha1Api	readNamespacedIncident	GET /apis/monitoring.appscode.com/v1alpha1/namespaces/{namespace}/incidents/{name}
MonitoringAppscodeComV1alpha1Api	readNamespacedNodeAlert	GET /apis/monitoring.appscode.com/v1alpha1/namespaces/{namespace}/nodealerts/{name}
MonitoringAppscodeComV1alpha1Api	readNamespacedPodAlert	GET /apis/monitoring.appscode.com/v1alpha1/namespaces/{namespace}/podalerts/{name}
MonitoringAppscodeComV1alpha1Api	readNamespacedSearchlightPlugin	GET /apis/monitoring.appscode.com/v1alpha1/namespaces/{namespace}/searchlightplugins/{name}
MonitoringAppscodeComV1alpha1Api	replaceNamespacedClusterAlert	PUT /apis/monitoring.appscode.com/v1alpha1/namespaces/{namespace}/clusteralerts/{name}
MonitoringAppscodeComV1alpha1Api	replaceNamespacedIncident	PUT /apis/monitoring.appscode.com/v1alpha1/namespaces/{namespace}/incidents/{name}
MonitoringAppscodeComV1alpha1Api	replaceNamespacedNodeAlert	PUT /apis/monitoring.appscode.com/v1alpha1/namespaces/{namespace}/nodealerts/{name}
MonitoringAppscodeComV1alpha1Api	replaceNamespacedPodAlert	PUT /apis/monitoring.appscode.com/v1alpha1/namespaces/{namespace}/podalerts/{name}
MonitoringAppscodeComV1alpha1Api	replaceNamespacedSearchlightPlugin	PUT /apis/monitoring.appscode.com/v1alpha1/namespaces/{namespace}/searchlightplugins/{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