Struct CreateVolumeRequest 

pub struct CreateVolumeRequest {
    pub name: String,
    pub capacity_range: Option<CapacityRange>,
    pub volume_capabilities: Vec<VolumeCapability>,
    pub parameters: BTreeMap<String, String>,
    pub secrets: BTreeMap<String, String>,
    pub volume_content_source: Option<VolumeContentSource>,
    pub accessibility_requirements: Option<TopologyRequirement>,
}

Fields

name: String

The suggested name for the storage space. This field is REQUIRED. It serves two purposes:

1. Idempotency - This name is generated by the CO to achieve idempotency. The Plugin SHOULD ensure that multiple CreateVolume calls for the same name do not result in more than one piece of storage provisioned corresponding to that name. If a Plugin is unable to enforce idempotency, the CO’s error recovery logic could result in multiple (unused) volumes being provisioned. In the case of error, the CO MUST handle the gRPC error codes per the recovery behavior defined in the “CreateVolume Errors” section below. The CO is responsible for cleaning up volumes it provisioned that it no longer needs. If the CO is uncertain whether a volume was provisioned or not when a CreateVolume call fails, the CO MAY call CreateVolume again, with the same name, to ensure the volume exists and to retrieve the volume’s volume_id (unless otherwise prohibited by “CreateVolume Errors”).
2. Suggested name - Some storage systems allow callers to specify an identifier by which to refer to the newly provisioned storage. If a storage system supports this, it can optionally use this name as the identifier for the new volume. Any Unicode string that conforms to the length limit is allowed except those containing the following banned characters: U+0000-U+0008, U+000B, U+000C, U+000E-U+001F, U+007F-U+009F. (These are control characters other than commonly used whitespace.)

capacity_range: Option<CapacityRange>

This field is OPTIONAL. This allows the CO to specify the capacity requirement of the volume to be provisioned. If not specified, the Plugin MAY choose an implementation-defined capacity range. If specified it MUST always be honored, even when creating volumes from a source; which MAY force some backends to internally extend the volume after creating it.

volume_capabilities: Vec<VolumeCapability>

The capabilities that the provisioned volume MUST have. SP MUST provision a volume that will satisfy ALL of the capabilities specified in this list. Otherwise SP MUST return the appropriate gRPC error code. The Plugin MUST assume that the CO MAY use the provisioned volume with ANY of the capabilities specified in this list. For example, a CO MAY specify two volume capabilities: one with access mode SINGLE_NODE_WRITER and another with access mode MULTI_NODE_READER_ONLY. In this case, the SP MUST verify that the provisioned volume can be used in either mode. This also enables the CO to do early validation: If ANY of the specified volume capabilities are not supported by the SP, the call MUST return the appropriate gRPC error code. This field is REQUIRED.

parameters: BTreeMap<String, String>

Plugin specific parameters passed in as opaque key-value pairs. This field is OPTIONAL. The Plugin is responsible for parsing and validating these parameters. COs will treat these as opaque.

secrets: BTreeMap<String, String>

Secrets required by plugin to complete volume creation request. This field is OPTIONAL. Refer to the Secrets Requirements section on how to use this field.

volume_content_source: Option<VolumeContentSource>

If specified, the new volume will be pre-populated with data from this source. This field is OPTIONAL.

accessibility_requirements: Option<TopologyRequirement>

Specifies where (regions, zones, racks, etc.) the provisioned volume MUST be accessible from. An SP SHALL advertise the requirements for topological accessibility information in documentation. COs SHALL only specify topological accessibility information supported by the SP. This field is OPTIONAL. This field SHALL NOT be specified unless the SP has the VOLUME_ACCESSIBILITY_CONSTRAINTS plugin capability. If this field is not specified and the SP has the VOLUME_ACCESSIBILITY_CONSTRAINTS plugin capability, the SP MAY choose where the provisioned volume is accessible from.

Trait Implementations

impl Clone for CreateVolumeRequest

fn clone(&self) -> CreateVolumeRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateVolumeRequest

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

Formats the value using the given formatter.

impl Default for CreateVolumeRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for CreateVolumeRequest

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 CreateVolumeRequest

fn eq(&self, other: &CreateVolumeRequest) -> 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 CreateVolumeRequest