Package k8s.io.api.core.v1

Interface Generated.PersistentVolumeClaimSpecOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getAccessModes​(int index)
      accessModes contains the desired access modes the volume should have.
      com.google.protobuf.ByteString getAccessModesBytes​(int index)
      accessModes contains the desired access modes the volume should have.
      int getAccessModesCount()
      accessModes contains the desired access modes the volume should have.
      List<String> getAccessModesList()
      accessModes contains the desired access modes the volume should have.
      Generated.TypedLocalObjectReference getDataSource()
      dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source.
      Generated.TypedLocalObjectReferenceOrBuilder getDataSourceOrBuilder()
      dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source.
      Generated.TypedObjectReference getDataSourceRef()
      dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired.
      Generated.TypedObjectReferenceOrBuilder getDataSourceRefOrBuilder()
      dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired.
      Generated.VolumeResourceRequirements getResources()
      resources represents the minimum resources the volume should have.
      Generated.VolumeResourceRequirementsOrBuilder getResourcesOrBuilder()
      resources represents the minimum resources the volume should have.
      Generated.LabelSelector getSelector()
      selector is a label query over volumes to consider for binding.
      Generated.LabelSelectorOrBuilder getSelectorOrBuilder()
      selector is a label query over volumes to consider for binding.
      String getStorageClassName()
      storageClassName is the name of the StorageClass required by the claim.
      com.google.protobuf.ByteString getStorageClassNameBytes()
      storageClassName is the name of the StorageClass required by the claim.
      String getVolumeAttributesClassName()
      volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.
      com.google.protobuf.ByteString getVolumeAttributesClassNameBytes()
      volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.
      String getVolumeMode()
      volumeMode defines what type of volume is required by the claim.
      com.google.protobuf.ByteString getVolumeModeBytes()
      volumeMode defines what type of volume is required by the claim.
      String getVolumeName()
      volumeName is the binding reference to the PersistentVolume backing this claim.
      com.google.protobuf.ByteString getVolumeNameBytes()
      volumeName is the binding reference to the PersistentVolume backing this claim.
      boolean hasDataSource()
      dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source.
      boolean hasDataSourceRef()
      dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired.
      boolean hasResources()
      resources represents the minimum resources the volume should have.
      boolean hasSelector()
      selector is a label query over volumes to consider for binding.
      boolean hasStorageClassName()
      storageClassName is the name of the StorageClass required by the claim.
      boolean hasVolumeAttributesClassName()
      volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.
      boolean hasVolumeMode()
      volumeMode defines what type of volume is required by the claim.
      boolean hasVolumeName()
      volumeName is the binding reference to the PersistentVolume backing this claim.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getAccessModesList

        List<String> getAccessModesList()
         accessModes contains the desired access modes the volume should have.
 More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
 +optional
 +listType=atomic
        repeated string accessModes = 1;
        Returns:
        A list containing the accessModes.

      • getAccessModesCount

        int getAccessModesCount()
         accessModes contains the desired access modes the volume should have.
 More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
 +optional
 +listType=atomic
        repeated string accessModes = 1;
        Returns:
        The count of accessModes.

      • getAccessModes

        String getAccessModes​(int index)
         accessModes contains the desired access modes the volume should have.
 More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
 +optional
 +listType=atomic
        repeated string accessModes = 1;
        Parameters:
        index - The index of the element to return.
        Returns:
        The accessModes at the given index.

      • getAccessModesBytes

        com.google.protobuf.ByteString getAccessModesBytes​(int index)
         accessModes contains the desired access modes the volume should have.
 More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
 +optional
 +listType=atomic
        repeated string accessModes = 1;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the accessModes at the given index.

      • hasSelector

        boolean hasSelector()
         selector is a label query over volumes to consider for binding.
 +optional
        optional .k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector selector = 4;
        Returns:
        Whether the selector field is set.

      • getSelector

        Generated.LabelSelector getSelector()
         selector is a label query over volumes to consider for binding.
 +optional
        optional .k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector selector = 4;
        Returns:
        The selector.

      • getSelectorOrBuilder

        Generated.LabelSelectorOrBuilder getSelectorOrBuilder()
         selector is a label query over volumes to consider for binding.
 +optional
        optional .k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector selector = 4;

      • hasResources

        boolean hasResources()
         resources represents the minimum resources the volume should have.
 If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements
 that are lower than previous value but must still be higher than capacity recorded in the
 status field of the claim.
 More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
 +optional
        optional .k8s.io.api.core.v1.VolumeResourceRequirements resources = 2;
        Returns:
        Whether the resources field is set.

      • getResources

        Generated.VolumeResourceRequirements getResources()
         resources represents the minimum resources the volume should have.
 If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements
 that are lower than previous value but must still be higher than capacity recorded in the
 status field of the claim.
 More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
 +optional
        optional .k8s.io.api.core.v1.VolumeResourceRequirements resources = 2;
        Returns:
        The resources.

      • getResourcesOrBuilder

        Generated.VolumeResourceRequirementsOrBuilder getResourcesOrBuilder()
         resources represents the minimum resources the volume should have.
 If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements
 that are lower than previous value but must still be higher than capacity recorded in the
 status field of the claim.
 More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
 +optional
        optional .k8s.io.api.core.v1.VolumeResourceRequirements resources = 2;

      • hasVolumeName

        boolean hasVolumeName()
         volumeName is the binding reference to the PersistentVolume backing this claim.
 +optional
        optional string volumeName = 3;
        Returns:
        Whether the volumeName field is set.

      • getVolumeName

        String getVolumeName()
         volumeName is the binding reference to the PersistentVolume backing this claim.
 +optional
        optional string volumeName = 3;
        Returns:
        The volumeName.

      • getVolumeNameBytes

        com.google.protobuf.ByteString getVolumeNameBytes()
         volumeName is the binding reference to the PersistentVolume backing this claim.
 +optional
        optional string volumeName = 3;
        Returns:
        The bytes for volumeName.

      • hasStorageClassName

        boolean hasStorageClassName()
         storageClassName is the name of the StorageClass required by the claim.
 More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
 +optional
        optional string storageClassName = 5;
        Returns:
        Whether the storageClassName field is set.

      • getStorageClassName

        String getStorageClassName()
         storageClassName is the name of the StorageClass required by the claim.
 More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
 +optional
        optional string storageClassName = 5;
        Returns:
        The storageClassName.

      • getStorageClassNameBytes

        com.google.protobuf.ByteString getStorageClassNameBytes()
         storageClassName is the name of the StorageClass required by the claim.
 More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
 +optional
        optional string storageClassName = 5;
        Returns:
        The bytes for storageClassName.

      • hasVolumeMode

        boolean hasVolumeMode()
         volumeMode defines what type of volume is required by the claim.
 Value of Filesystem is implied when not included in claim spec.
 +optional
        optional string volumeMode = 6;
        Returns:
        Whether the volumeMode field is set.

      • getVolumeMode

        String getVolumeMode()
         volumeMode defines what type of volume is required by the claim.
 Value of Filesystem is implied when not included in claim spec.
 +optional
        optional string volumeMode = 6;
        Returns:
        The volumeMode.

      • getVolumeModeBytes

        com.google.protobuf.ByteString getVolumeModeBytes()
         volumeMode defines what type of volume is required by the claim.
 Value of Filesystem is implied when not included in claim spec.
 +optional
        optional string volumeMode = 6;
        Returns:
        The bytes for volumeMode.

      • hasDataSource

        boolean hasDataSource()
         dataSource field can be used to specify either:
 * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
 * An existing PVC (PersistentVolumeClaim)
 If the provisioner or an external controller can support the specified data source,
 it will create a new volume based on the contents of the specified data source.
 When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,
 and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.
 If the namespace is specified, then dataSourceRef will not be copied to dataSource.
 +optional
        optional .k8s.io.api.core.v1.TypedLocalObjectReference dataSource = 7;
        Returns:
        Whether the dataSource field is set.

      • getDataSource

        Generated.TypedLocalObjectReference getDataSource()
         dataSource field can be used to specify either:
 * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
 * An existing PVC (PersistentVolumeClaim)
 If the provisioner or an external controller can support the specified data source,
 it will create a new volume based on the contents of the specified data source.
 When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,
 and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.
 If the namespace is specified, then dataSourceRef will not be copied to dataSource.
 +optional
        optional .k8s.io.api.core.v1.TypedLocalObjectReference dataSource = 7;
        Returns:
        The dataSource.

      • getDataSourceOrBuilder

        Generated.TypedLocalObjectReferenceOrBuilder getDataSourceOrBuilder()
         dataSource field can be used to specify either:
 * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
 * An existing PVC (PersistentVolumeClaim)
 If the provisioner or an external controller can support the specified data source,
 it will create a new volume based on the contents of the specified data source.
 When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,
 and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.
 If the namespace is specified, then dataSourceRef will not be copied to dataSource.
 +optional
        optional .k8s.io.api.core.v1.TypedLocalObjectReference dataSource = 7;

      • hasDataSourceRef

        boolean hasDataSourceRef()
         dataSourceRef specifies the object from which to populate the volume with data, if a non-empty
 volume is desired. This may be any object from a non-empty API group (non
 core object) or a PersistentVolumeClaim object.
 When this field is specified, volume binding will only succeed if the type of
 the specified object matches some installed volume populator or dynamic
 provisioner.
 This field will replace the functionality of the dataSource field and as such
 if both fields are non-empty, they must have the same value. For backwards
 compatibility, when namespace isn't specified in dataSourceRef,
 both fields (dataSource and dataSourceRef) will be set to the same
 value automatically if one of them is empty and the other is non-empty.
 When namespace is specified in dataSourceRef,
 dataSource isn't set to the same value and must be empty.
 There are three important differences between dataSource and dataSourceRef:
 * While dataSource only allows two specific types of objects, dataSourceRef
   allows any non-core object, as well as PersistentVolumeClaim objects.
 * While dataSource ignores disallowed values (dropping them), dataSourceRef
   preserves all values, and generates an error if a disallowed value is
   specified.
 * While dataSource only allows local objects, dataSourceRef allows objects
   in any namespaces.
 (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.
 (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
 +optional
        optional .k8s.io.api.core.v1.TypedObjectReference dataSourceRef = 8;
        Returns:
        Whether the dataSourceRef field is set.

      • getDataSourceRef

        Generated.TypedObjectReference getDataSourceRef()
         dataSourceRef specifies the object from which to populate the volume with data, if a non-empty
 volume is desired. This may be any object from a non-empty API group (non
 core object) or a PersistentVolumeClaim object.
 When this field is specified, volume binding will only succeed if the type of
 the specified object matches some installed volume populator or dynamic
 provisioner.
 This field will replace the functionality of the dataSource field and as such
 if both fields are non-empty, they must have the same value. For backwards
 compatibility, when namespace isn't specified in dataSourceRef,
 both fields (dataSource and dataSourceRef) will be set to the same
 value automatically if one of them is empty and the other is non-empty.
 When namespace is specified in dataSourceRef,
 dataSource isn't set to the same value and must be empty.
 There are three important differences between dataSource and dataSourceRef:
 * While dataSource only allows two specific types of objects, dataSourceRef
   allows any non-core object, as well as PersistentVolumeClaim objects.
 * While dataSource ignores disallowed values (dropping them), dataSourceRef
   preserves all values, and generates an error if a disallowed value is
   specified.
 * While dataSource only allows local objects, dataSourceRef allows objects
   in any namespaces.
 (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.
 (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
 +optional
        optional .k8s.io.api.core.v1.TypedObjectReference dataSourceRef = 8;
        Returns:
        The dataSourceRef.

      • getDataSourceRefOrBuilder

        Generated.TypedObjectReferenceOrBuilder getDataSourceRefOrBuilder()
         dataSourceRef specifies the object from which to populate the volume with data, if a non-empty
 volume is desired. This may be any object from a non-empty API group (non
 core object) or a PersistentVolumeClaim object.
 When this field is specified, volume binding will only succeed if the type of
 the specified object matches some installed volume populator or dynamic
 provisioner.
 This field will replace the functionality of the dataSource field and as such
 if both fields are non-empty, they must have the same value. For backwards
 compatibility, when namespace isn't specified in dataSourceRef,
 both fields (dataSource and dataSourceRef) will be set to the same
 value automatically if one of them is empty and the other is non-empty.
 When namespace is specified in dataSourceRef,
 dataSource isn't set to the same value and must be empty.
 There are three important differences between dataSource and dataSourceRef:
 * While dataSource only allows two specific types of objects, dataSourceRef
   allows any non-core object, as well as PersistentVolumeClaim objects.
 * While dataSource ignores disallowed values (dropping them), dataSourceRef
   preserves all values, and generates an error if a disallowed value is
   specified.
 * While dataSource only allows local objects, dataSourceRef allows objects
   in any namespaces.
 (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.
 (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
 +optional
        optional .k8s.io.api.core.v1.TypedObjectReference dataSourceRef = 8;

      • hasVolumeAttributesClassName

        boolean hasVolumeAttributesClassName()
         volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.
 If specified, the CSI driver will create or update the volume with the attributes defined
 in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,
 it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass
 will be applied to the claim but it's not allowed to reset this field to empty string once it is set.
 If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass
 will be set by the persistentvolume controller if it exists.
 If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be
 set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource
 exists.
 More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/
 (Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default).
 +featureGate=VolumeAttributesClass
 +optional
        optional string volumeAttributesClassName = 9;
        Returns:
        Whether the volumeAttributesClassName field is set.

      • getVolumeAttributesClassName

        String getVolumeAttributesClassName()
         volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.
 If specified, the CSI driver will create or update the volume with the attributes defined
 in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,
 it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass
 will be applied to the claim but it's not allowed to reset this field to empty string once it is set.
 If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass
 will be set by the persistentvolume controller if it exists.
 If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be
 set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource
 exists.
 More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/
 (Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default).
 +featureGate=VolumeAttributesClass
 +optional
        optional string volumeAttributesClassName = 9;
        Returns:
        The volumeAttributesClassName.

      • getVolumeAttributesClassNameBytes

        com.google.protobuf.ByteString getVolumeAttributesClassNameBytes()
         volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.
 If specified, the CSI driver will create or update the volume with the attributes defined
 in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,
 it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass
 will be applied to the claim but it's not allowed to reset this field to empty string once it is set.
 If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass
 will be set by the persistentvolume controller if it exists.
 If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be
 set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource
 exists.
 More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/
 (Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default).
 +featureGate=VolumeAttributesClass
 +optional
        optional string volumeAttributesClassName = 9;
        Returns:
        The bytes for volumeAttributesClassName.