keyval

package
v0.0.0-...-1a56975 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 23, 2019 License: Apache-2.0 Imports: 17 Imported by: 0

Documentation

Overview

Package keyval contains the sources for a demo route directive adapter.

Index

Constants

View Source 
const TemplateName = "keyval"

Fully qualified name of the template

Variables

View Source 
var (
	ErrInvalidLengthConfig = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowConfig   = fmt.Errorf("proto: integer overflow")
)
View Source 
var (
	ErrInvalidLengthTemplateHandlerService = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowTemplateHandlerService   = fmt.Errorf("proto: integer overflow")
)

Functions

func RegisterHandleKeyvalServiceServer 

func RegisterHandleKeyvalServiceServer(s *grpc.Server, srv HandleKeyvalServiceServer)

Types

type HandleKeyvalRequest 

type HandleKeyvalRequest struct {
	// 'keyval' instance.
	Instance *InstanceMsg `protobuf:"bytes,1,opt,name=instance,proto3" 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 *types.Any `protobuf:"bytes,2,opt,name=adapter_config,json=adapterConfig,proto3" 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"`
}

Request message for HandleKeyval method.

func (*HandleKeyvalRequest) Descriptor 

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

func (*HandleKeyvalRequest) Marshal 

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

func (*HandleKeyvalRequest) MarshalTo 

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

func (*HandleKeyvalRequest) ProtoMessage 

func (*HandleKeyvalRequest) ProtoMessage()

func (*HandleKeyvalRequest) Reset 

func (m *HandleKeyvalRequest) Reset()

func (*HandleKeyvalRequest) Size 

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

func (*HandleKeyvalRequest) String 

func (this *HandleKeyvalRequest) String() string

func (*HandleKeyvalRequest) Unmarshal 

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

func (*HandleKeyvalRequest) XXX_DiscardUnknown 

func (m *HandleKeyvalRequest) XXX_DiscardUnknown()

func (*HandleKeyvalRequest) XXX_Marshal 

func (m *HandleKeyvalRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*HandleKeyvalRequest) XXX_Merge 

func (m *HandleKeyvalRequest) XXX_Merge(src proto.Message)

func (*HandleKeyvalRequest) XXX_Size 

func (m *HandleKeyvalRequest) XXX_Size() int

func (*HandleKeyvalRequest) XXX_Unmarshal 

func (m *HandleKeyvalRequest) XXX_Unmarshal(b []byte) error

type HandleKeyvalResponse 

type HandleKeyvalResponse struct {
	Result *v1beta1.CheckResult `protobuf:"bytes,1,opt,name=result,proto3" json:"result,omitempty"`
	Output *OutputMsg           `protobuf:"bytes,2,opt,name=output,proto3" json:"output,omitempty"`
}

func (*HandleKeyvalResponse) Descriptor 

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

func (*HandleKeyvalResponse) Marshal 

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

func (*HandleKeyvalResponse) MarshalTo 

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

func (*HandleKeyvalResponse) ProtoMessage 

func (*HandleKeyvalResponse) ProtoMessage()

func (*HandleKeyvalResponse) Reset 

func (m *HandleKeyvalResponse) Reset()

func (*HandleKeyvalResponse) Size 

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

func (*HandleKeyvalResponse) String 

func (this *HandleKeyvalResponse) String() string

func (*HandleKeyvalResponse) Unmarshal 

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

func (*HandleKeyvalResponse) XXX_DiscardUnknown 

func (m *HandleKeyvalResponse) XXX_DiscardUnknown()

func (*HandleKeyvalResponse) XXX_Marshal 

func (m *HandleKeyvalResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*HandleKeyvalResponse) XXX_Merge 

func (m *HandleKeyvalResponse) XXX_Merge(src proto.Message)

func (*HandleKeyvalResponse) XXX_Size 

func (m *HandleKeyvalResponse) XXX_Size() int

func (*HandleKeyvalResponse) XXX_Unmarshal 

func (m *HandleKeyvalResponse) XXX_Unmarshal(b []byte) error

type HandleKeyvalServiceClient 

type HandleKeyvalServiceClient interface {
	// HandleKeyval is called by Mixer at request-time to deliver 'keyval' instances to the backend.
	HandleKeyval(ctx context.Context, in *HandleKeyvalRequest, opts ...grpc.CallOption) (*HandleKeyvalResponse, error)
}

HandleKeyvalServiceClient is the client API for HandleKeyvalService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewHandleKeyvalServiceClient 

func NewHandleKeyvalServiceClient(cc *grpc.ClientConn) HandleKeyvalServiceClient

type HandleKeyvalServiceServer 

type HandleKeyvalServiceServer interface {
	// HandleKeyval is called by Mixer at request-time to deliver 'keyval' instances to the backend.
	HandleKeyval(context.Context, *HandleKeyvalRequest) (*HandleKeyvalResponse, error)
}

HandleKeyvalServiceServer is the server API for HandleKeyvalService service.

type Handler 

type Handler interface {
	adapter.Handler

	// HandleKeyval is called by Mixer at request time to deliver instances to
	// to an adapter.
	HandleKeyval(context.Context, *Instance) (adapter.CheckResult, *Output, error)
}

