Skip to content

Commit f562c45

Browse files
secondsunsecondsun
authored
Connector api (#63)
* feat: adding connector sdk * chore(connector): adding generated connector sdk
1 parent ceb7457 commit f562c45

69 files changed

Lines changed: 10235 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎packages/connector-management-sdk/README.md‎

Lines changed: 171 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,171 @@
1+
# connector-management-sdk
2+
3+
Connector Service Fleet Manager
4+
5+
- API version: 0.0.3
6+
7+
Connector Service Fleet Manager is a Rest API to manage connectors.
8+
9+
10+
*Automatically generated by the [OpenAPI Generator](https://openapi-generator.tech)*
11+
12+
## Requirements
13+
14+
Building the API client library requires:
15+
16+
1. Java 1.8+
17+
2. Maven/Gradle
18+
19+
## Installation
20+
21+
To install the API client library to your local Maven repository, simply execute:
22+
23+
```shell
24+
mvn clean install
25+
```
26+
27+
To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:
28+
29+
```shell
30+
mvn clean deploy
31+
```
32+
33+
Refer to the [OSSRH Guide](http://central.sonatype.org/pages/ossrh-guide.html) for more information.
34+
35+
### Maven users
36+
37+
Add this dependency to your project's POM:
38+
39+
```xml
40+
<dependency>
41+
<groupId>com.redhat.cloud</groupId>
42+
<artifactId>connector-management-sdk</artifactId>
43+
<version>0.0.3</version>
44+
<scope>compile</scope>
45+
</dependency>
46+
```
47+
48+
### Gradle users
49+
50+
Add this dependency to your project's build file:
51+
52+
```groovy
53+
compile "com.redhat.cloud:connector-management-sdk:0.0.3"
54+
```
55+
56+
### Others
57+
58+
At first generate the JAR by executing:
59+
60+
```shell
61+
mvn clean package
62+
```
63+
64+
Then manually install the following JARs:
65+
66+
- `target/connector-management-sdk-0.0.3.jar`
67+
- `target/lib/*.jar`
68+
69+
## Getting Started
70+
71+
Please follow the [installation](#installation) instruction and execute the following Java code:
72+
73+
```java
74+
75+
import com.openshift.cloud.api.connector.invoker.*;
76+
import com.openshift.cloud.api.connector.invoker.auth.*;
77+
import com.openshift.cloud.api.connector.models.*;
78+
import com.openshift.cloud.api.connector.ConnectorClustersApi;
79+
80+
public class ConnectorClustersApiExample {
81+
82+
public static void main(String[] args) {
83+
ApiClient defaultClient = Configuration.getDefaultApiClient();
84+
defaultClient.setBasePath("https://api.openshift.com");
85+
86+
// Configure HTTP bearer authorization: Bearer
87+
HttpBearerAuth Bearer = (HttpBearerAuth) defaultClient.getAuthentication("Bearer");
88+
Bearer.setBearerToken("BEARER TOKEN");
89+
90+
ConnectorClustersApi apiInstance = new ConnectorClustersApi(defaultClient);
91+
Boolean async = true; // Boolean | Perform the action in an asynchronous manner
92+
ConnectorCluster connectorCluster = new ConnectorCluster(); // ConnectorCluster | Connector cluster data
93+
try {
94+
ConnectorCluster result = apiInstance.createConnectorCluster(async, connectorCluster);
95+
System.out.println(result);
96+
} catch (ApiException e) {
97+
System.err.println("Exception when calling ConnectorClustersApi#createConnectorCluster");
98+
System.err.println("Status code: " + e.getCode());
99+
System.err.println("Reason: " + e.getResponseBody());
100+
System.err.println("Response headers: " + e.getResponseHeaders());
101+
e.printStackTrace();
102+
}
103+
}
104+
}
105+
106+
```
107+
108+
## Documentation for API Endpoints
109+
110+
All URIs are relative to *https://api.openshift.com*
111+
112+
Class | Method | HTTP request | Description
113+
------------ | ------------- | ------------- | -------------
114+
*ConnectorClustersApi* | [**createConnectorCluster**](docs/ConnectorClustersApi.md#createConnectorCluster) | **POST** /api/connector_mgmt/v1/kafka_connector_clusters | Create a new connector cluster
115+
*ConnectorClustersApi* | [**deleteConnectorCluster**](docs/ConnectorClustersApi.md#deleteConnectorCluster) | **DELETE** /api/connector_mgmt/v1/kafka_connector_clusters/{connector_cluster_id} | Delete a connector cluster
116+
*ConnectorClustersApi* | [**getConnectorCluster**](docs/ConnectorClustersApi.md#getConnectorCluster) | **GET** /api/connector_mgmt/v1/kafka_connector_clusters/{connector_cluster_id} | Get a connector cluster
117+
*ConnectorClustersApi* | [**getConnectorClusterAddonParameters**](docs/ConnectorClustersApi.md#getConnectorClusterAddonParameters) | **GET** /api/connector_mgmt/v1/kafka_connector_clusters/{connector_cluster_id}/addon_parameters | Get a connector cluster&#39;s addon parameters
118+
*ConnectorClustersApi* | [**listConnectorClusters**](docs/ConnectorClustersApi.md#listConnectorClusters) | **GET** /api/connector_mgmt/v1/kafka_connector_clusters | Returns a list of connector clusters
119+
*ConnectorClustersApi* | [**updateConnectorClusterById**](docs/ConnectorClustersApi.md#updateConnectorClusterById) | **PUT** /api/connector_mgmt/v1/kafka_connector_clusters/{connector_cluster_id} | udpate a connector cluster
120+
*ConnectorTypesApi* | [**getConnectorTypeByID**](docs/ConnectorTypesApi.md#getConnectorTypeByID) | **GET** /api/connector_mgmt/v1/kafka_connector_types/{connector_type_id} | Get a connector type by id
121+
*ConnectorTypesApi* | [**listConnectorTypes**](docs/ConnectorTypesApi.md#listConnectorTypes) | **GET** /api/connector_mgmt/v1/kafka_connector_types | Returns a list of connector types
122+
*ConnectorsApi* | [**createConnector**](docs/ConnectorsApi.md#createConnector) | **POST** /api/connector_mgmt/v1/kafka_connectors | Create a new connector
123+
*ConnectorsApi* | [**deleteConnector**](docs/ConnectorsApi.md#deleteConnector) | **DELETE** /api/connector_mgmt/v1/kafka_connectors/{id} | Delete a connector
124+
*ConnectorsApi* | [**getConnector**](docs/ConnectorsApi.md#getConnector) | **GET** /api/connector_mgmt/v1/kafka_connectors/{id} | Get a connector
125+
*ConnectorsApi* | [**listConnectors**](docs/ConnectorsApi.md#listConnectors) | **GET** /api/connector_mgmt/v1/kafka_connectors | Returns a list of connector types
126+
*ConnectorsApi* | [**patchConnector**](docs/ConnectorsApi.md#patchConnector) | **PATCH** /api/connector_mgmt/v1/kafka_connectors/{id} | patch a connector
127+
128+
129+
## Documentation for Models
130+
131+
- [AddonClusterTarget](docs/AddonClusterTarget.md)
132+
- [AddonParameter](docs/AddonParameter.md)
133+
- [CloudProviderClusterTarget](docs/CloudProviderClusterTarget.md)
134+
- [ClusterTarget](docs/ClusterTarget.md)
135+
- [Connector](docs/Connector.md)
136+
- [ConnectorAllOf](docs/ConnectorAllOf.md)
137+
- [ConnectorAllOfMetadata](docs/ConnectorAllOfMetadata.md)
138+
- [ConnectorCluster](docs/ConnectorCluster.md)
139+
- [ConnectorClusterAllOf](docs/ConnectorClusterAllOf.md)
140+
- [ConnectorClusterAllOfMetadata](docs/ConnectorClusterAllOfMetadata.md)
141+
- [ConnectorClusterList](docs/ConnectorClusterList.md)
142+
- [ConnectorClusterListAllOf](docs/ConnectorClusterListAllOf.md)
143+
- [ConnectorList](docs/ConnectorList.md)
144+
- [ConnectorListAllOf](docs/ConnectorListAllOf.md)
145+
- [ConnectorType](docs/ConnectorType.md)
146+
- [ConnectorTypeAllOf](docs/ConnectorTypeAllOf.md)
147+
- [ConnectorTypeList](docs/ConnectorTypeList.md)
148+
- [ConnectorTypeListAllOf](docs/ConnectorTypeListAllOf.md)
149+
- [Error](docs/Error.md)
150+
- [ErrorAllOf](docs/ErrorAllOf.md)
151+
- [KafkaConnectionSettings](docs/KafkaConnectionSettings.md)
152+
- [ObjectReference](docs/ObjectReference.md)
153+
154+
155+
## Documentation for Authorization
156+
157+
Authentication schemes defined for the API:
158+
### Bearer
159+
160+
161+
- **Type**: HTTP basic authentication
162+
163+
164+
## Recommendation
165+
166+
It's recommended to create an instance of `ApiClient` per thread in a multithreaded environment to avoid any potential issues.
167+
168+
## Author
169+
170+
171+

0 commit comments

Comments
 (0)