V1CSIDriverSpec (client-java-api 12.0.0 API)

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

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2021-01-04T09:55:14.976Z[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_FS_GROUP_POLICY`
`static String`	`SERIALIZED_NAME_POD_INFO_ON_MOUNT`
`static String`	`SERIALIZED_NAME_REQUIRES_REPUBLISH`
`static String`	`SERIALIZED_NAME_STORAGE_CAPACITY`
`static String`	`SERIALIZED_NAME_TOKEN_REQUESTS`
`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`	`addTokenRequestsItem(StorageV1TokenRequest tokenRequestsItem)`
`V1CSIDriverSpec`	`addVolumeLifecycleModesItem(String volumeLifecycleModesItem)`
`V1CSIDriverSpec`	`attachRequired(Boolean attachRequired)`
`boolean`	`equals(Object o)`
`V1CSIDriverSpec`	`fsGroupPolicy(String fsGroupPolicy)`
`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.
`String`	`getFsGroupPolicy()` Defines if the underlying volume supports changing ownership and permission of the volume before being mounted.
`Boolean`	`getPodInfoOnMount()` If set to true, podInfoOnMount indicates this CSI volume driver requires additional pod information (like podName, podUID, etc.) during mount operations.
`Boolean`	`getRequiresRepublish()` RequiresRepublish indicates the CSI driver wants `NodePublishVolume` being periodically called to reflect any possible change in the mounted volume.
`Boolean`	`getStorageCapacity()` If set to true, storageCapacity indicates that the CSI volume driver wants pod scheduling to consider the storage capacity that the driver deployment will report by creating CSIStorageCapacity objects with capacity information.
`List<StorageV1TokenRequest>`	`getTokenRequests()` TokenRequests indicates the CSI driver needs pods' service account tokens it is mounting volume for to do necessary authentication.
`List<String>`	`getVolumeLifecycleModes()` volumeLifecycleModes defines what kind of volumes this CSI volume driver supports.
`int`	`hashCode()`
`V1CSIDriverSpec`	`podInfoOnMount(Boolean podInfoOnMount)`
`V1CSIDriverSpec`	`requiresRepublish(Boolean requiresRepublish)`
`void`	`setAttachRequired(Boolean attachRequired)`
`void`	`setFsGroupPolicy(String fsGroupPolicy)`
`void`	`setPodInfoOnMount(Boolean podInfoOnMount)`
`void`	`setRequiresRepublish(Boolean requiresRepublish)`
`void`	`setStorageCapacity(Boolean storageCapacity)`
`void`	`setTokenRequests(List<StorageV1TokenRequest> tokenRequests)`
`void`	`setVolumeLifecycleModes(List<String> volumeLifecycleModes)`
`V1CSIDriverSpec`	`storageCapacity(Boolean storageCapacity)`
`V1CSIDriverSpec`	`tokenRequests(List<StorageV1TokenRequest> tokenRequests)`
`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_FS_GROUP_POLICY
```
public static final String SERIALIZED_NAME_FS_GROUP_POLICY
```
    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_REQUIRES_REPUBLISH
```
public static final String SERIALIZED_NAME_REQUIRES_REPUBLISH
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_STORAGE_CAPACITY
```
public static final String SERIALIZED_NAME_STORAGE_CAPACITY
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TOKEN_REQUESTS
```
public static final String SERIALIZED_NAME_TOKEN_REQUESTS
```
    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)
```
  - fsGroupPolicy
```
public V1CSIDriverSpec fsGroupPolicy(String fsGroupPolicy)
```
  - getFsGroupPolicy
```
@Nullable
public String getFsGroupPolicy()
```
    Defines if the underlying volume supports changing ownership and permission of the volume before being mounted. Refer to the specific FSGroupPolicy values for additional details. This field is alpha-level, and is only honored by servers that enable the CSIVolumeFSGroupPolicy feature gate.
    
    Returns:
    
    fsGroupPolicy
  - setFsGroupPolicy
```
public void setFsGroupPolicy(String fsGroupPolicy)
```
  - 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)
```
  - requiresRepublish
```
public V1CSIDriverSpec requiresRepublish(Boolean requiresRepublish)
```
  - getRequiresRepublish
```
@Nullable
public Boolean getRequiresRepublish()
```
    RequiresRepublish indicates the CSI driver wants `NodePublishVolume` being periodically called to reflect any possible change in the mounted volume. This field defaults to false. Note: After a successful initial NodePublishVolume call, subsequent calls to NodePublishVolume should only update the contents of the volume. New mount points will not be seen by a running container. This is an alpha feature and only available when the CSIServiceAccountToken feature is enabled.
    
    Returns:
    
    requiresRepublish
  - setRequiresRepublish
```
public void setRequiresRepublish(Boolean requiresRepublish)
```
  - storageCapacity
```
public V1CSIDriverSpec storageCapacity(Boolean storageCapacity)
```
  - getStorageCapacity
```
@Nullable
public Boolean getStorageCapacity()
```
    If set to true, storageCapacity indicates that the CSI volume driver wants pod scheduling to consider the storage capacity that the driver deployment will report by creating CSIStorageCapacity objects with capacity information. The check can be enabled immediately when deploying a driver. In that case, provisioning new volumes with late binding will pause until the driver deployment has published some suitable CSIStorageCapacity object. Alternatively, the driver can be deployed with the field unset or false and it can be flipped later when storage capacity information has been published. This is an alpha field and only available when the CSIStorageCapacity feature is enabled. The default is false.
    
    Returns:
    
    storageCapacity
  - setStorageCapacity
```
public void setStorageCapacity(Boolean storageCapacity)
```
  - tokenRequests
```
public V1CSIDriverSpec tokenRequests(List<StorageV1TokenRequest> tokenRequests)
```
  - addTokenRequestsItem
```
public V1CSIDriverSpec addTokenRequestsItem(StorageV1TokenRequest tokenRequestsItem)
```
  - getTokenRequests
```
@Nullable
public List<StorageV1TokenRequest> getTokenRequests()
```
    TokenRequests indicates the CSI driver needs pods' service account tokens it is mounting volume for to do necessary authentication. Kubelet will pass the tokens in VolumeContext in the CSI NodePublishVolume calls. The CSI driver should parse and validate the following VolumeContext: \"csi.storage.k8s.io/serviceAccount.tokens\": { \"<audience>\": { \"token\": <token>, \"expirationTimestamp\": <expiration timestamp in RFC3339>, }, ... } Note: Audience in each TokenRequest should be different and at most one token is empty string. To receive a new token after expiry, RequiresRepublish can be used to trigger NodePublishVolume periodically. This is an alpha feature and only available when the CSIServiceAccountToken feature is enabled.
    
    Returns:
    
    tokenRequests
  - setTokenRequests
```
public void setTokenRequests(List<StorageV1TokenRequest> tokenRequests)
```
  - 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_FS_GROUP_POLICY

SERIALIZED_NAME_POD_INFO_ON_MOUNT

SERIALIZED_NAME_REQUIRES_REPUBLISH

SERIALIZED_NAME_STORAGE_CAPACITY

SERIALIZED_NAME_TOKEN_REQUESTS

SERIALIZED_NAME_VOLUME_LIFECYCLE_MODES

Constructor Detail

V1CSIDriverSpec

Method Detail

attachRequired

getAttachRequired

setAttachRequired

fsGroupPolicy

getFsGroupPolicy

setFsGroupPolicy

podInfoOnMount

getPodInfoOnMount

setPodInfoOnMount

requiresRepublish

getRequiresRepublish

setRequiresRepublish

storageCapacity

getStorageCapacity

setStorageCapacity

tokenRequests

addTokenRequestsItem

getTokenRequests

setTokenRequests

volumeLifecycleModes

addVolumeLifecycleModesItem

getVolumeLifecycleModes

setVolumeLifecycleModes

equals

hashCode

toString