quota

Documentation

Overview

Package quota is a generated protocol buffer package.

It is generated from these files:

bazel-out/local-fastbuild/genfiles/mixer/template/quota/go_default_library_tmpl.proto

It has these top-level messages:

Type
InstanceParam

Index

• Constants
• Variables
• type Handler
• type HandlerBuilder
• type Instance
• type InstanceParam
  • func (*InstanceParam) Descriptor() ([]byte, []int)
  • func (this *InstanceParam) Equal(that interface{}) bool
  • func (m *InstanceParam) GetDimensions() map[string]string
  • func (this *InstanceParam) GoString() string
  • func (m *InstanceParam) Marshal() (dAtA []byte, err error)
  • func (m *InstanceParam) MarshalTo(dAtA []byte) (int, error)
  • func (*InstanceParam) ProtoMessage()
  • func (m *InstanceParam) Reset()
  • func (m *InstanceParam) Size() (n int)
  • func (this *InstanceParam) String() string
  • func (m *InstanceParam) Unmarshal(dAtA []byte) error
• type Type
  • func (*Type) Descriptor() ([]byte, []int)
  • func (this *Type) Equal(that interface{}) bool
  • func (m *Type) GetDimensions() map[string]istio_mixer_v1_config_descriptor.ValueType
  • func (this *Type) GoString() string
  • func (m *Type) Marshal() (dAtA []byte, err error)
  • func (m *Type) MarshalTo(dAtA []byte) (int, error)
  • func (*Type) ProtoMessage()
  • func (m *Type) Reset()
  • func (m *Type) Size() (n int)
  • func (this *Type) String() string
  • func (m *Type) Unmarshal(dAtA []byte) error

Constants

const TemplateName = "quota"

Fully qualified name of the template

Variables

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

Types

type Handler

type Handler interface {
	adapter.Handler

	// HandleQuota is called by Mixer at request time to deliver instances to
	// to an adapter.
	HandleQuota(context.Context, *Instance, adapter.QuotaArgs) (adapter.QuotaResult, error)
}

Handler must be implemented by adapter code if it wants to process data associated with the 'quota' template.

Mixer uses this interface to call into the adapter at request time in order to dispatch created instances to the adapter. Adapters take the incoming instances and do what they need to achieve their primary function.

The name of each instance can be used as a key into the Type map supplied to the adapter at configuration time via the method 'SetQuotaTypes'. These Type associated with an instance describes the shape of the instance

type HandlerBuilder

type HandlerBuilder interface {
	adapter.HandlerBuilder

	// SetQuotaTypes is invoked by Mixer to pass the template-specific Type information for instances that an adapter
	// may receive at runtime. The type information describes the shape of the instance.
	SetQuotaTypes(map[string]*Type)
}

HandlerBuilder must be implemented by adapters if they want to process data associated with the 'quota' template.

Mixer uses this interface to call into the adapter at configuration time to configure it with adapter-specific configuration as well as all template-specific type information.

type Instance

type Instance struct {
	// Name of the instance as specified in configuration.
	Name string

	// The unique identity of the particular quota to manipulate.
	Dimensions map[string]interface{}
}

Instance is constructed by Mixer for the 'quota' template.

Quota represents a piece of data to check Quota for.

When writing the configuration, the value for the fields associated with this template can either be a literal or an [expression](https://istio.io/docs/reference/config/mixer/expression-language.html). Please note that if the datatype of a field is not istio.mixer.v1.config.descriptor.ValueType, then the expression's [inferred type](https://istio.io/docs/reference/config/mixer/expression-language.html#type-checking) must match the datatype of the field.

Example config: ``` apiVersion: "config.istio.io/v1alpha2" kind: quota metadata:

name: requestcount
namespace: istio-system

spec:

dimensions:
  source: source.labels["app"] | source.service | "unknown"
  sourceVersion: source.labels["version"] | "unknown"
  destination: destination.labels["app"] | destination.service | "unknown"
  destinationVersion: destination.labels["version"] | "unknown"

```

type InstanceParam

type InstanceParam struct {
	Dimensions map[string]string `` /* 154-byte string literal not displayed */
}

func (*InstanceParam) Descriptor

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

func (*InstanceParam) Equal

func (this *InstanceParam) Equal(that interface{}) bool

func (*InstanceParam) GetDimensions

func (m *InstanceParam) GetDimensions() map[string]string

func (*InstanceParam) GoString

func (this *InstanceParam) GoString() string

func (*InstanceParam) Marshal

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

func (*InstanceParam) MarshalTo

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

func (*InstanceParam) ProtoMessage

func (*InstanceParam) ProtoMessage()

func (*InstanceParam) Reset

func (m *InstanceParam) Reset()

func (*InstanceParam) Size

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

func (*InstanceParam) String

func (this *InstanceParam) String() string

func (*InstanceParam) Unmarshal

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

type Type

type Type struct {
	// The unique identity of the particular quota to manipulate.
	Dimensions map[string]istio_mixer_v1_config_descriptor.ValueType `` /* 203-byte string literal not displayed */
}

Quota represents a piece of data to check Quota for.

When writing the configuration, the value for the fields associated with this template can either be a literal or an [expression](https://istio.io/docs/reference/config/mixer/expression-language.html). Please note that if the datatype of a field is not istio.mixer.v1.config.descriptor.ValueType, then the expression's [inferred type](https://istio.io/docs/reference/config/mixer/expression-language.html#type-checking) must match the datatype of the field.

Example config: ``` apiVersion: "config.istio.io/v1alpha2" kind: quota metadata:

name: requestcount
namespace: istio-system

spec:

dimensions:
  source: source.labels["app"] | source.service | "unknown"
  sourceVersion: source.labels["version"] | "unknown"
  destination: destination.labels["app"] | destination.service | "unknown"
  destinationVersion: destination.labels["version"] | "unknown"

```

func (*Type) Descriptor

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

func (*Type) Equal

func (this *Type) Equal(that interface{}) bool

func (*Type) GetDimensions

func (m *Type) GetDimensions() map[string]istio_mixer_v1_config_descriptor.ValueType

func (*Type) GoString

func (this *Type) GoString() string

func (*Type) Marshal

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

func (*Type) MarshalTo

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

func (*Type) ProtoMessage

func (*Type) ProtoMessage()

func (*Type) Reset

func (m *Type) Reset()

func (*Type) Size

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

func (*Type) String

func (this *Type) String() string

func (*Type) Unmarshal

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