|
| 1 | +# ThirdPartyResourcesApi |
| 2 | + |
| 3 | +All URIs are relative to *https://localhost* |
| 4 | + |
| 5 | +Method | HTTP request | Description |
| 6 | +------------- | ------------- | ------------- |
| 7 | +[**createThirdPartyResource**](ThirdPartyResourcesApi.md#createThirdPartyResource) | **POST** /apis/{fqdn}/v1/namespaces/{namespace}/{resource} | Create a Resource |
| 8 | +[**deleteThirdPartyResource**](ThirdPartyResourcesApi.md#deleteThirdPartyResource) | **DELETE** /apis/{fqdn}/v1/namespaces/{namespace}/{resource}/{name} | Deletes a specific Resource |
| 9 | +[**getThirdPartyResource**](ThirdPartyResourcesApi.md#getThirdPartyResource) | **GET** /apis/{fqdn}/v1/namespaces/{namespace}/{resource}/{name} | Gets a specific Resource |
| 10 | +[**listThirdPartyResource**](ThirdPartyResourcesApi.md#listThirdPartyResource) | **GET** /apis/{fqdn}/v1/{resource} | Gets Resources |
| 11 | +[**updateThirdPartyResource**](ThirdPartyResourcesApi.md#updateThirdPartyResource) | **PUT** /apis/{fqdn}/v1/namespaces/{namespace}/{resource}/{name} | Update a Resource |
| 12 | + |
| 13 | + |
| 14 | +<a name="createThirdPartyResource"></a> |
| 15 | +# **createThirdPartyResource** |
| 16 | +> Object createThirdPartyResource(namespace, fqdn, resource, body) |
| 17 | +
|
| 18 | +Create a Resource |
| 19 | + |
| 20 | +Creates a third party resource of the type specified |
| 21 | + |
| 22 | +### Example |
| 23 | +```java |
| 24 | +// Import classes: |
| 25 | +//import io.kubernetes.client.ApiClient; |
| 26 | +//import io.kubernetes.client.ApiException; |
| 27 | +//import io.kubernetes.client.Configuration; |
| 28 | +//import io.kubernetes.client.auth.*; |
| 29 | +//import io.kubernetes.client.apis.ThirdPartyResourcesApi; |
| 30 | + |
| 31 | +ApiClient defaultClient = Configuration.getDefaultApiClient(); |
| 32 | + |
| 33 | +// Configure API key authorization: BearerToken |
| 34 | +ApiKeyAuth BearerToken = (ApiKeyAuth) defaultClient.getAuthentication("BearerToken"); |
| 35 | +BearerToken.setApiKey("YOUR API KEY"); |
| 36 | +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) |
| 37 | +//BearerToken.setApiKeyPrefix("Token"); |
| 38 | + |
| 39 | +ThirdPartyResourcesApi apiInstance = new ThirdPartyResourcesApi(); |
| 40 | +String namespace = "namespace_example"; // String | The Resource's namespace |
| 41 | +String fqdn = "fqdn_example"; // String | The Third party Resource fqdn |
| 42 | +String resource = "resource_example"; // String | The Resource type |
| 43 | +Object body = null; // Object | The JSON schema of the Resource to create. |
| 44 | +try { |
| 45 | + Object result = apiInstance.createThirdPartyResource(namespace, fqdn, resource, body); |
| 46 | + System.out.println(result); |
| 47 | +} catch (ApiException e) { |
| 48 | + System.err.println("Exception when calling ThirdPartyResourcesApi#createThirdPartyResource"); |
| 49 | + e.printStackTrace(); |
| 50 | +} |
| 51 | +``` |
| 52 | + |
| 53 | +### Parameters |
| 54 | + |
| 55 | +Name | Type | Description | Notes |
| 56 | +------------- | ------------- | ------------- | ------------- |
| 57 | + **namespace** | **String**| The Resource's namespace | |
| 58 | + **fqdn** | **String**| The Third party Resource fqdn | |
| 59 | + **resource** | **String**| The Resource type | |
| 60 | + **body** | **Object**| The JSON schema of the Resource to create. | |
| 61 | + |
| 62 | +### Return type |
| 63 | + |
| 64 | +**Object** |
| 65 | + |
| 66 | +### Authorization |
| 67 | + |
| 68 | +[BearerToken](../README.md#BearerToken) |
| 69 | + |
| 70 | +### HTTP request headers |
| 71 | + |
| 72 | + - **Content-Type**: Not defined |
| 73 | + - **Accept**: Not defined |
| 74 | + |
| 75 | +<a name="deleteThirdPartyResource"></a> |
| 76 | +# **deleteThirdPartyResource** |
| 77 | +> Object deleteThirdPartyResource(body, gracePeriodSeconds, orphanDependents, propagationPolicy) |
| 78 | +
|
| 79 | +Deletes a specific Resource |
| 80 | + |
| 81 | +Deletes the specified Resource in the specified namespace |
| 82 | + |
| 83 | +### Example |
| 84 | +```java |
| 85 | +// Import classes: |
| 86 | +//import io.kubernetes.client.ApiClient; |
| 87 | +//import io.kubernetes.client.ApiException; |
| 88 | +//import io.kubernetes.client.Configuration; |
| 89 | +//import io.kubernetes.client.auth.*; |
| 90 | +//import io.kubernetes.client.apis.ThirdPartyResourcesApi; |
| 91 | + |
| 92 | +ApiClient defaultClient = Configuration.getDefaultApiClient(); |
| 93 | + |
| 94 | +// Configure API key authorization: BearerToken |
| 95 | +ApiKeyAuth BearerToken = (ApiKeyAuth) defaultClient.getAuthentication("BearerToken"); |
| 96 | +BearerToken.setApiKey("YOUR API KEY"); |
| 97 | +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) |
| 98 | +//BearerToken.setApiKeyPrefix("Token"); |
| 99 | + |
| 100 | +ThirdPartyResourcesApi apiInstance = new ThirdPartyResourcesApi(); |
| 101 | +V1DeleteOptions body = new V1DeleteOptions(); // V1DeleteOptions | |
| 102 | +Integer gracePeriodSeconds = 56; // Integer | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
| 103 | +Boolean orphanDependents = true; // Boolean | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
| 104 | +String propagationPolicy = "propagationPolicy_example"; // String | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. |
| 105 | +try { |
| 106 | + Object result = apiInstance.deleteThirdPartyResource(body, gracePeriodSeconds, orphanDependents, propagationPolicy); |
| 107 | + System.out.println(result); |
| 108 | +} catch (ApiException e) { |
| 109 | + System.err.println("Exception when calling ThirdPartyResourcesApi#deleteThirdPartyResource"); |
| 110 | + e.printStackTrace(); |
| 111 | +} |
| 112 | +``` |
| 113 | + |
| 114 | +### Parameters |
| 115 | + |
| 116 | +Name | Type | Description | Notes |
| 117 | +------------- | ------------- | ------------- | ------------- |
| 118 | + **body** | [**V1DeleteOptions**](V1DeleteOptions.md)| | |
| 119 | + **gracePeriodSeconds** | **Integer**| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional] |
| 120 | + **orphanDependents** | **Boolean**| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | [optional] |
| 121 | + **propagationPolicy** | **String**| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. | [optional] |
| 122 | + |
| 123 | +### Return type |
| 124 | + |
| 125 | +**Object** |
| 126 | + |
| 127 | +### Authorization |
| 128 | + |
| 129 | +[BearerToken](../README.md#BearerToken) |
| 130 | + |
| 131 | +### HTTP request headers |
| 132 | + |
| 133 | + - **Content-Type**: Not defined |
| 134 | + - **Accept**: Not defined |
| 135 | + |
| 136 | +<a name="getThirdPartyResource"></a> |
| 137 | +# **getThirdPartyResource** |
| 138 | +> Object getThirdPartyResource(namespace, name, fqdn, resource) |
| 139 | +
|
| 140 | +Gets a specific Resource |
| 141 | + |
| 142 | +Returns a specific Resource in a namespace |
| 143 | + |
| 144 | +### Example |
| 145 | +```java |
| 146 | +// Import classes: |
| 147 | +//import io.kubernetes.client.ApiClient; |
| 148 | +//import io.kubernetes.client.ApiException; |
| 149 | +//import io.kubernetes.client.Configuration; |
| 150 | +//import io.kubernetes.client.auth.*; |
| 151 | +//import io.kubernetes.client.apis.ThirdPartyResourcesApi; |
| 152 | + |
| 153 | +ApiClient defaultClient = Configuration.getDefaultApiClient(); |
| 154 | + |
| 155 | +// Configure API key authorization: BearerToken |
| 156 | +ApiKeyAuth BearerToken = (ApiKeyAuth) defaultClient.getAuthentication("BearerToken"); |
| 157 | +BearerToken.setApiKey("YOUR API KEY"); |
| 158 | +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) |
| 159 | +//BearerToken.setApiKeyPrefix("Token"); |
| 160 | + |
| 161 | +ThirdPartyResourcesApi apiInstance = new ThirdPartyResourcesApi(); |
| 162 | +String namespace = "namespace_example"; // String | The Resource's namespace |
| 163 | +String name = "name_example"; // String | The Resource's name |
| 164 | +String fqdn = "fqdn_example"; // String | The Third party Resource fqdn |
| 165 | +String resource = "resource_example"; // String | The Resource type |
| 166 | +try { |
| 167 | + Object result = apiInstance.getThirdPartyResource(namespace, name, fqdn, resource); |
| 168 | + System.out.println(result); |
| 169 | +} catch (ApiException e) { |
| 170 | + System.err.println("Exception when calling ThirdPartyResourcesApi#getThirdPartyResource"); |
| 171 | + e.printStackTrace(); |
| 172 | +} |
| 173 | +``` |
| 174 | + |
| 175 | +### Parameters |
| 176 | + |
| 177 | +Name | Type | Description | Notes |
| 178 | +------------- | ------------- | ------------- | ------------- |
| 179 | + **namespace** | **String**| The Resource's namespace | |
| 180 | + **name** | **String**| The Resource's name | |
| 181 | + **fqdn** | **String**| The Third party Resource fqdn | |
| 182 | + **resource** | **String**| The Resource type | |
| 183 | + |
| 184 | +### Return type |
| 185 | + |
| 186 | +**Object** |
| 187 | + |
| 188 | +### Authorization |
| 189 | + |
| 190 | +[BearerToken](../README.md#BearerToken) |
| 191 | + |
| 192 | +### HTTP request headers |
| 193 | + |
| 194 | + - **Content-Type**: Not defined |
| 195 | + - **Accept**: Not defined |
| 196 | + |
| 197 | +<a name="listThirdPartyResource"></a> |
| 198 | +# **listThirdPartyResource** |
| 199 | +> Object listThirdPartyResource(fqdn, resource, watch) |
| 200 | +
|
| 201 | +Gets Resources |
| 202 | + |
| 203 | +Returns a list of Resources |
| 204 | + |
| 205 | +### Example |
| 206 | +```java |
| 207 | +// Import classes: |
| 208 | +//import io.kubernetes.client.ApiClient; |
| 209 | +//import io.kubernetes.client.ApiException; |
| 210 | +//import io.kubernetes.client.Configuration; |
| 211 | +//import io.kubernetes.client.auth.*; |
| 212 | +//import io.kubernetes.client.apis.ThirdPartyResourcesApi; |
| 213 | + |
| 214 | +ApiClient defaultClient = Configuration.getDefaultApiClient(); |
| 215 | + |
| 216 | +// Configure API key authorization: BearerToken |
| 217 | +ApiKeyAuth BearerToken = (ApiKeyAuth) defaultClient.getAuthentication("BearerToken"); |
| 218 | +BearerToken.setApiKey("YOUR API KEY"); |
| 219 | +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) |
| 220 | +//BearerToken.setApiKeyPrefix("Token"); |
| 221 | + |
| 222 | +ThirdPartyResourcesApi apiInstance = new ThirdPartyResourcesApi(); |
| 223 | +String fqdn = "fqdn_example"; // String | The Third party Resource fqdn |
| 224 | +String resource = "resource_example"; // String | The Resource type |
| 225 | +Boolean watch = true; // Boolean | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| 226 | +try { |
| 227 | + Object result = apiInstance.listThirdPartyResource(fqdn, resource, watch); |
| 228 | + System.out.println(result); |
| 229 | +} catch (ApiException e) { |
| 230 | + System.err.println("Exception when calling ThirdPartyResourcesApi#listThirdPartyResource"); |
| 231 | + e.printStackTrace(); |
| 232 | +} |
| 233 | +``` |
| 234 | + |
| 235 | +### Parameters |
| 236 | + |
| 237 | +Name | Type | Description | Notes |
| 238 | +------------- | ------------- | ------------- | ------------- |
| 239 | + **fqdn** | **String**| The Third party Resource fqdn | |
| 240 | + **resource** | **String**| The Resource type | |
| 241 | + **watch** | **Boolean**| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | [optional] |
| 242 | + |
| 243 | +### Return type |
| 244 | + |
| 245 | +**Object** |
| 246 | + |
| 247 | +### Authorization |
| 248 | + |
| 249 | +[BearerToken](../README.md#BearerToken) |
| 250 | + |
| 251 | +### HTTP request headers |
| 252 | + |
| 253 | + - **Content-Type**: Not defined |
| 254 | + - **Accept**: Not defined |
| 255 | + |
| 256 | +<a name="updateThirdPartyResource"></a> |
| 257 | +# **updateThirdPartyResource** |
| 258 | +> Object updateThirdPartyResource(namespace, fqdn, resource, body) |
| 259 | +
|
| 260 | +Update a Resource |
| 261 | + |
| 262 | +Update the specified third party resource of the type specified |
| 263 | + |
| 264 | +### Example |
| 265 | +```java |
| 266 | +// Import classes: |
| 267 | +//import io.kubernetes.client.ApiClient; |
| 268 | +//import io.kubernetes.client.ApiException; |
| 269 | +//import io.kubernetes.client.Configuration; |
| 270 | +//import io.kubernetes.client.auth.*; |
| 271 | +//import io.kubernetes.client.apis.ThirdPartyResourcesApi; |
| 272 | + |
| 273 | +ApiClient defaultClient = Configuration.getDefaultApiClient(); |
| 274 | + |
| 275 | +// Configure API key authorization: BearerToken |
| 276 | +ApiKeyAuth BearerToken = (ApiKeyAuth) defaultClient.getAuthentication("BearerToken"); |
| 277 | +BearerToken.setApiKey("YOUR API KEY"); |
| 278 | +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) |
| 279 | +//BearerToken.setApiKeyPrefix("Token"); |
| 280 | + |
| 281 | +ThirdPartyResourcesApi apiInstance = new ThirdPartyResourcesApi(); |
| 282 | +String namespace = "namespace_example"; // String | The Resource's namespace |
| 283 | +String fqdn = "fqdn_example"; // String | The Third party Resource fqdn |
| 284 | +String resource = "resource_example"; // String | The Resource type |
| 285 | +Object body = null; // Object | The JSON schema of the Resource to create. |
| 286 | +try { |
| 287 | + Object result = apiInstance.updateThirdPartyResource(namespace, fqdn, resource, body); |
| 288 | + System.out.println(result); |
| 289 | +} catch (ApiException e) { |
| 290 | + System.err.println("Exception when calling ThirdPartyResourcesApi#updateThirdPartyResource"); |
| 291 | + e.printStackTrace(); |
| 292 | +} |
| 293 | +``` |
| 294 | + |
| 295 | +### Parameters |
| 296 | + |
| 297 | +Name | Type | Description | Notes |
| 298 | +------------- | ------------- | ------------- | ------------- |
| 299 | + **namespace** | **String**| The Resource's namespace | |
| 300 | + **fqdn** | **String**| The Third party Resource fqdn | |
| 301 | + **resource** | **String**| The Resource type | |
| 302 | + **body** | **Object**| The JSON schema of the Resource to create. | |
| 303 | + |
| 304 | +### Return type |
| 305 | + |
| 306 | +**Object** |
| 307 | + |
| 308 | +### Authorization |
| 309 | + |
| 310 | +[BearerToken](../README.md#BearerToken) |
| 311 | + |
| 312 | +### HTTP request headers |
| 313 | + |
| 314 | + - **Content-Type**: Not defined |
| 315 | + - **Accept**: Not defined |
| 316 | + |
0 commit comments