Handler must be implemented by adapter code if it wants to process data associated with the 'keyval' 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 'SetKeyvalTypes'. These Type associated with an instance describes the shape of the instance

type HandlerBuilder 

type HandlerBuilder interface {
	adapter.HandlerBuilder

	// SetKeyvalTypes 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.
	SetKeyvalTypes(map[string]*Type)
}

HandlerBuilder must be implemented by adapters if they want to process data associated with the 'keyval' 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

	// lookup key
	Key string
}

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

Input template

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"`
	// lookup key
	Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
}

Contains instance payload for 'keyval' template. This is passed to infrastructure backends during request-time through HandleKeyvalService.HandleKeyval.

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

func (*InstanceMsg) XXX_DiscardUnknown 

func (m *InstanceMsg) XXX_DiscardUnknown()

func (*InstanceMsg) XXX_Marshal 

func (m *InstanceMsg) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*InstanceMsg) XXX_Merge 

func (m *InstanceMsg) XXX_Merge(src proto.Message)

func (*InstanceMsg) XXX_Size 

func (m *InstanceMsg) XXX_Size() int

func (*InstanceMsg) XXX_Unmarshal 

func (m *InstanceMsg) XXX_Unmarshal(b []byte) error

type InstanceParam 

type InstanceParam struct {
	// lookup key
	Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
}

Represents instance configuration schema for 'keyval' 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

func (*InstanceParam) XXX_DiscardUnknown 

func (m *InstanceParam) XXX_DiscardUnknown()

func (*InstanceParam) XXX_Marshal 

func (m *InstanceParam) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*InstanceParam) XXX_Merge 

func (m *InstanceParam) XXX_Merge(src proto.Message)

func (*InstanceParam) XXX_Size 

func (m *InstanceParam) XXX_Size() int

func (*InstanceParam) XXX_Unmarshal 

func (m *InstanceParam) XXX_Unmarshal(b []byte) error

type Keyval 

type Keyval struct{}

Keyval implements the key-value template.

func (Keyval) HandleKeyval 

func (Keyval) HandleKeyval(ctx context.Context, req *HandleKeyvalRequest) (*HandleKeyvalResponse, error)

HandleKeyval implements the gRPC stub

type Output 

type Output struct {

	// value to return
	Value string
	// contains filtered or unexported fields
}

Output struct is returned by the attribute producing adapters that handle this template.

Output template

func NewOutput 

func NewOutput() *Output

func (*Output) SetValue 

func (o *Output) SetValue(val string)

func (*Output) WasSet 

func (o *Output) WasSet(field string) bool

type OutputMsg 

type OutputMsg struct {
	// value to return
	Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
}

Contains output payload for 'keyval' template.

func (*OutputMsg) Descriptor 

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

func (*OutputMsg) Marshal 

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

func (*OutputMsg) MarshalTo 

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

func (*OutputMsg) ProtoMessage 

func (*OutputMsg) ProtoMessage()

func (*OutputMsg) Reset 

func (m *OutputMsg) Reset()

func (*OutputMsg) Size 

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

func (*OutputMsg) String 

func (this *OutputMsg) String() string

func (*OutputMsg) Unmarshal 

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

func (*OutputMsg) XXX_DiscardUnknown 

func (m *OutputMsg) XXX_DiscardUnknown()

func (*OutputMsg) XXX_Marshal 

func (m *OutputMsg) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*OutputMsg) XXX_Merge 

func (m *OutputMsg) XXX_Merge(src proto.Message)

func (*OutputMsg) XXX_Size 

func (m *OutputMsg) XXX_Size() int

func (*OutputMsg) XXX_Unmarshal 

func (m *OutputMsg) XXX_Unmarshal(b []byte) error

type Params 

type Params struct {
	// Lookup table
	Table map[string]string `` /* 151-byte string literal not displayed */
}

Adapter parameters

func (*Params) Descriptor 

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

func (*Params) Equal 

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

func (*Params) GetTable 

func (m *Params) GetTable() map[string]string

func (*Params) GoString 

func (this *Params) GoString() string

func (*Params) Marshal 

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

func (*Params) MarshalTo 

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

func (*Params) ProtoMessage 

func (*Params) ProtoMessage()

func (*Params) Reset 

func (m *Params) Reset()

func (*Params) Size 

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

func (*Params) String 

func (this *Params) String() string

func (*Params) Unmarshal 

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

func (*Params) XXX_DiscardUnknown 

func (m *Params) XXX_DiscardUnknown()

func (*Params) XXX_Marshal 

func (m *Params) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Params) XXX_Merge 

func (m *Params) XXX_Merge(src proto.Message)

func (*Params) XXX_Size 

func (m *Params) XXX_Size() int

func (*Params) XXX_Unmarshal 

func (m *Params) XXX_Unmarshal(b []byte) error

type Type 

type Type struct {
}

Contains inferred type information about specific instance of 'keyval' 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

func (*Type) XXX_DiscardUnknown 

func (m *Type) XXX_DiscardUnknown()

func (*Type) XXX_Marshal 

func (m *Type) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Type) XXX_Merge 

func (m *Type) XXX_Merge(src proto.Message)

func (*Type) XXX_Size 

func (m *Type) XXX_Size() int

func (*Type) XXX_Unmarshal 

func (m *Type) XXX_Unmarshal(b []byte) error

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.