Package io.github.alersrt.pod4j.openapi.api

Class VolumesApi

java.lang.Object

io.github.alersrt.pod4j.openapi.api.VolumesApi

public class VolumesApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	VolumesApi.APIvolumeCreateLibpodRequest
class	VolumesApi.APIvolumeDeleteLibpodRequest
class	VolumesApi.APIvolumeExistsLibpodRequest
class	VolumesApi.APIvolumeInspectLibpodRequest
class	VolumesApi.APIvolumeListLibpodRequest
class	VolumesApi.APIvolumePruneLibpodRequest

Constructor Summary

Constructors

Constructor	Description
VolumesApi()
VolumesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)
VolumesApi.APIvolumeCreateLibpodRequest	volumeCreateLibpod()	Create a volume
VolumesApi.APIvolumeDeleteLibpodRequest	volumeDeleteLibpod(String name)	Remove volume
VolumesApi.APIvolumeExistsLibpodRequest	volumeExistsLibpod(String name)	Volume exists Check if a volume exists
VolumesApi.APIvolumeInspectLibpodRequest	volumeInspectLibpod(String name)	Inspect volume
VolumesApi.APIvolumeListLibpodRequest	volumeListLibpod()	List volumes Returns a list of volumes
VolumesApi.APIvolumePruneLibpodRequest	volumePruneLibpod()	Prune volumes

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

VolumesApi

public VolumesApi()

VolumesApi

public VolumesApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

volumeCreateLibpod

public VolumesApi.APIvolumeCreateLibpodRequest volumeCreateLibpod()

Create a volume

Returns:

APIvolumeCreateLibpodRequest

Http Response Details

Status Code	Description	Response Headers
201	Volume details	-
500	Internal server error	-

volumeDeleteLibpod

public VolumesApi.APIvolumeDeleteLibpodRequest volumeDeleteLibpod(String name)

Remove volume

Parameters:

name - the name or ID of the volume (required)

Returns:

APIvolumeDeleteLibpodRequest

Http Response Details

Status Code	Description	Response Headers
204	no error	-
404	No such volume	-
409	Volume is in use and cannot be removed	-
500	Internal server error	-

volumeExistsLibpod

public VolumesApi.APIvolumeExistsLibpodRequest volumeExistsLibpod(String name)

Volume exists Check if a volume exists

Parameters:

name - the name of the volume (required)

Returns:

APIvolumeExistsLibpodRequest

Http Response Details

Status Code	Description	Response Headers
204	volume exists	-
404	No such volume	-
500	Internal server error	-

volumeInspectLibpod

public VolumesApi.APIvolumeInspectLibpodRequest volumeInspectLibpod(String name)

Inspect volume

Parameters:

name - the name or ID of the volume (required)

Returns:

APIvolumeInspectLibpodRequest

Http Response Details

Status Code	Description	Response Headers
200	Volume details	-
404	No such volume	-
500	Internal server error	-

volumeListLibpod

public VolumesApi.APIvolumeListLibpodRequest volumeListLibpod()

List volumes Returns a list of volumes

Returns:

APIvolumeListLibpodRequest

Http Response Details

Status Code	Description	Response Headers
200	Volume list	-
500	Internal server error	-

volumePruneLibpod

public VolumesApi.APIvolumePruneLibpodRequest volumePruneLibpod()

Prune volumes

Returns:

APIvolumePruneLibpodRequest

Http Response Details

Status Code	Description	Response Headers
200	Volume Prune	-
500	Internal server error	-