quota

Documentation

Overview

Package quota is a generated protocol buffer package.

The `quota` template represents an item for which to check quota.

Example config:

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

name: requestcount
namespace: istio-system

spec:

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

```

The `quota` template 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/policy-and-telemetry/expression-language/). Please note that if the datatype of a field is not istio.policy.v1beta1.Value, then the expression's [inferred type](https://istio.io/docs/reference//config/policy-and-telemetry/expression-language/#type-checking) must match the datatype of the field.

It is generated from these files:

mixer/template/quota/template_handler_service.proto

It has these top-level messages:

HandleQuotaRequest
InstanceMsg
Type
InstanceParam

Index

• Constants
• Variables
• func RegisterHandleQuotaServiceServer(s *grpc.Server, srv HandleQuotaServiceServer)
• type HandleQuotaRequest
  • func (*HandleQuotaRequest) Descriptor() ([]byte, []int)
  • func (m *HandleQuotaRequest) Marshal() (dAtA []byte, err error)
  • func (m *HandleQuotaRequest) MarshalTo(dAtA []byte) (int, error)
  • func (*HandleQuotaRequest) ProtoMessage()
  • func (m *HandleQuotaRequest) Reset()
  • func (m *HandleQuotaRequest) Size() (n int)
  • func (this *HandleQuotaRequest) String() string
  • func (m *HandleQuotaRequest) Unmarshal(dAtA []byte) error
• type HandleQuotaServiceClient
  • func NewHandleQuotaServiceClient(cc *grpc.ClientConn) HandleQuotaServiceClient
• type HandleQuotaServiceServer
• type Handler
• type HandlerBuilder
• type Instance
• type InstanceMsg
  • func (*InstanceMsg) Descriptor() ([]byte, []int)
  • func (m *InstanceMsg) Marshal() (dAtA []byte, err error)
  • func (m *InstanceMsg) MarshalTo(dAtA []byte) (int, error)
  • func (*InstanceMsg) ProtoMessage()
  • func (m *InstanceMsg) Reset()
  • func (m *InstanceMsg) Size() (n int)
  • func (this *InstanceMsg) String() string
  • func (m *InstanceMsg) Unmarshal(dAtA []byte) error
• type InstanceParam
  • func (*InstanceParam) Descriptor() ([]byte, []int)
  • 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 (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 (
	ErrInvalidLengthTemplateHandlerService = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowTemplateHandlerService   = fmt.Errorf("proto: integer overflow")
)

Functions

func RegisterHandleQuotaServiceServer

func RegisterHandleQuotaServiceServer(s *grpc.Server, srv HandleQuotaServiceServer)

Types

type HandleQuotaRequest

type HandleQuotaRequest struct {
	// 'quota' instance.
	Instance *InstanceMsg `protobuf:"bytes,1,opt,name=instance" json:"instance,omitempty"`
	// Adapter specific handler configuration.
	//
	// Note: Backends can also implement [InfrastructureBackend][https://istio.io/docs/reference/config/mixer/istio.mixer.adapter.model.v1beta1.html#InfrastructureBackend]
	// service and therefore opt to receive handler configuration during session creation through [InfrastructureBackend.CreateSession][TODO: Link to this fragment]
	// call. In that case, adapter_config will have type_url as 'google.protobuf.Any.type_url' and would contain string
	// value of session_id (returned from InfrastructureBackend.CreateSession).
	AdapterConfig *google_protobuf1.Any `protobuf:"bytes,2,opt,name=adapter_config,json=adapterConfig" json:"adapter_config,omitempty"`
	// Id to dedupe identical requests from Mixer.
	DedupId string `protobuf:"bytes,3,opt,name=dedup_id,json=dedupId,proto3" json:"dedup_id,omitempty"`
	// Expresses the quota allocation request.
	QuotaRequest *istio_mixer_adapter_model_v1beta11.QuotaRequest `protobuf:"bytes,4,opt,name=quota_request,json=quotaRequest" json:"quota_request,omitempty"`
}

Request message for HandleQuota method.

func (*HandleQuotaRequest) Descriptor

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

func (*HandleQuotaRequest) Marshal

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

func (*HandleQuotaRequest) MarshalTo

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

func (*HandleQuotaRequest) ProtoMessage

func (*HandleQuotaRequest) ProtoMessage()

func (*HandleQuotaRequest) Reset

func (m *HandleQuotaRequest) Reset()

func (*HandleQuotaRequest) Size

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

func (*HandleQuotaRequest) String

func (this *HandleQuotaRequest) String() string

func (*HandleQuotaRequest) Unmarshal

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

type HandleQuotaServiceClient

type HandleQuotaServiceClient interface {
	// HandleQuota is called by Mixer at request-time to deliver 'quota' instances to the backend.
	HandleQuota(ctx context.Context, in *HandleQuotaRequest, opts ...grpc.CallOption) (*istio_mixer_adapter_model_v1beta11.QuotaResult, error)
}

func NewHandleQuotaServiceClient

func NewHandleQuotaServiceClient(cc *grpc.ClientConn) HandleQuotaServiceClient

type HandleQuotaServiceServer

type HandleQuotaServiceServer interface {
	// HandleQuota is called by Mixer at request-time to deliver 'quota' instances to the backend.
	HandleQuota(context.Context, *HandleQuotaRequest) (*istio_mixer_adapter_model_v1beta11.QuotaResult, error)
}

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.

The `quota` template 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/policy-and-telemetry/expression-language/). Please note that if the datatype of a field is not istio.policy.v1beta1.Value, then the expression's [inferred type](https://istio.io/docs/reference//config/policy-and-telemetry/expression-language/#type-checking) must match the datatype of the field.

type InstanceMsg

type InstanceMsg struct {
	// Name of the instance as specified in configuration.
	Name string `protobuf:"bytes,72295727,opt,name=name,proto3" json:"name,omitempty"`
	// The unique identity of the particular quota to manipulate.
	Dimensions map[string]*istio_policy_v1beta11.Value `` /* 147-byte string literal not displayed */
}

Contains instance payload for 'quota' template. This is passed to infrastructure backends during request-time through HandleQuotaService.HandleQuota.

func (*InstanceMsg) Descriptor

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

func (*InstanceMsg) Marshal

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

func (*InstanceMsg) MarshalTo

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

func (*InstanceMsg) ProtoMessage

func (*InstanceMsg) ProtoMessage()

func (*InstanceMsg) Reset

func (m *InstanceMsg) Reset()

func (*InstanceMsg) Size

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

func (*InstanceMsg) String

func (this *InstanceMsg) String() string

func (*InstanceMsg) Unmarshal

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

type InstanceParam

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

Represents instance configuration schema for 'quota' template.

func (*InstanceParam) Descriptor

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

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_policy_v1beta1.ValueType `` /* 191-byte string literal not displayed */
}

Contains inferred type information about specific instance of 'quota' template. This is passed to infrastructure backends during configuration-time through [InfrastructureBackend.CreateSession][TODO: Link to this fragment].

func (*Type) Descriptor

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

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