mesos_quota

Documentation

Overview

Package mesos_quota is a generated protocol buffer package.

It is generated from these files:

quota.proto

It has these top-level messages:

QuotaInfo
QuotaRequest
QuotaStatus

Index

• Constants
• type QuotaInfo
  • func (*QuotaInfo) Descriptor() ([]byte, []int)
  • func (m *QuotaInfo) GetGuarantee() []*mesos.Resource
  • func (m *QuotaInfo) GetPrincipal() string
  • func (m *QuotaInfo) GetRole() string
  • func (*QuotaInfo) ProtoMessage()
  • func (m *QuotaInfo) Reset()
  • func (m *QuotaInfo) String() string
• type QuotaRequest
  • func (*QuotaRequest) Descriptor() ([]byte, []int)
  • func (m *QuotaRequest) GetForce() bool
  • func (m *QuotaRequest) GetGuarantee() []*mesos.Resource
  • func (m *QuotaRequest) GetRole() string
  • func (*QuotaRequest) ProtoMessage()
  • func (m *QuotaRequest) Reset()
  • func (m *QuotaRequest) String() string
• type QuotaStatus
  • func (*QuotaStatus) Descriptor() ([]byte, []int)
  • func (m *QuotaStatus) GetInfos() []*QuotaInfo
  • func (*QuotaStatus) ProtoMessage()
  • func (m *QuotaStatus) Reset()
  • func (m *QuotaStatus) String() string

Constants

const Default_QuotaRequest_Force bool = false

Types

type QuotaInfo

type QuotaInfo struct {
	// Quota is granted per role and not per framework, similar to
	// dynamic reservations.
	Role *string `protobuf:"bytes,1,opt,name=role" json:"role,omitempty"`
	// Principal which set the quota. Currently only operators can set quotas.
	Principal *string `protobuf:"bytes,2,opt,name=principal" json:"principal,omitempty"`
	// The guarantee that these resources are allocatable for the above role.
	// NOTE: `guarantee.role` should not specify any role except '*',
	// because quota does not reserve specific resources.
	Guarantee        []*mesos.Resource `protobuf:"bytes,3,rep,name=guarantee" json:"guarantee,omitempty"`
	XXX_unrecognized []byte            `json:"-"`
}

TODO(joerg84): Add limits, i.e. upper bounds of resources that a role is allowed to use.

func (*QuotaInfo) Descriptor

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

func (*QuotaInfo) GetGuarantee

func (m *QuotaInfo) GetGuarantee() []*mesos.Resource

func (*QuotaInfo) GetPrincipal

func (m *QuotaInfo) GetPrincipal() string

func (*QuotaInfo) GetRole

func (m *QuotaInfo) GetRole() string

func (*QuotaInfo) ProtoMessage

func (*QuotaInfo) ProtoMessage()

func (*QuotaInfo) Reset

func (m *QuotaInfo) Reset()

func (*QuotaInfo) String

func (m *QuotaInfo) String() string

type QuotaRequest

type QuotaRequest struct {
	// Disables the capacity heuristic check if set to `true`.
	Force *bool `protobuf:"varint,1,opt,name=force,def=0" json:"force,omitempty"`
	// The role for which to set quota.
	Role *string `protobuf:"bytes,2,opt,name=role" json:"role,omitempty"`
	// The requested guarantee that these resources will be allocatable for
	// the above role.
	Guarantee        []*mesos.Resource `protobuf:"bytes,3,rep,name=guarantee" json:"guarantee,omitempty"`
	XXX_unrecognized []byte            `json:"-"`
}

* `QuotaRequest` provides a schema for set quota JSON requests.

func (*QuotaRequest) Descriptor

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

func (*QuotaRequest) GetForce

func (m *QuotaRequest) GetForce() bool

func (*QuotaRequest) GetGuarantee

func (m *QuotaRequest) GetGuarantee() []*mesos.Resource

func (*QuotaRequest) GetRole

func (m *QuotaRequest) GetRole() string

func (*QuotaRequest) ProtoMessage

func (*QuotaRequest) ProtoMessage()

func (*QuotaRequest) Reset

func (m *QuotaRequest) Reset()

func (*QuotaRequest) String

func (m *QuotaRequest) String() string

type QuotaStatus

type QuotaStatus struct {
	// Quotas which are currently set, i.e. known to the master.
	Infos            []*QuotaInfo `protobuf:"bytes,1,rep,name=infos" json:"infos,omitempty"`
	XXX_unrecognized []byte       `json:"-"`
}

* `QuotaStatus` describes the internal representation for the /quota/status response.

func (*QuotaStatus) Descriptor

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

func (*QuotaStatus) GetInfos

func (m *QuotaStatus) GetInfos() []*QuotaInfo

func (*QuotaStatus) ProtoMessage

func (*QuotaStatus) ProtoMessage()

func (*QuotaStatus) Reset

func (m *QuotaStatus) Reset()

func (*QuotaStatus) String

func (m *QuotaStatus) String() string