Package k8s.io.apimachinery.pkg.api.resource

Class Generated.Quantity

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, Generated.QuantityOrBuilder
    Enclosing class:
    Generated
    public static final class Generated.Quantity
extends com.google.protobuf.GeneratedMessageV3
implements Generated.QuantityOrBuilder
     Quantity is a fixed-point representation of a number.
 It provides convenient marshaling/unmarshaling in JSON and YAML,
 in addition to String() and AsInt64() accessors.

 The serialization format is:

 ```
 <quantity>        ::= <signedNumber><suffix>

        (Note that <suffix> may be empty, from the "" case in <decimalSI>.)

 <digit>           ::= 0 | 1 | ... | 9
 <digits>          ::= <digit> | <digit><digits>
 <number>          ::= <digits> | <digits>.<digits> | <digits>. | .<digits>
 <sign>            ::= "+" | "-"
 <signedNumber>    ::= <number> | <sign><number>
 <suffix>          ::= <binarySI> | <decimalExponent> | <decimalSI>
 <binarySI>        ::= Ki | Mi | Gi | Ti | Pi | Ei

        (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html)

 <decimalSI>       ::= m | "" | k | M | G | T | P | E

        (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.)

 <decimalExponent> ::= "e" <signedNumber> | "E" <signedNumber>
 ```

 No matter which of the three exponent forms is used, no quantity may represent
 a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal
 places. Numbers larger or more precise will be capped or rounded up.
 (E.g.: 0.1m will rounded up to 1m.)
 This may be extended in the future if we require larger or smaller quantities.

 When a Quantity is parsed from a string, it will remember the type of suffix
 it had, and will use the same type again when it is serialized.

 Before serializing, Quantity will be put in "canonical form".
 This means that Exponent/suffix will be adjusted up or down (with a
 corresponding increase or decrease in Mantissa) such that:

 - No precision is lost
 - No fractional digits will be emitted
 - The exponent (or suffix) is as large as possible.

 The sign will be omitted unless the number is negative.

 Examples:

 - 1.5 will be serialized as "1500m"
 - 1.5Gi will be serialized as "1536Mi"

 Note that the quantity will NEVER be internally represented by a
 floating point number. That is the whole point of this exercise.

 Non-canonical values will still parse as long as they are well formed,
 but will be re-emitted in their canonical form. (So always use canonical
 form, or don't diff.)

 This format is intended to make it difficult to use these numbers without
 writing some sort of special handling code in the hopes that that will
 cause implementors to also use a fixed point implementation.

 +protobuf=true
 +protobuf.embed=string
 +protobuf.options.marshal=false
 +protobuf.options.(gogoproto.goproto_stringer)=false
 +k8s:deepcopy-gen=true
 +k8s:openapi-gen=true
    Protobuf type k8s.io.apimachinery.pkg.api.resource.Quantity
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Generated.Quantity.Builder
      Quantity is a fixed-point representation of a number.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static com.google.protobuf.Parser<Generated.Quantity> PARSER
      Deprecated.
      static int STRING_FIELD_NUMBER  

      • Fields inherited from class com.google.protobuf.GeneratedMessageV3

        alwaysUseFieldBuilders, unknownFields

      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize

      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetFieldAccessorTable

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

      • 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 Generated.Quantity parseFrom​(ByteBuffer data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Generated.Quantity parseFrom​(ByteBuffer data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Generated.Quantity parseFrom​(com.google.protobuf.ByteString data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Generated.Quantity parseFrom​(com.google.protobuf.ByteString data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Generated.Quantity parseFrom​(byte[] data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

        public static Generated.Quantity parseFrom​(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException
        Throws:
        IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected Generated.Quantity.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<Generated.Quantity> 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 Generated.Quantity getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder