public static final class V1beta1Storage.CSIStorageCapacity extends com.google.protobuf.GeneratedMessageV3 implements V1beta1Storage.CSIStorageCapacityOrBuilder
CSIStorageCapacity stores the result of one CSI GetCapacity call. For a given StorageClass, this describes the available capacity in a particular topology segment. This can be used when considering where to instantiate new PersistentVolumes. For example this can express things like: - StorageClass "standard" has "1234 GiB" available in "topology.kubernetes.io/zone=us-east1" - StorageClass "localssd" has "10 GiB" available in "kubernetes.io/hostname=knode-abc123" The following three cases all imply that no capacity is available for a certain combination: - no object exists with suitable topology and storage class name - such an object exists, but the capacity is unset - such an object exists, but the capacity is zero The producer of these objects can decide which approach is more suitable. They are consumed by the kube-scheduler if the CSIStorageCapacity beta feature gate is enabled there and a CSI driver opts into capacity-aware scheduling with CSIDriver.StorageCapacity.Protobuf type
k8s.io.api.storage.v1beta1.CSIStorageCapacity| Modifier and Type | Class and Description |
|---|---|
static class |
V1beta1Storage.CSIStorageCapacity.Builder
CSIStorageCapacity stores the result of one CSI GetCapacity call.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
CAPACITY_FIELD_NUMBER |
static int |
MAXIMUMVOLUMESIZE_FIELD_NUMBER |
static int |
METADATA_FIELD_NUMBER |
static int |
NODETOPOLOGY_FIELD_NUMBER |
static com.google.protobuf.Parser<V1beta1Storage.CSIStorageCapacity> |
PARSER
Deprecated.
|
static int |
STORAGECLASSNAME_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
Resource.Quantity |
getCapacity()
Capacity is the value reported by the CSI driver in its GetCapacityResponse
for a GetCapacityRequest with topology and parameters that match the
previous fields.
|
Resource.QuantityOrBuilder |
getCapacityOrBuilder()
Capacity is the value reported by the CSI driver in its GetCapacityResponse
for a GetCapacityRequest with topology and parameters that match the
previous fields.
|
static V1beta1Storage.CSIStorageCapacity |
getDefaultInstance() |
V1beta1Storage.CSIStorageCapacity |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
Resource.Quantity |
getMaximumVolumeSize()
MaximumVolumeSize is the value reported by the CSI driver in its GetCapacityResponse
for a GetCapacityRequest with topology and parameters that match the
previous fields.
|
Resource.QuantityOrBuilder |
getMaximumVolumeSizeOrBuilder()
MaximumVolumeSize is the value reported by the CSI driver in its GetCapacityResponse
for a GetCapacityRequest with topology and parameters that match the
previous fields.
|
Meta.ObjectMeta |
getMetadata()
Standard object's metadata.
|
Meta.ObjectMetaOrBuilder |
getMetadataOrBuilder()
Standard object's metadata.
|
Meta.LabelSelector |
getNodeTopology()
NodeTopology defines which nodes have access to the storage
for which capacity was reported.
|
Meta.LabelSelectorOrBuilder |
getNodeTopologyOrBuilder()
NodeTopology defines which nodes have access to the storage
for which capacity was reported.
|
com.google.protobuf.Parser<V1beta1Storage.CSIStorageCapacity> |
getParserForType() |
int |
getSerializedSize() |
String |
getStorageClassName()
The name of the StorageClass that the reported capacity applies to.
|
com.google.protobuf.ByteString |
getStorageClassNameBytes()
The name of the StorageClass that the reported capacity applies to.
|
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
boolean |
hasCapacity()
Capacity is the value reported by the CSI driver in its GetCapacityResponse
for a GetCapacityRequest with topology and parameters that match the
previous fields.
|
int |
hashCode() |
boolean |
hasMaximumVolumeSize()
MaximumVolumeSize is the value reported by the CSI driver in its GetCapacityResponse
for a GetCapacityRequest with topology and parameters that match the
previous fields.
|
boolean |
hasMetadata()
Standard object's metadata.
|
boolean |
hasNodeTopology()
NodeTopology defines which nodes have access to the storage
for which capacity was reported.
|
boolean |
hasStorageClassName()
The name of the StorageClass that the reported capacity applies to.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static V1beta1Storage.CSIStorageCapacity.Builder |
newBuilder() |
static V1beta1Storage.CSIStorageCapacity.Builder |
newBuilder(V1beta1Storage.CSIStorageCapacity prototype) |
V1beta1Storage.CSIStorageCapacity.Builder |
newBuilderForType() |
protected V1beta1Storage.CSIStorageCapacity.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
static V1beta1Storage.CSIStorageCapacity |
parseDelimitedFrom(InputStream input) |
static V1beta1Storage.CSIStorageCapacity |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static V1beta1Storage.CSIStorageCapacity |
parseFrom(byte[] data) |
static V1beta1Storage.CSIStorageCapacity |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static V1beta1Storage.CSIStorageCapacity |
parseFrom(ByteBuffer data) |
static V1beta1Storage.CSIStorageCapacity |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static V1beta1Storage.CSIStorageCapacity |
parseFrom(com.google.protobuf.ByteString data) |
static V1beta1Storage.CSIStorageCapacity |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static V1beta1Storage.CSIStorageCapacity |
parseFrom(com.google.protobuf.CodedInputStream input) |
static V1beta1Storage.CSIStorageCapacity |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static V1beta1Storage.CSIStorageCapacity |
parseFrom(InputStream input) |
static V1beta1Storage.CSIStorageCapacity |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<V1beta1Storage.CSIStorageCapacity> |
parser() |
V1beta1Storage.CSIStorageCapacity.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newInstance, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int METADATA_FIELD_NUMBER
public static final int NODETOPOLOGY_FIELD_NUMBER
public static final int STORAGECLASSNAME_FIELD_NUMBER
public static final int CAPACITY_FIELD_NUMBER
public static final int MAXIMUMVOLUMESIZE_FIELD_NUMBER
@Deprecated public static final com.google.protobuf.Parser<V1beta1Storage.CSIStorageCapacity> PARSER
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields in interface com.google.protobuf.MessageOrBuildergetUnknownFields in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public boolean hasMetadata()
Standard object's metadata. The name has no particular meaning. It must be be a DNS subdomain (dots allowed, 253 characters). To ensure that there are no conflicts with other CSI drivers on the cluster, the recommendation is to use csisc-<uuid>, a generated name, or a reverse-domain name which ends with the unique CSI driver name. Objects are namespaced. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional
optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;hasMetadata in interface V1beta1Storage.CSIStorageCapacityOrBuilderpublic Meta.ObjectMeta getMetadata()
Standard object's metadata. The name has no particular meaning. It must be be a DNS subdomain (dots allowed, 253 characters). To ensure that there are no conflicts with other CSI drivers on the cluster, the recommendation is to use csisc-<uuid>, a generated name, or a reverse-domain name which ends with the unique CSI driver name. Objects are namespaced. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional
optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;getMetadata in interface V1beta1Storage.CSIStorageCapacityOrBuilderpublic Meta.ObjectMetaOrBuilder getMetadataOrBuilder()
Standard object's metadata. The name has no particular meaning. It must be be a DNS subdomain (dots allowed, 253 characters). To ensure that there are no conflicts with other CSI drivers on the cluster, the recommendation is to use csisc-<uuid>, a generated name, or a reverse-domain name which ends with the unique CSI driver name. Objects are namespaced. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional
optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;getMetadataOrBuilder in interface V1beta1Storage.CSIStorageCapacityOrBuilderpublic boolean hasNodeTopology()
NodeTopology defines which nodes have access to the storage for which capacity was reported. If not set, the storage is not accessible from any node in the cluster. If empty, the storage is accessible from all nodes. This field is immutable. +optional
optional .k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector nodeTopology = 2;hasNodeTopology in interface V1beta1Storage.CSIStorageCapacityOrBuilderpublic Meta.LabelSelector getNodeTopology()
NodeTopology defines which nodes have access to the storage for which capacity was reported. If not set, the storage is not accessible from any node in the cluster. If empty, the storage is accessible from all nodes. This field is immutable. +optional
optional .k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector nodeTopology = 2;getNodeTopology in interface V1beta1Storage.CSIStorageCapacityOrBuilderpublic Meta.LabelSelectorOrBuilder getNodeTopologyOrBuilder()
NodeTopology defines which nodes have access to the storage for which capacity was reported. If not set, the storage is not accessible from any node in the cluster. If empty, the storage is accessible from all nodes. This field is immutable. +optional
optional .k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector nodeTopology = 2;getNodeTopologyOrBuilder in interface V1beta1Storage.CSIStorageCapacityOrBuilderpublic boolean hasStorageClassName()
The name of the StorageClass that the reported capacity applies to. It must meet the same requirements as the name of a StorageClass object (non-empty, DNS subdomain). If that object no longer exists, the CSIStorageCapacity object is obsolete and should be removed by its creator. This field is immutable.
optional string storageClassName = 3;hasStorageClassName in interface V1beta1Storage.CSIStorageCapacityOrBuilderpublic String getStorageClassName()
The name of the StorageClass that the reported capacity applies to. It must meet the same requirements as the name of a StorageClass object (non-empty, DNS subdomain). If that object no longer exists, the CSIStorageCapacity object is obsolete and should be removed by its creator. This field is immutable.
optional string storageClassName = 3;getStorageClassName in interface V1beta1Storage.CSIStorageCapacityOrBuilderpublic com.google.protobuf.ByteString getStorageClassNameBytes()
The name of the StorageClass that the reported capacity applies to. It must meet the same requirements as the name of a StorageClass object (non-empty, DNS subdomain). If that object no longer exists, the CSIStorageCapacity object is obsolete and should be removed by its creator. This field is immutable.
optional string storageClassName = 3;getStorageClassNameBytes in interface V1beta1Storage.CSIStorageCapacityOrBuilderpublic boolean hasCapacity()
Capacity is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields. The semantic is currently (CSI spec 1.2) defined as: The available capacity, in bytes, of the storage that can be used to provision volumes. If not set, that information is currently unavailable and treated like zero capacity. +optional
optional .k8s.io.apimachinery.pkg.api.resource.Quantity capacity = 4;hasCapacity in interface V1beta1Storage.CSIStorageCapacityOrBuilderpublic Resource.Quantity getCapacity()
Capacity is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields. The semantic is currently (CSI spec 1.2) defined as: The available capacity, in bytes, of the storage that can be used to provision volumes. If not set, that information is currently unavailable and treated like zero capacity. +optional
optional .k8s.io.apimachinery.pkg.api.resource.Quantity capacity = 4;getCapacity in interface V1beta1Storage.CSIStorageCapacityOrBuilderpublic Resource.QuantityOrBuilder getCapacityOrBuilder()
Capacity is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields. The semantic is currently (CSI spec 1.2) defined as: The available capacity, in bytes, of the storage that can be used to provision volumes. If not set, that information is currently unavailable and treated like zero capacity. +optional
optional .k8s.io.apimachinery.pkg.api.resource.Quantity capacity = 4;getCapacityOrBuilder in interface V1beta1Storage.CSIStorageCapacityOrBuilderpublic boolean hasMaximumVolumeSize()
MaximumVolumeSize is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields. This is defined since CSI spec 1.4.0 as the largest size that may be used in a CreateVolumeRequest.capacity_range.required_bytes field to create a volume with the same parameters as those in GetCapacityRequest. The corresponding value in the Kubernetes API is ResourceRequirements.Requests in a volume claim. +optional
optional .k8s.io.apimachinery.pkg.api.resource.Quantity maximumVolumeSize = 5;hasMaximumVolumeSize in interface V1beta1Storage.CSIStorageCapacityOrBuilderpublic Resource.Quantity getMaximumVolumeSize()
MaximumVolumeSize is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields. This is defined since CSI spec 1.4.0 as the largest size that may be used in a CreateVolumeRequest.capacity_range.required_bytes field to create a volume with the same parameters as those in GetCapacityRequest. The corresponding value in the Kubernetes API is ResourceRequirements.Requests in a volume claim. +optional
optional .k8s.io.apimachinery.pkg.api.resource.Quantity maximumVolumeSize = 5;getMaximumVolumeSize in interface V1beta1Storage.CSIStorageCapacityOrBuilderpublic Resource.QuantityOrBuilder getMaximumVolumeSizeOrBuilder()
MaximumVolumeSize is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields. This is defined since CSI spec 1.4.0 as the largest size that may be used in a CreateVolumeRequest.capacity_range.required_bytes field to create a volume with the same parameters as those in GetCapacityRequest. The corresponding value in the Kubernetes API is ResourceRequirements.Requests in a volume claim. +optional
optional .k8s.io.apimachinery.pkg.api.resource.Quantity maximumVolumeSize = 5;getMaximumVolumeSizeOrBuilder in interface V1beta1Storage.CSIStorageCapacityOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static V1beta1Storage.CSIStorageCapacity parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static V1beta1Storage.CSIStorageCapacity parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static V1beta1Storage.CSIStorageCapacity parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static V1beta1Storage.CSIStorageCapacity parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static V1beta1Storage.CSIStorageCapacity parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static V1beta1Storage.CSIStorageCapacity parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static V1beta1Storage.CSIStorageCapacity parseFrom(InputStream input) throws IOException
IOExceptionpublic static V1beta1Storage.CSIStorageCapacity parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static V1beta1Storage.CSIStorageCapacity parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static V1beta1Storage.CSIStorageCapacity parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static V1beta1Storage.CSIStorageCapacity parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static V1beta1Storage.CSIStorageCapacity parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic V1beta1Storage.CSIStorageCapacity.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static V1beta1Storage.CSIStorageCapacity.Builder newBuilder()
public static V1beta1Storage.CSIStorageCapacity.Builder newBuilder(V1beta1Storage.CSIStorageCapacity prototype)
public V1beta1Storage.CSIStorageCapacity.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected V1beta1Storage.CSIStorageCapacity.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static V1beta1Storage.CSIStorageCapacity getDefaultInstance()
public static com.google.protobuf.Parser<V1beta1Storage.CSIStorageCapacity> parser()
public com.google.protobuf.Parser<V1beta1Storage.CSIStorageCapacity> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public V1beta1Storage.CSIStorageCapacity getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2023. All rights reserved.