Class PodsApi
java.lang.Object
io.github.alersrt.pod4j.openapi.api.PodsApi
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionclassclassclassclassclassclassclassclassclassclassclassclassclassclassclassclassclassclassclass -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongenerateKubeLibpod(List<String> names) Generate a Kubernetes YAML file.generateSystemdLibpod(String name) Generate Systemd Units Generate Systemd Units based on a pod or container.intApply a podman workload or Kubernetes YAML file.Remove resources created from kube play Tears down pods, secrets, and volumes defined in a YAML filePlay a Kubernetes YAML file.Create a podpodDeleteLibpod(String name) Remove podpodExistsLibpod(String name) Pod exists Check if a pod exists by name or IDpodInspectLibpod(String name) Inspect podpodKillLibpod(String name) Kill a podList podspodPauseLibpod(String name) Pause a pod Pause a podPrune unused podspodRestartLibpod(String name) Restart a podpodStartLibpod(String name) Start a podStatistics for one or more pods Display a live stream of resource usage statistics for the containers in one or more podspodStopLibpod(String name) Stop a podpodTopLibpod(String name) List processes List processes running inside a podpodUnpauseLibpod(String name) Unpause a podvoidsetApiClient(ApiClient apiClient) voidsetCustomBaseUrl(String customBaseUrl) voidsetHostIndex(int hostIndex)
-
Constructor Details
-
PodsApi
public PodsApi() -
PodsApi
-
-
Method Details
-
getApiClient
-
setApiClient
-
getHostIndex
public int getHostIndex() -
setHostIndex
public void setHostIndex(int hostIndex) -
getCustomBaseUrl
-
setCustomBaseUrl
-
generateKubeLibpod
Generate a Kubernetes YAML file. Generate Kubernetes YAML based on a pod or container.- Parameters:
names- Name or ID of the container or pod. (required)- Returns:
- APIgenerateKubeLibpodRequest
- Http Response Details
Status Code Description Response Headers 200 Kubernetes YAML file describing pod - 500 Internal server error -
-
generateSystemdLibpod
Generate Systemd Units Generate Systemd Units based on a pod or container.- Parameters:
name- Name or ID of the container or pod. (required)- Returns:
- APIgenerateSystemdLibpodRequest
- Http Response Details
Status Code Description Response Headers 200 no error - 500 Internal server error -
-
kubeApplyLibpod
Apply a podman workload or Kubernetes YAML file. Deploy a podman container, pod, volume, or Kubernetes yaml to a Kubernetes cluster.- Returns:
- APIkubeApplyLibpodRequest
- Http Response Details
Status Code Description Response Headers 200 Kubernetes YAML file successfully deployed to cluster - 500 Internal server error -
-
playKubeDownLibpod
Remove resources created from kube play Tears down pods, secrets, and volumes defined in a YAML file- Returns:
- APIplayKubeDownLibpodRequest
- Http Response Details
Status Code Description Response Headers 200 PlayKube response - 500 Internal server error -
-
playKubeLibpod
Play a Kubernetes YAML file. Create and run pods based on a Kubernetes YAML file. ### Content-Type Then endpoint support two Content-Type - `plain/text` for yaml format - `application/x-tar` for sending context(s) required for building images #### Tar format The tar format must contain a `play.yaml` file at the root that will be used. If the file format requires context to build an image, it uses the image name and check for corresponding folder. For example, the client sends a tar file with the following structure: ``` └── content.tar ├── play.yaml └── foobar/ └── Containerfile ``` The `play.yaml` is the following, the `foobar` image means we are looking for a context with this name. ``` apiVersion: v1 kind: Pod metadata: name: demo-build-remote spec: containers: - name: container image: foobar ```- Returns:
- APIplayKubeLibpodRequest
- Http Response Details
Status Code Description Response Headers 200 PlayKube response - 500 Internal server error -
-
podCreateLibpod
Create a pod- Returns:
- APIpodCreateLibpodRequest
- Http Response Details
Status Code Description Response Headers 201 - 400 Bad parameter in request - 409 status conflict - 500 Internal server error -
-
podDeleteLibpod
Remove pod- Parameters:
name- the name or ID of the pod (required)- Returns:
- APIpodDeleteLibpodRequest
- Http Response Details
Status Code Description Response Headers 200 Rm pod - 400 Bad parameter in request - 404 No such pod - 500 Internal server error -
-
podExistsLibpod
Pod exists Check if a pod exists by name or ID- Parameters:
name- the name or ID of the pod (required)- Returns:
- APIpodExistsLibpodRequest
- Http Response Details
Status Code Description Response Headers 204 pod exists - 404 No such pod - 500 Internal server error -
-
podInspectLibpod
Inspect pod- Parameters:
name- the name or ID of the pod (required)- Returns:
- APIpodInspectLibpodRequest
- Http Response Details
Status Code Description Response Headers 200 Inspect pod - 404 No such pod - 500 Internal server error -
-
podKillLibpod
Kill a pod- Parameters:
name- the name or ID of the pod (required)- Returns:
- APIpodKillLibpodRequest
- Http Response Details
Status Code Description Response Headers 200 Kill Pod - 400 Bad parameter in request - 404 No such pod - 409 Kill Pod - 500 Internal server error -
-
podListLibpod
List pods- Returns:
- APIpodListLibpodRequest
- Http Response Details
Status Code Description Response Headers 200 List pods - 400 Bad parameter in request - 500 Internal server error -
-
podPauseLibpod
Pause a pod Pause a pod- Parameters:
name- the name or ID of the pod (required)- Returns:
- APIpodPauseLibpodRequest
- Http Response Details
Status Code Description Response Headers 200 Pause pod - 404 No such pod - 409 Pause pod - 500 Internal server error -
-
podPruneLibpod
Prune unused pods- Returns:
- APIpodPruneLibpodRequest
- Http Response Details
Status Code Description Response Headers 200 Prune pod - 400 Bad parameter in request - 409 pod already exists - 500 Internal server error -
-
podRestartLibpod
Restart a pod- Parameters:
name- the name or ID of the pod (required)- Returns:
- APIpodRestartLibpodRequest
- Http Response Details
Status Code Description Response Headers 200 Restart pod - 404 No such pod - 409 Restart pod - 500 Internal server error -
-
podStartLibpod
Start a pod- Parameters:
name- the name or ID of the pod (required)- Returns:
- APIpodStartLibpodRequest
- Http Response Details
Status Code Description Response Headers 200 Start pod - 304 Pod already started - 404 No such pod - 409 Start pod - 500 Internal server error -
-
podStatsAllLibpod
Statistics for one or more pods Display a live stream of resource usage statistics for the containers in one or more pods- Returns:
- APIpodStatsAllLibpodRequest
- Http Response Details
Status Code Description Response Headers 200 Pod Statistics - 404 No such pod - 500 Internal server error -
-
podStopLibpod
Stop a pod- Parameters:
name- the name or ID of the pod (required)- Returns:
- APIpodStopLibpodRequest
- Http Response Details
Status Code Description Response Headers 200 Stop pod - 304 Pod already stopped - 400 Bad parameter in request - 404 No such pod - 409 Stop pod - 500 Internal server error -
-
podTopLibpod
List processes List processes running inside a pod- Parameters:
name- Name of pod to query for processes (required)- Returns:
- APIpodTopLibpodRequest
- Http Response Details
Status Code Description Response Headers 200 List processes in pod - 404 No such pod - 500 Internal server error -
-
podUnpauseLibpod
Unpause a pod- Parameters:
name- the name or ID of the pod (required)- Returns:
- APIpodUnpauseLibpodRequest
- Http Response Details
Status Code Description Response Headers 200 Unpause pod - 404 No such pod - 409 Unpause pod - 500 Internal server error -
-