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

Class VolumesCompatApi

java.lang.Object

io.github.alersrt.pod4j.openapi.api.VolumesCompatApi

public class VolumesCompatApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	VolumesCompatApi.APIvolumeCreateRequest
class	VolumesCompatApi.APIvolumeDeleteRequest
class	VolumesCompatApi.APIvolumeInspectRequest
class	VolumesCompatApi.APIvolumeListRequest
class	VolumesCompatApi.APIvolumePruneRequest

Constructor Summary

Constructors

Constructor	Description
VolumesCompatApi()
VolumesCompatApi(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)
VolumesCompatApi.APIvolumeCreateRequest	volumeCreate()	Create a volume
VolumesCompatApi.APIvolumeDeleteRequest	volumeDelete(String name)	Remove volume
VolumesCompatApi.APIvolumeInspectRequest	volumeInspect(String name)	Inspect volume
VolumesCompatApi.APIvolumeListRequest	volumeList()	List volumes Returns a list of volume
VolumesCompatApi.APIvolumePruneRequest	volumePrune()	Prune volumes

Methods inherited from class java.lang.Object

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

Constructor Details

VolumesCompatApi

public VolumesCompatApi()

VolumesCompatApi

public VolumesCompatApi(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)

volumeCreate

public VolumesCompatApi.APIvolumeCreateRequest volumeCreate()

Create a volume

Returns:

APIvolumeCreateRequest

Http Response Details

Status Code	Description	Response Headers
201	This response definition is used for both the create and inspect endpoints	-
500	Internal server error	-

volumeDelete

public VolumesCompatApi.APIvolumeDeleteRequest volumeDelete(String name)

Remove volume

Parameters:

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

Returns:

APIvolumeDeleteRequest

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	-

volumeInspect

public VolumesCompatApi.APIvolumeInspectRequest volumeInspect(String name)

Inspect volume

Parameters:

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

Returns:

APIvolumeInspectRequest

Http Response Details

Status Code	Description	Response Headers
200	This response definition is used for both the create and inspect endpoints	-
500	Internal server error	-

volumeList

public VolumesCompatApi.APIvolumeListRequest volumeList()

List volumes Returns a list of volume

Returns:

APIvolumeListRequest

Http Response Details

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

volumePrune

public VolumesCompatApi.APIvolumePruneRequest volumePrune()

Prune volumes

Returns:

APIvolumePruneRequest

Http Response Details

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