GetDynamicHostVolumeResult

data class GetDynamicHostVolumeResult(val capabilities: List<GetDynamicHostVolumeCapability>, val capacity: String, val capacityBytes: Int, val capacityMax: String, val capacityMaxBytes: Int, val capacityMin: String, val capacityMinBytes: Int, val constraints: List<GetDynamicHostVolumeConstraint>, val hostPath: String, val id: String, val name: String, val namespace: String? = null, val nodeId: String, val nodePool: String, val parameters: Map<String, String>, val pluginId: String, val state: String)

A collection of values returned by getDynamicHostVolume.

Constructors

Link copied to clipboard
constructor(capabilities: List<GetDynamicHostVolumeCapability>, capacity: String, capacityBytes: Int, capacityMax: String, capacityMaxBytes: Int, capacityMin: String, capacityMinBytes: Int, constraints: List<GetDynamicHostVolumeConstraint>, hostPath: String, id: String, name: String, namespace: String? = null, nodeId: String, nodePool: String, parameters: Map<String, String>, pluginId: String, state: String)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

(block) - Option for validating the capability of a volume. Each capability block has the following attributes:

Link copied to clipboard

(string) - The size of the volume, in human-friendly format (ex. 10 GiB)

Link copied to clipboard

(int) - The size of the volume, in bytes.

Link copied to clipboard

(string) - The requested maximum capacity of the volume, in human-friendly format (ex. 10 GiB).

Link copied to clipboard

(string) - The requested maximum capacity of the volume, in bytes.

Link copied to clipboard

(string) - The requested minimum capacity of the volume, in human-friendly format (ex. 10 GiB).

Link copied to clipboard

(string) - The requested minimum capacity of the volume, in bytes.

Link copied to clipboard

(block) - The restrictions used to place the volume on a node, similar to the `constraint` block on a Nomad job specification. A volume may have multiple constraint blocks. Each constraint block has the following attributes.

Link copied to clipboard

(string) - The path on disk where the volume exists.

Link copied to clipboard
val id: String
Link copied to clipboard

(string) - The name of the volume, which is used as the volume_source field in job specifications that claim this volume. Host volume names are be unique per node. Names are visible to any user with node:read ACL, even across namespaces, so they should not be treated as sensitive values.

Link copied to clipboard
val namespace: String? = null

(string) - The namespace of the volume.

Link copied to clipboard

(string) - A specific node where the volume is mounted.

Link copied to clipboard

(string: <optional>) - The node pool of the node where the volume is mounted.

Link copied to clipboard

(map<string|string>) - A key-value map of strings passed directly to the plugin to configure the volume. The details of these parameters are specific to the plugin.

Link copied to clipboard

(string: <required>) - The ID of the dhv_plugin that manages this volume.

Link copied to clipboard