V1CSIDriverSpec (client-java-api 10.0.2 API)

java.lang.Object
- io.kubernetes.client.openapi.models.V1CSIDriverSpec

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2020-07-29T18:17:00.375Z[Etc/UTC]")
public class V1CSIDriverSpec
extends Object

CSIDriverSpec is the specification of a CSIDriver.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_ATTACH_REQUIRED`
`static String`	`SERIALIZED_NAME_POD_INFO_ON_MOUNT`
`static String`	`SERIALIZED_NAME_VOLUME_LIFECYCLE_MODES`

Constructor Summary

Constructors
Constructor and Description

V1CSIDriverSpec()

Constructors
Constructor and Description
`V1CSIDriverSpec()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`V1CSIDriverSpec`	`addVolumeLifecycleModesItem(String volumeLifecycleModesItem)`
`V1CSIDriverSpec`	`attachRequired(Boolean attachRequired)`
`boolean`	`equals(Object o)`
`Boolean`	`getAttachRequired()` attachRequired indicates this CSI volume driver requires an attach operation (because it implements the CSI ControllerPublishVolume() method), and that the Kubernetes attach detach controller should call the attach volume interface which checks the volumeattachment status and waits until the volume is attached before proceeding to mounting.
`Boolean`	`getPodInfoOnMount()` If set to true, podInfoOnMount indicates this CSI volume driver requires additional pod information (like podName, podUID, etc.) during mount operations.
`List<String>`	`getVolumeLifecycleModes()` volumeLifecycleModes defines what kind of volumes this CSI volume driver supports.
`int`	`hashCode()`
`V1CSIDriverSpec`	`podInfoOnMount(Boolean podInfoOnMount)`
`void`	`setAttachRequired(Boolean attachRequired)`
`void`	`setPodInfoOnMount(Boolean podInfoOnMount)`
`void`	`setVolumeLifecycleModes(List<String> volumeLifecycleModes)`
`String`	`toString()`
`V1CSIDriverSpec`	`volumeLifecycleModes(List<String> volumeLifecycleModes)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - SERIALIZED_NAME_ATTACH_REQUIRED
```
public static final String SERIALIZED_NAME_ATTACH_REQUIRED
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_POD_INFO_ON_MOUNT
```
public static final String SERIALIZED_NAME_POD_INFO_ON_MOUNT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_VOLUME_LIFECYCLE_MODES
```
public static final String SERIALIZED_NAME_VOLUME_LIFECYCLE_MODES
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - V1CSIDriverSpec
```
public V1CSIDriverSpec()
```
- Method Detail
  - attachRequired
```
public V1CSIDriverSpec attachRequired(Boolean attachRequired)
```
  - getAttachRequired
```
@Nullable
public Boolean getAttachRequired()
```
    attachRequired indicates this CSI volume driver requires an attach operation (because it implements the CSI ControllerPublishVolume() method), and that the Kubernetes attach detach controller should call the attach volume interface which checks the volumeattachment status and waits until the volume is attached before proceeding to mounting. The CSI external-attacher coordinates with CSI volume driver and updates the volumeattachment status when the attach operation is complete. If the CSIDriverRegistry feature gate is enabled and the value is specified to false, the attach operation will be skipped. Otherwise the attach operation will be called.
    
    Returns:
    
    attachRequired
  - setAttachRequired
```
public void setAttachRequired(Boolean attachRequired)
```
  - podInfoOnMount
```
public V1CSIDriverSpec podInfoOnMount(Boolean podInfoOnMount)
```
  - getPodInfoOnMount
```
@Nullable
public Boolean getPodInfoOnMount()
```
    If set to true, podInfoOnMount indicates this CSI volume driver requires additional pod information (like podName, podUID, etc.) during mount operations. If set to false, pod information will not be passed on mount. Default is false. The CSI driver specifies podInfoOnMount as part of driver deployment. If true, Kubelet will pass pod information as VolumeContext in the CSI NodePublishVolume() calls. The CSI driver is responsible for parsing and validating the information passed in as VolumeContext. The following VolumeConext will be passed if podInfoOnMount is set to true. This list might grow, but the prefix will be used. \"csi.storage.k8s.io/pod.name\": pod.Name \"csi.storage.k8s.io/pod.namespace\": pod.Namespace \"csi.storage.k8s.io/pod.uid\": string(pod.UID) \"csi.storage.k8s.io/ephemeral\": \"true\" iff the volume is an ephemeral inline volume defined by a CSIVolumeSource, otherwise \"false\" \"csi.storage.k8s.io/ephemeral\" is a new feature in Kubernetes 1.16. It is only required for drivers which support both the \"Persistent\" and \"Ephemeral\" VolumeLifecycleMode. Other drivers can leave pod info disabled and/or ignore this field. As Kubernetes 1.15 doesn't support this field, drivers can only support one mode when deployed on such a cluster and the deployment determines which mode that is, for example via a command line parameter of the driver.
    
    Returns:
    
    podInfoOnMount
  - setPodInfoOnMount
```
public void setPodInfoOnMount(Boolean podInfoOnMount)
```
  - volumeLifecycleModes
```
public V1CSIDriverSpec volumeLifecycleModes(List<String> volumeLifecycleModes)
```
  - addVolumeLifecycleModesItem
```
public V1CSIDriverSpec addVolumeLifecycleModesItem(String volumeLifecycleModesItem)
```
  - getVolumeLifecycleModes
```
@Nullable
public List<String> getVolumeLifecycleModes()
```
    volumeLifecycleModes defines what kind of volumes this CSI volume driver supports. The default if the list is empty is \"Persistent\", which is the usage defined by the CSI specification and implemented in Kubernetes via the usual PV/PVC mechanism. The other mode is \"Ephemeral\". In this mode, volumes are defined inline inside the pod spec with CSIVolumeSource and their lifecycle is tied to the lifecycle of that pod. A driver has to be aware of this because it is only going to get a NodePublishVolume call for such a volume. For more information about implementing this mode, see https://kubernetes-csi.github.io/docs/ephemeral-local-volumes.html A driver can support one or more of these modes and more modes may be added in the future. This field is beta.
    
    Returns:
    
    volumeLifecycleModes
  - setVolumeLifecycleModes
```
public void setVolumeLifecycleModes(List<String> volumeLifecycleModes)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class V1CSIDriverSpec

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_ATTACH_REQUIRED

SERIALIZED_NAME_POD_INFO_ON_MOUNT

SERIALIZED_NAME_VOLUME_LIFECYCLE_MODES

Constructor Detail

V1CSIDriverSpec

Method Detail

attachRequired

getAttachRequired

setAttachRequired

podInfoOnMount

getPodInfoOnMount

setPodInfoOnMount

volumeLifecycleModes

addVolumeLifecycleModesItem

getVolumeLifecycleModes

setVolumeLifecycleModes

equals

hashCode

toString