class

Docr::Endpoints::Volumes

Inherits Reference / Object

The Volumes class provides methods to interact with volume-related endpoints. This class uses the client to send requests to the server and handles responses.

Constructors

new(client : Docr::Client)

Initializes a new Volumes instance with the provided client.

Source

Instance methods

client

A client instance used for making requests.

Source

Creates a new volume based on the provided configuration.

  • config: The configuration for creating the volume.

Returns the created volume.

Source
delete(name : String, force : Bool = false)

Deletes a specific volume by its name.

  • name: The name of the volume to delete.
  • force: (Optional) Force deletion if true. Default is false.

Does not return any specific value.

Source
inspect(name : String) : Docr::Types::Volume

Inspects a specific volume by its name.

  • name: The name of the volume to inspect.

Returns details about the specified volume.

Source
list

Retrieves a list of volumes.

Returns a response containing a list of volumes.

Source