Package io.kubernetes.client.proto

Class V1.PersistentVolumeSpec

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.kubernetes.client.proto.V1.PersistentVolumeSpec
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, V1.PersistentVolumeSpecOrBuilder, Serializable
Enclosing class:
V1
public static final class V1.PersistentVolumeSpec extends com.google.protobuf.GeneratedMessageV3 implements V1.PersistentVolumeSpecOrBuilder
 PersistentVolumeSpec is the specification of a persistent volume.
Protobuf type k8s.io.api.core.v1.PersistentVolumeSpec
See Also:

  • Field Details

    • CAPACITY_FIELD_NUMBER

      public static final int CAPACITY_FIELD_NUMBER
      See Also:

    • PERSISTENTVOLUMESOURCE_FIELD_NUMBER

      public static final int PERSISTENTVOLUMESOURCE_FIELD_NUMBER
      See Also:

    • ACCESSMODES_FIELD_NUMBER

      public static final int ACCESSMODES_FIELD_NUMBER
      See Also:

    • CLAIMREF_FIELD_NUMBER

      public static final int CLAIMREF_FIELD_NUMBER
      See Also:

    • PERSISTENTVOLUMERECLAIMPOLICY_FIELD_NUMBER

      public static final int PERSISTENTVOLUMERECLAIMPOLICY_FIELD_NUMBER
      See Also:

    • STORAGECLASSNAME_FIELD_NUMBER

      public static final int STORAGECLASSNAME_FIELD_NUMBER
      See Also:

    • MOUNTOPTIONS_FIELD_NUMBER

      public static final int MOUNTOPTIONS_FIELD_NUMBER
      See Also:

    • VOLUMEMODE_FIELD_NUMBER

      public static final int VOLUMEMODE_FIELD_NUMBER
      See Also:

    • NODEAFFINITY_FIELD_NUMBER

      public static final int NODEAFFINITY_FIELD_NUMBER
      See Also:

    • PARSER

      @Deprecated public static final com.google.protobuf.Parser<V1.PersistentVolumeSpec> PARSER
      Deprecated.

  • Method Details

    • getUnknownFields

      public final com.google.protobuf.UnknownFieldSet getUnknownFields()
      Specified by:
      getUnknownFields in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getUnknownFields in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapField

      protected com.google.protobuf.MapField internalGetMapField(int number)
      Overrides:
      internalGetMapField in class com.google.protobuf.GeneratedMessageV3

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getCapacityCount

      public int getCapacityCount()
      Description copied from interface: V1.PersistentVolumeSpecOrBuilder
       A description of the persistent volume's resources and capacity.
 More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity
 +optional
      map<string, .k8s.io.apimachinery.pkg.api.resource.Quantity> capacity = 1;
      Specified by:
      getCapacityCount in interface V1.PersistentVolumeSpecOrBuilder

    • containsCapacity

      public boolean containsCapacity(String key)
       A description of the persistent volume's resources and capacity.
 More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity
 +optional
      map<string, .k8s.io.apimachinery.pkg.api.resource.Quantity> capacity = 1;
      Specified by:
      containsCapacity in interface V1.PersistentVolumeSpecOrBuilder

    • getCapacity

      @Deprecated public Map<String,Resource.Quantity> getCapacity()
      Deprecated.
      Use getCapacityMap() instead.
      Specified by:
      getCapacity in interface V1.PersistentVolumeSpecOrBuilder

    • getCapacityMap

      public Map<String,Resource.Quantity> getCapacityMap()
       A description of the persistent volume's resources and capacity.
 More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity
 +optional
      map<string, .k8s.io.apimachinery.pkg.api.resource.Quantity> capacity = 1;
      Specified by:
      getCapacityMap in interface V1.PersistentVolumeSpecOrBuilder

    • getCapacityOrDefault

      public Resource.Quantity getCapacityOrDefault(String key, Resource.Quantity defaultValue)
       A description of the persistent volume's resources and capacity.
 More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity
 +optional
      map<string, .k8s.io.apimachinery.pkg.api.resource.Quantity> capacity = 1;
      Specified by:
      getCapacityOrDefault in interface V1.PersistentVolumeSpecOrBuilder

    • getCapacityOrThrow

      public Resource.Quantity getCapacityOrThrow(String key)
       A description of the persistent volume's resources and capacity.
 More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity
 +optional
      map<string, .k8s.io.apimachinery.pkg.api.resource.Quantity> capacity = 1;
      Specified by:
      getCapacityOrThrow in interface V1.PersistentVolumeSpecOrBuilder

    • hasPersistentVolumeSource

      public boolean hasPersistentVolumeSource()
       The actual volume backing the persistent volume.
      optional .k8s.io.api.core.v1.PersistentVolumeSource persistentVolumeSource = 2;
      Specified by:
      hasPersistentVolumeSource in interface V1.PersistentVolumeSpecOrBuilder

    • getPersistentVolumeSource

      public V1.PersistentVolumeSource getPersistentVolumeSource()
       The actual volume backing the persistent volume.
      optional .k8s.io.api.core.v1.PersistentVolumeSource persistentVolumeSource = 2;
      Specified by:
      getPersistentVolumeSource in interface V1.PersistentVolumeSpecOrBuilder

    • getPersistentVolumeSourceOrBuilder

      public V1.PersistentVolumeSourceOrBuilder getPersistentVolumeSourceOrBuilder()
       The actual volume backing the persistent volume.
      optional .k8s.io.api.core.v1.PersistentVolumeSource persistentVolumeSource = 2;
      Specified by:
      getPersistentVolumeSourceOrBuilder in interface V1.PersistentVolumeSpecOrBuilder

    • getAccessModesList

      public com.google.protobuf.ProtocolStringList getAccessModesList()
       AccessModes contains all ways the volume can be mounted.
 More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes
 +optional
      repeated string accessModes = 3;
      Specified by:
      getAccessModesList in interface V1.PersistentVolumeSpecOrBuilder

    • getAccessModesCount

      public int getAccessModesCount()
       AccessModes contains all ways the volume can be mounted.
 More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes
 +optional
      repeated string accessModes = 3;
      Specified by:
      getAccessModesCount in interface V1.PersistentVolumeSpecOrBuilder

    • getAccessModes

      public String getAccessModes(int index)
       AccessModes contains all ways the volume can be mounted.
 More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes
 +optional
      repeated string accessModes = 3;
      Specified by:
      getAccessModes in interface V1.PersistentVolumeSpecOrBuilder

    • getAccessModesBytes

      public com.google.protobuf.ByteString getAccessModesBytes(int index)
       AccessModes contains all ways the volume can be mounted.
 More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes
 +optional
      repeated string accessModes = 3;
      Specified by:
      getAccessModesBytes in interface V1.PersistentVolumeSpecOrBuilder

    • hasClaimRef

      public boolean hasClaimRef()
       ClaimRef is part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim.
 Expected to be non-nil when bound.
 claim.VolumeName is the authoritative bind between PV and PVC.
 More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding
 +optional
      optional .k8s.io.api.core.v1.ObjectReference claimRef = 4;
      Specified by:
      hasClaimRef in interface V1.PersistentVolumeSpecOrBuilder

    • getClaimRef

      public V1.ObjectReference getClaimRef()
       ClaimRef is part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim.
 Expected to be non-nil when bound.
 claim.VolumeName is the authoritative bind between PV and PVC.
 More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding
 +optional
      optional .k8s.io.api.core.v1.ObjectReference claimRef = 4;
      Specified by:
      getClaimRef in interface V1.PersistentVolumeSpecOrBuilder

    • getClaimRefOrBuilder

      public V1.ObjectReferenceOrBuilder getClaimRefOrBuilder()
       ClaimRef is part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim.
 Expected to be non-nil when bound.
 claim.VolumeName is the authoritative bind between PV and PVC.
 More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding
 +optional
      optional .k8s.io.api.core.v1.ObjectReference claimRef = 4;
      Specified by:
      getClaimRefOrBuilder in interface V1.PersistentVolumeSpecOrBuilder

    • hasPersistentVolumeReclaimPolicy

      public boolean hasPersistentVolumeReclaimPolicy()
       What happens to a persistent volume when released from its claim.
 Valid options are Retain (default for manually created PersistentVolumes), Delete (default
 for dynamically provisioned PersistentVolumes), and Recycle (deprecated).
 Recycle must be supported by the volume plugin underlying this PersistentVolume.
 More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming
 +optional
      optional string persistentVolumeReclaimPolicy = 5;
      Specified by:
      hasPersistentVolumeReclaimPolicy in interface V1.PersistentVolumeSpecOrBuilder

    • getPersistentVolumeReclaimPolicy

      public String getPersistentVolumeReclaimPolicy()
       What happens to a persistent volume when released from its claim.
 Valid options are Retain (default for manually created PersistentVolumes), Delete (default
 for dynamically provisioned PersistentVolumes), and Recycle (deprecated).
 Recycle must be supported by the volume plugin underlying this PersistentVolume.
 More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming
 +optional
      optional string persistentVolumeReclaimPolicy = 5;
      Specified by:
      getPersistentVolumeReclaimPolicy in interface V1.PersistentVolumeSpecOrBuilder

    • getPersistentVolumeReclaimPolicyBytes

      public com.google.protobuf.ByteString getPersistentVolumeReclaimPolicyBytes()
       What happens to a persistent volume when released from its claim.
 Valid options are Retain (default for manually created PersistentVolumes), Delete (default
 for dynamically provisioned PersistentVolumes), and Recycle (deprecated).
 Recycle must be supported by the volume plugin underlying this PersistentVolume.
 More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming
 +optional
      optional string persistentVolumeReclaimPolicy = 5;
      Specified by:
      getPersistentVolumeReclaimPolicyBytes in interface V1.PersistentVolumeSpecOrBuilder

    • hasStorageClassName

      public boolean hasStorageClassName()
       Name of StorageClass to which this persistent volume belongs. Empty value
 means that this volume does not belong to any StorageClass.
 +optional
      optional string storageClassName = 6;
      Specified by:
      hasStorageClassName in interface V1.PersistentVolumeSpecOrBuilder

    • getStorageClassName

      public String getStorageClassName()
       Name of StorageClass to which this persistent volume belongs. Empty value
 means that this volume does not belong to any StorageClass.
 +optional
      optional string storageClassName = 6;
      Specified by:
      getStorageClassName in interface V1.PersistentVolumeSpecOrBuilder

    • getStorageClassNameBytes

      public com.google.protobuf.ByteString getStorageClassNameBytes()
       Name of StorageClass to which this persistent volume belongs. Empty value
 means that this volume does not belong to any StorageClass.
 +optional
      optional string storageClassName = 6;
      Specified by:
      getStorageClassNameBytes in interface V1.PersistentVolumeSpecOrBuilder

    • getMountOptionsList

      public com.google.protobuf.ProtocolStringList getMountOptionsList()
       A list of mount options, e.g. ["ro", "soft"]. Not validated - mount will
 simply fail if one is invalid.
 More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options
 +optional
      repeated string mountOptions = 7;
      Specified by:
      getMountOptionsList in interface V1.PersistentVolumeSpecOrBuilder

    • getMountOptionsCount

      public int getMountOptionsCount()
       A list of mount options, e.g. ["ro", "soft"]. Not validated - mount will
 simply fail if one is invalid.
 More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options
 +optional
      repeated string mountOptions = 7;
      Specified by:
      getMountOptionsCount in interface V1.PersistentVolumeSpecOrBuilder

    • getMountOptions

      public String getMountOptions(int index)
       A list of mount options, e.g. ["ro", "soft"]. Not validated - mount will
 simply fail if one is invalid.
 More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options
 +optional
      repeated string mountOptions = 7;
      Specified by:
      getMountOptions in interface V1.PersistentVolumeSpecOrBuilder

    • getMountOptionsBytes

      public com.google.protobuf.ByteString getMountOptionsBytes(int index)
       A list of mount options, e.g. ["ro", "soft"]. Not validated - mount will
 simply fail if one is invalid.
 More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options
 +optional
      repeated string mountOptions = 7;
      Specified by:
      getMountOptionsBytes in interface V1.PersistentVolumeSpecOrBuilder

    • hasVolumeMode

      public boolean hasVolumeMode()
       volumeMode defines if a volume is intended to be used with a formatted filesystem
 or to remain in raw block state. Value of Filesystem is implied when not included in spec.
 +optional
      optional string volumeMode = 8;
      Specified by:
      hasVolumeMode in interface V1.PersistentVolumeSpecOrBuilder

    • getVolumeMode

      public String getVolumeMode()
       volumeMode defines if a volume is intended to be used with a formatted filesystem
 or to remain in raw block state. Value of Filesystem is implied when not included in spec.
 +optional
      optional string volumeMode = 8;
      Specified by:
      getVolumeMode in interface V1.PersistentVolumeSpecOrBuilder

    • getVolumeModeBytes

      public com.google.protobuf.ByteString getVolumeModeBytes()
       volumeMode defines if a volume is intended to be used with a formatted filesystem
 or to remain in raw block state. Value of Filesystem is implied when not included in spec.
 +optional
      optional string volumeMode = 8;
      Specified by:
      getVolumeModeBytes in interface V1.PersistentVolumeSpecOrBuilder

    • hasNodeAffinity

      public boolean hasNodeAffinity()
       NodeAffinity defines constraints that limit what nodes this volume can be accessed from.
 This field influences the scheduling of pods that use this volume.
 +optional
      optional .k8s.io.api.core.v1.VolumeNodeAffinity nodeAffinity = 9;
      Specified by:
      hasNodeAffinity in interface V1.PersistentVolumeSpecOrBuilder

    • getNodeAffinity

      public V1.VolumeNodeAffinity getNodeAffinity()
       NodeAffinity defines constraints that limit what nodes this volume can be accessed from.
 This field influences the scheduling of pods that use this volume.
 +optional
      optional .k8s.io.api.core.v1.VolumeNodeAffinity nodeAffinity = 9;
      Specified by:
      getNodeAffinity in interface V1.PersistentVolumeSpecOrBuilder

    • getNodeAffinityOrBuilder

      public V1.VolumeNodeAffinityOrBuilder getNodeAffinityOrBuilder()
       NodeAffinity defines constraints that limit what nodes this volume can be accessed from.
 This field influences the scheduling of pods that use this volume.
 +optional
      optional .k8s.io.api.core.v1.VolumeNodeAffinity nodeAffinity = 9;
      Specified by:
      getNodeAffinityOrBuilder in interface V1.PersistentVolumeSpecOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static V1.PersistentVolumeSpec parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static V1.PersistentVolumeSpec parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static V1.PersistentVolumeSpec parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static V1.PersistentVolumeSpec parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static V1.PersistentVolumeSpec parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static V1.PersistentVolumeSpec parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static V1.PersistentVolumeSpec parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static V1.PersistentVolumeSpec parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static V1.PersistentVolumeSpec parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static V1.PersistentVolumeSpec parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static V1.PersistentVolumeSpec parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static V1.PersistentVolumeSpec parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public V1.PersistentVolumeSpec.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static V1.PersistentVolumeSpec.Builder newBuilder()

    • newBuilder

      public static V1.PersistentVolumeSpec.Builder newBuilder(V1.PersistentVolumeSpec prototype)

    • toBuilder

      public V1.PersistentVolumeSpec.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected V1.PersistentVolumeSpec.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static V1.PersistentVolumeSpec getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<V1.PersistentVolumeSpec> parser()

    • getParserForType

      public com.google.protobuf.Parser<V1.PersistentVolumeSpec> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public V1.PersistentVolumeSpec getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder