Struct NodePublishVolumeRequest 

pub struct NodePublishVolumeRequest {
    pub volume_id: String,
    pub publish_context: BTreeMap<String, String>,
    pub staging_target_path: String,
    pub target_path: String,
    pub volume_capability: Option<VolumeCapability>,
    pub readonly: bool,
    pub secrets: BTreeMap<String, String>,
    pub volume_context: BTreeMap<String, String>,
}

Fields

volume_id: String

The ID of the volume to publish. This field is REQUIRED.

publish_context: BTreeMap<String, String>

The CO SHALL set this field to the value returned by ControllerPublishVolume if the corresponding Controller Plugin has PUBLISH_UNPUBLISH_VOLUME controller capability, and SHALL be left unset if the corresponding Controller Plugin does not have this capability. This is an OPTIONAL field.

staging_target_path: String

The path to which the volume was staged by NodeStageVolume. It MUST be an absolute path in the root filesystem of the process serving this request. It MUST be set if the Node Plugin implements the STAGE_UNSTAGE_VOLUME node capability. This is an OPTIONAL field.

target_path: String

The path to which the volume will be published. It MUST be an absolute path in the root filesystem of the process serving this request. The CO SHALL ensure uniqueness of target_path per volume. The CO SHALL ensure that the parent directory of this path exists and that the process serving the request has read and write permissions to that parent directory. For volumes with an access type of block, the SP SHALL place the block device at target_path. For volumes with an access type of mount, the SP SHALL place the mounted directory at target_path. Creation of target_path is the responsibility of the SP. This is a REQUIRED field.

volume_capability: Option<VolumeCapability>

Volume capability describing how the CO intends to use this volume. SP MUST ensure the CO can use the published volume as described. Otherwise SP MUST return the appropriate gRPC error code. This is a REQUIRED field.

readonly: bool

Indicates SP MUST publish the volume in readonly mode. This field is REQUIRED.

secrets: BTreeMap<String, String>

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

volume_context: BTreeMap<String, String>

Volume context as returned by SP in CreateVolumeResponse.Volume.volume_context. This field is OPTIONAL and MUST match the volume_context of the volume identified by volume_id.

Trait Implementations

impl Clone for NodePublishVolumeRequest

fn clone(&self) -> NodePublishVolumeRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NodePublishVolumeRequest

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

Formats the value using the given formatter.

impl Default for NodePublishVolumeRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for NodePublishVolumeRequest

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 NodePublishVolumeRequest

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