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

Class CsiClientImpl

java.lang.Object

org.apache.hadoop.yarn.csi.client.CsiClientImpl

All Implemented Interfaces:

CsiClient

public class CsiClientImpl
extends java.lang.Object
implements CsiClient

A CSI client implementation that communicates with a CSI driver via unix domain socket. It leverages gRPC blocking stubs to synchronize the call with CSI driver. CSI spec is designed as a set of synchronized APIs, in order to make the call idempotent for failure recovery, so the client does the same.

Constructor Summary

Constructors

Constructor	Description
CsiClientImpl(java.lang.String address)

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)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CsiClientImpl

public CsiClientImpl(java.lang.String address)

Method Detail

getPluginInfo

public csi.v0.Csi.GetPluginInfoResponse getPluginInfo()
                                               throws java.io.IOException

Description copied from interface: CsiClient

Gets some basic info about the CSI plugin, including the driver name, version and optionally some manifest info.

Specified by:

getPluginInfo in interface CsiClient

Returns:

Csi.GetPluginInfoResponse

Throws:

java.io.IOException - when unable to get plugin info from the driver.

validateVolumeCapabilities

public csi.v0.Csi.ValidateVolumeCapabilitiesResponse validateVolumeCapabilities(csi.v0.Csi.ValidateVolumeCapabilitiesRequest request)
                                                                         throws java.io.IOException

Specified by:

validateVolumeCapabilities in interface CsiClient

Throws:

java.io.IOException

nodePublishVolume

public csi.v0.Csi.NodePublishVolumeResponse nodePublishVolume(csi.v0.Csi.NodePublishVolumeRequest request)
                                                       throws java.io.IOException

Specified by:

nodePublishVolume in interface CsiClient

Throws:

java.io.IOException

nodeUnpublishVolume

public csi.v0.Csi.NodeUnpublishVolumeResponse nodeUnpublishVolume(csi.v0.Csi.NodeUnpublishVolumeRequest request)
                                                           throws java.io.IOException

Specified by:

nodeUnpublishVolume in interface CsiClient

Throws:

java.io.IOException