Struct Volume 

pub struct Volume {
    pub capacity_bytes: i64,
    pub volume_id: String,
    pub volume_context: BTreeMap<String, String>,
    pub content_source: Option<VolumeContentSource>,
    pub accessible_topology: Vec<Topology>,
}

Information about a specific volume.

Fields

capacity_bytes: i64

The capacity of the volume in bytes. This field is OPTIONAL. If not set (value of 0), it indicates that the capacity of the volume is unknown (e.g., NFS share). The value of this field MUST NOT be negative.

volume_id: String

The identifier for this volume, generated by the plugin. This field is REQUIRED. This field MUST contain enough information to uniquely identify this specific volume vs all other volumes supported by this plugin. This field SHALL be used by the CO in subsequent calls to refer to this volume. The SP is NOT responsible for global uniqueness of volume_id across multiple SPs.

volume_context: BTreeMap<String, String>

Opaque static properties of the volume. SP MAY use this field to ensure subsequent volume validation and publishing calls have contextual information. The contents of this field SHALL be opaque to a CO. The contents of this field SHALL NOT be mutable. The contents of this field SHALL be safe for the CO to cache. The contents of this field SHOULD NOT contain sensitive information. The contents of this field SHOULD NOT be used for uniquely identifying a volume. The volume_id alone SHOULD be sufficient to identify the volume. A volume uniquely identified by volume_id SHALL always report the same volume_context. This field is OPTIONAL and when present MUST be passed to volume validation and publishing calls.

content_source: Option<VolumeContentSource>

If specified, indicates that the volume is not empty and is pre-populated with data from the specified source. This field is OPTIONAL.

accessible_topology: Vec<Topology>

Specifies where (regions, zones, racks, etc.) the provisioned volume is accessible from. A plugin that returns this field MUST also set the VOLUME_ACCESSIBILITY_CONSTRAINTS plugin capability. An SP MAY specify multiple topologies to indicate the volume is accessible from multiple locations. COs MAY use this information along with the topology information returned by NodeGetInfo to ensure that a given volume is accessible from a given node when scheduling workloads. This field is OPTIONAL. If it is not specified, the CO MAY assume the volume is equally accessible from all nodes in the cluster and MAY schedule workloads referencing the volume on any available node.

Example 1: accessible_topology = {“region”: “R1”, “zone”: “Z2”} Indicates a volume accessible only from the “region” “R1” and the “zone” “Z2”.

Example 2: accessible_topology = {“region”: “R1”, “zone”: “Z2”}, {“region”: “R1”, “zone”: “Z3”} Indicates a volume accessible from both “zone” “Z2” and “zone” “Z3” in the “region” “R1”.

Trait Implementations

impl Clone for Volume

fn clone(&self) -> Volume

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Volume

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Volume

fn default() -> Self

Returns the “default value” for a type.

impl Message for Volume

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Volume

fn eq(&self, other: &Volume) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Volume