resource

Documentation

Overview

Package resource is a generated protocol buffer package.

It is generated from these files:

k8s.io/apimachinery/pkg/api/resource/generated.proto

It has these top-level messages:

Quantity

Index

• Variables
• type Quantity
  • func (*Quantity) Descriptor() ([]byte, []int)
  • func (m *Quantity) GetString_() string
  • func (m *Quantity) Marshal() (dAtA []byte, err error)
  • func (m *Quantity) MarshalTo(dAtA []byte) (int, error)
  • func (*Quantity) ProtoMessage()
  • func (m *Quantity) Reset()
  • func (m *Quantity) Size() (n int)
  • func (m *Quantity) String() string
  • func (m *Quantity) Unmarshal(dAtA []byte) error

Variables

var (
	ErrInvalidLengthGenerated = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowGenerated   = fmt.Errorf("proto: integer overflow")
)

Types

type Quantity

type Quantity struct {
	String_          *string `protobuf:"bytes,1,opt,name=string" json:"string,omitempty"`
	XXX_unrecognized []byte  `json:"-"`
}

Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and Int64() 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:

a. No precision is lost
b. No fractional digits will be emitted
c. 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: We reserve the right to amend this canonical format, perhaps to

allow 1.5 to be canonical.

TODO: Remove above disclaimer after all bikeshedding about format is over,

or after March 2015.

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

func (*Quantity) Descriptor

func (*Quantity) Descriptor() ([]byte, []int)

func (*Quantity) GetString_

func (m *Quantity) GetString_() string

func (*Quantity) Marshal

func (m *Quantity) Marshal() (dAtA []byte, err error)

func (*Quantity) MarshalTo

func (m *Quantity) MarshalTo(dAtA []byte) (int, error)

func (*Quantity) ProtoMessage

func (*Quantity) ProtoMessage()

func (*Quantity) Reset

func (m *Quantity) Reset()

func (*Quantity) Size

func (m *Quantity) Size() (n int)

func (*Quantity) String

func (m *Quantity) String() string

func (*Quantity) Unmarshal

func (m *Quantity) Unmarshal(dAtA []byte) error