Documentation

Overview

Package checkproducer is a generated protocol buffer package.

input template

It is generated from these files:

mixer/test/spyAdapter/template/checkoutput/tmpl_handler_service.proto

It has these top-level messages:

HandleCheckProducerRequest
HandleCheckProducerResponse
OutputMsg
InstanceMsg
Type
InstanceParam

Index

Constants

View Source
const TemplateName = "checkproducer"

Fully qualified name of the template

Variables

View Source
var (
	ErrInvalidLengthTmplHandlerService = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowTmplHandlerService   = fmt.Errorf("proto: integer overflow")
)

Functions

func RegisterHandleCheckProducerServiceServer

func RegisterHandleCheckProducerServiceServer(s *grpc.Server, srv HandleCheckProducerServiceServer)

Types

type HandleCheckProducerRequest

type HandleCheckProducerRequest struct {
	// 'checkproducer' 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"`
}

Request message for HandleCheckProducer method.

func (*HandleCheckProducerRequest) Descriptor

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

func (*HandleCheckProducerRequest) Marshal

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

func (*HandleCheckProducerRequest) MarshalTo

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

func (*HandleCheckProducerRequest) ProtoMessage

func (*HandleCheckProducerRequest) ProtoMessage()

func (*HandleCheckProducerRequest) Reset

func (m *HandleCheckProducerRequest) Reset()

func (*HandleCheckProducerRequest) Size

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

func (*HandleCheckProducerRequest) String

func (this *HandleCheckProducerRequest) String() string

func (*HandleCheckProducerRequest) Unmarshal

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

type HandleCheckProducerResponse

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

func (*HandleCheckProducerResponse) Descriptor

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

func (*HandleCheckProducerResponse) Marshal

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

func (*HandleCheckProducerResponse) MarshalTo

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

func (*HandleCheckProducerResponse) ProtoMessage

func (*HandleCheckProducerResponse) ProtoMessage()

func (*HandleCheckProducerResponse) Reset

func (m *HandleCheckProducerResponse) Reset()

func (*HandleCheckProducerResponse) Size

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

func (*HandleCheckProducerResponse) String

func (this *HandleCheckProducerResponse) String() string

func (*HandleCheckProducerResponse) Unmarshal

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

type HandleCheckProducerServiceClient

type HandleCheckProducerServiceClient interface {
	// HandleCheckProducer is called by Mixer at request-time to deliver 'checkproducer' instances to the backend.
	HandleCheckProducer(ctx context.Context, in *HandleCheckProducerRequest, opts ...grpc.CallOption) (*HandleCheckProducerResponse, error)
}

func NewHandleCheckProducerServiceClient

func NewHandleCheckProducerServiceClient(cc *grpc.ClientConn) HandleCheckProducerServiceClient

type HandleCheckProducerServiceServer

type HandleCheckProducerServiceServer interface {
	// HandleCheckProducer is called by Mixer at request-time to deliver 'checkproducer' instances to the backend.
	HandleCheckProducer(context.Context, *HandleCheckProducerRequest) (*HandleCheckProducerResponse, error)
}

type Handler

type Handler interface {
	adapter.Handler

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

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

type HandlerBuilder

type HandlerBuilder interface {
	adapter.HandlerBuilder

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

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

	StringPrimitive string
}

Instance is constructed by Mixer for the 'checkproducer' 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"`
	StringPrimitive string `protobuf:"bytes,4,opt,name=stringPrimitive,proto3" json:"stringPrimitive,omitempty"`
}

Contains instance payload for 'checkproducer' template. This is passed to infrastructure backends during request-time through HandleCheckProducerService.HandleCheckProducer.

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 {
	StringPrimitive string `protobuf:"bytes,4,opt,name=stringPrimitive,proto3" json:"stringPrimitive,omitempty"`
}

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

type Output struct {
	Int64Primitive int64

	BoolPrimitive bool

	DoublePrimitive float64

	StringPrimitive string

	StringMap map[string]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) SetBoolPrimitive

func (o *Output) SetBoolPrimitive(val bool)

func (*Output) SetDoublePrimitive

func (o *Output) SetDoublePrimitive(val float64)

func (*Output) SetInt64Primitive

func (o *Output) SetInt64Primitive(val int64)

func (*Output) SetStringMap

func (o *Output) SetStringMap(val map[string]string)

func (*Output) SetStringPrimitive

func (o *Output) SetStringPrimitive(val string)

func (*Output) WasSet

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

type OutputMsg

type OutputMsg struct {
	Int64Primitive  int64             `protobuf:"varint,1,opt,name=int64Primitive,proto3" json:"int64Primitive,omitempty"`
	BoolPrimitive   bool              `protobuf:"varint,2,opt,name=boolPrimitive,proto3" json:"boolPrimitive,omitempty"`
	DoublePrimitive float64           `protobuf:"fixed64,3,opt,name=doublePrimitive,proto3" json:"doublePrimitive,omitempty"`
	StringPrimitive string            `protobuf:"bytes,4,opt,name=stringPrimitive,proto3" json:"stringPrimitive,omitempty"`
	StringMap       map[string]string `` /* 152-byte string literal not displayed */
}

Contains output payload for 'checkproducer' 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

type Type

type Type struct {
}

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