kubernetes-client/c
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update readme after the data types of function prameters changes from "int" to "int*"

Browse Source
This commit is contained in:
Hui Yu
2023-12-14 22:38:35 +08:00
parent 83799e274c
commit 6409031d73
1 changed files with 54 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

64
README.md
View File

@@ -86,16 +86,16 @@ list all pods:
pod_list = CoreV1API_listNamespacedPod(apiClient, pod_list = CoreV1API_listNamespacedPod(apiClient,
"default", /*namespace */ "default", /*namespace */
NULL, /* pretty */ NULL, /* pretty */
0, /* allowWatchBookmarks */ NULL, /* allowWatchBookmarks */
NULL, /* continue */ NULL, /* continue */
NULL, /* fieldSelector */ NULL, /* fieldSelector */
NULL, /* labelSelector */ NULL, /* labelSelector */
0, /* limit */ NULL, /* limit */
NULL, /* resourceVersion */ NULL, /* resourceVersion */
NULL, /* resourceVersionMatch */ NULL, /* resourceVersionMatch */
0, /* sendInitialEvents */ NULL, /* sendInitialEvents */
0, /* timeoutSeconds */ NULL, /* timeoutSeconds */
0 /* watch */ NULL /* watch */
); );
printf("return code=%ld\n", apiClient->response_code); printf("return code=%ld\n", apiClient->response_code);
if (pod_list) { if (pod_list) {
@@ -132,16 +132,16 @@ list all pods in cluster:
pod_list = CoreV1API_listNamespacedPod(apiClient, pod_list = CoreV1API_listNamespacedPod(apiClient,
"default", /*namespace */ "default", /*namespace */
NULL, /* pretty */ NULL, /* pretty */
0, /* allowWatchBookmarks */ NULL, /* allowWatchBookmarks */
NULL, /* continue */ NULL, /* continue */
NULL, /* fieldSelector */ NULL, /* fieldSelector */
NULL, /* labelSelector */ NULL, /* labelSelector */
0, /* limit */ NULL, /* limit */
NULL, /* resourceVersion */ NULL, /* resourceVersion */
NULL, /* resourceVersionMatch */ NULL, /* resourceVersionMatch */
0, /* sendInitialEvents */ NULL, /* sendInitialEvents */
0, /* timeoutSeconds */ NULL, /* timeoutSeconds */
0 /* watch */ NULL /* watch */
); );
printf("return code=%ld\n", apiClient->response_code); printf("return code=%ld\n", apiClient->response_code);
if (pod_list) { if (pod_list) {
@@ -157,6 +157,50 @@ list all pods in cluster:
apiClient_unsetupGlobalEnv(); apiClient_unsetupGlobalEnv();
``` ```
## How to send integer or boolean parameters to API Server
If you want to send an integer or boolean parameter to the API server, you will see that the data type in API function is `int *`, e.g.
```c
// list or watch objects of kind Pod
//
v1_pod_list_t* CoreV1API_listNamespacedPod(apiClient_t *apiClient,
char *_namespace,
char *pretty,
int *allowWatchBookmarks, /* <-- here */
char *_continue,
char *fieldSelector,
char *labelSelector,
int *limit, /* <-- here */
char *resourceVersion,
char *resourceVersionMatch,
int *sendInitialEvents, /* <-- here */
int *timeoutSeconds, /* <-- here */
int *watch); /* <-- here */
```
For example we can send `timeoutSeconds` and `watch` using the following usage:
```c
int timeoutSeconds = 30;
int watch = 1;
pod_list = CoreV1API_listNamespacedPod(apiClient, "default", /*namespace */
NULL, /* pretty */
NULL, /* allowWatchBookmarks */
NULL, /* continue */
NULL, /* fieldSelector */
NULL, /* labelSelector */
NULL, /* limit */
NULL, /* resourceVersion */
NULL, /* resourceVersionMatch */
NULL, /* sendInitialEvents */
&timeoutSeconds, /* timeoutSeconds */
&watch /* watch */
);
```
Setting the parameter to `NULL` means not to send the parameter to the API Server, and the API Server will use the default value for this parameter.
## Aggregated APIs and CRD-based APIs ## Aggregated APIs and CRD-based APIs
If you want to implement a client for aggregated APIs (such as the metrics server API `apis/metrics.k8s.io` ) or CRD-based APIs, use the [generic client](./kubernetes/src/generic.c). See [example](./examples/generic/main.c). If you want to implement a client for aggregated APIs (such as the metrics server API `apis/metrics.k8s.io` ) or CRD-based APIs, use the [generic client](./kubernetes/src/generic.c). See [example](./examples/generic/main.c).