Package org.apache.hadoop.yarn.csi.client

Interface CsiClient

All Known Implementing Classes:
CsiClientImpl
public interface CsiClient
General interface for a CSI client. This interface defines all APIs that CSI spec supports, including both identity/controller/node service APIs.

  • Method Summary

    Modifier and Type
    Method
    Description
    csi.v0.Csi.GetPluginInfoResponse
    getPluginInfo()
    Gets some basic info about the CSI plugin, including the driver name, version and optionally some manifest info.
    csi.v0.Csi.NodePublishVolumeResponse
    nodePublishVolume(csi.v0.Csi.NodePublishVolumeRequest request)
     
    csi.v0.Csi.NodeUnpublishVolumeResponse
    nodeUnpublishVolume(csi.v0.Csi.NodeUnpublishVolumeRequest request)
     
    csi.v0.Csi.ValidateVolumeCapabilitiesResponse
    validateVolumeCapabilities(csi.v0.Csi.ValidateVolumeCapabilitiesRequest request)
     

  • Method Details

    • getPluginInfo

      csi.v0.Csi.GetPluginInfoResponse getPluginInfo() throws IOException
      Gets some basic info about the CSI plugin, including the driver name, version and optionally some manifest info.
      Returns:
      Csi.GetPluginInfoResponse
      Throws:
      IOException - when unable to get plugin info from the driver.

    • validateVolumeCapabilities

      csi.v0.Csi.ValidateVolumeCapabilitiesResponse validateVolumeCapabilities(csi.v0.Csi.ValidateVolumeCapabilitiesRequest request) throws IOException
      Throws:
      IOException

    • nodePublishVolume

      csi.v0.Csi.NodePublishVolumeResponse nodePublishVolume(csi.v0.Csi.NodePublishVolumeRequest request) throws IOException
      Throws:
      IOException

    • nodeUnpublishVolume

      csi.v0.Csi.NodeUnpublishVolumeResponse nodeUnpublishVolume(csi.v0.Csi.NodeUnpublishVolumeRequest request) throws IOException
      Throws:
      IOException