Documentation ¶
Index ¶
- Constants
- Variables
- func RegisterHandleApiKeyServiceServer(s *grpc.Server, srv HandleApiKeyServiceServer)
- type HandleApiKeyRequest
- func (*HandleApiKeyRequest) Descriptor() ([]byte, []int)
- func (m *HandleApiKeyRequest) Marshal() (dAtA []byte, err error)
- func (m *HandleApiKeyRequest) MarshalTo(dAtA []byte) (int, error)
- func (*HandleApiKeyRequest) ProtoMessage()
- func (m *HandleApiKeyRequest) Reset()
- func (m *HandleApiKeyRequest) Size() (n int)
- func (this *HandleApiKeyRequest) String() string
- func (m *HandleApiKeyRequest) Unmarshal(dAtA []byte) error
- func (m *HandleApiKeyRequest) XXX_DiscardUnknown()
- func (m *HandleApiKeyRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *HandleApiKeyRequest) XXX_Merge(src proto.Message)
- func (m *HandleApiKeyRequest) XXX_Size() int
- func (m *HandleApiKeyRequest) XXX_Unmarshal(b []byte) error
- type HandleApiKeyServiceClient
- type HandleApiKeyServiceServer
- 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
- func (m *InstanceMsg) XXX_DiscardUnknown()
- func (m *InstanceMsg) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *InstanceMsg) XXX_Merge(src proto.Message)
- func (m *InstanceMsg) XXX_Size() int
- func (m *InstanceMsg) XXX_Unmarshal(b []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
- func (m *InstanceParam) XXX_DiscardUnknown()
- func (m *InstanceParam) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *InstanceParam) XXX_Merge(src proto.Message)
- func (m *InstanceParam) XXX_Size() int
- func (m *InstanceParam) XXX_Unmarshal(b []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
- func (m *Type) XXX_DiscardUnknown()
- func (m *Type) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *Type) XXX_Merge(src proto.Message)
- func (m *Type) XXX_Size() int
- func (m *Type) XXX_Unmarshal(b []byte) error
Constants ¶
const TemplateName = "apikey"
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 RegisterHandleApiKeyServiceServer ¶
func RegisterHandleApiKeyServiceServer(s *grpc.Server, srv HandleApiKeyServiceServer)
Types ¶
type HandleApiKeyRequest ¶
type HandleApiKeyRequest struct { // 'apikey' 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 HandleApiKey method.
func (*HandleApiKeyRequest) Descriptor ¶
func (*HandleApiKeyRequest) Descriptor() ([]byte, []int)
func (*HandleApiKeyRequest) Marshal ¶
func (m *HandleApiKeyRequest) Marshal() (dAtA []byte, err error)
func (*HandleApiKeyRequest) MarshalTo ¶
func (m *HandleApiKeyRequest) MarshalTo(dAtA []byte) (int, error)
func (*HandleApiKeyRequest) ProtoMessage ¶
func (*HandleApiKeyRequest) ProtoMessage()
func (*HandleApiKeyRequest) Reset ¶
func (m *HandleApiKeyRequest) Reset()
func (*HandleApiKeyRequest) Size ¶
func (m *HandleApiKeyRequest) Size() (n int)
func (*HandleApiKeyRequest) String ¶
func (this *HandleApiKeyRequest) String() string
func (*HandleApiKeyRequest) Unmarshal ¶
func (m *HandleApiKeyRequest) Unmarshal(dAtA []byte) error
func (*HandleApiKeyRequest) XXX_DiscardUnknown ¶
func (m *HandleApiKeyRequest) XXX_DiscardUnknown()
func (*HandleApiKeyRequest) XXX_Marshal ¶
func (m *HandleApiKeyRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*HandleApiKeyRequest) XXX_Merge ¶
func (m *HandleApiKeyRequest) XXX_Merge(src proto.Message)
func (*HandleApiKeyRequest) XXX_Size ¶
func (m *HandleApiKeyRequest) XXX_Size() int
func (*HandleApiKeyRequest) XXX_Unmarshal ¶
func (m *HandleApiKeyRequest) XXX_Unmarshal(b []byte) error
type HandleApiKeyServiceClient ¶
type HandleApiKeyServiceClient interface { // HandleApiKey is called by Mixer at request-time to deliver 'apikey' instances to the backend. HandleApiKey(ctx context.Context, in *HandleApiKeyRequest, opts ...grpc.CallOption) (*v1beta11.CheckResult, error) }
HandleApiKeyServiceClient is the client API for HandleApiKeyService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
func NewHandleApiKeyServiceClient ¶
func NewHandleApiKeyServiceClient(cc *grpc.ClientConn) HandleApiKeyServiceClient
type HandleApiKeyServiceServer ¶
type HandleApiKeyServiceServer interface { // HandleApiKey is called by Mixer at request-time to deliver 'apikey' instances to the backend. HandleApiKey(context.Context, *HandleApiKeyRequest) (*v1beta11.CheckResult, error) }
HandleApiKeyServiceServer is the server API for HandleApiKeyService service.
type Handler ¶
type Handler interface { adapter.Handler // HandleApiKey is called by Mixer at request time to deliver instances to // to an adapter. HandleApiKey(context.Context, *Instance) (adapter.CheckResult, error) }
Handler must be implemented by adapter code if it wants to process data associated with the 'apikey' 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 'SetApiKeyTypes'. These Type associated with an instance describes the shape of the instance
type HandlerBuilder ¶
type HandlerBuilder interface { adapter.HandlerBuilder // SetApiKeyTypes 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. SetApiKeyTypes(map[string]*Type) }
HandlerBuilder must be implemented by adapters if they want to process data associated with the 'apikey' 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 API being called (api.service). Api string // The version of the API (api.version). ApiVersion string // The API operation is being called. ApiOperation string // API key used in API call. ApiKey string // Timestamp of API call. Timestamp time.Time }
Instance is constructed by Mixer for the 'apikey' template.
The `apikey` template represents a single API key, used to authorize API calls.
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 API being called (api.service). Api string `protobuf:"bytes,1,opt,name=api,proto3" json:"api,omitempty"` // The version of the API (api.version). ApiVersion string `protobuf:"bytes,2,opt,name=api_version,json=apiVersion,proto3" json:"api_version,omitempty"` // The API operation is being called. ApiOperation string `protobuf:"bytes,3,opt,name=api_operation,json=apiOperation,proto3" json:"api_operation,omitempty"` // API key used in API call. ApiKey string `protobuf:"bytes,4,opt,name=api_key,json=apiKey,proto3" json:"api_key,omitempty"` // Timestamp of API call. Timestamp *v1beta1.TimeStamp `protobuf:"bytes,5,opt,name=timestamp,proto3" json:"timestamp,omitempty"` }
Contains instance payload for 'apikey' template. This is passed to infrastructure backends during request-time through HandleApiKeyService.HandleApiKey.
func (*InstanceMsg) Descriptor ¶
func (*InstanceMsg) Descriptor() ([]byte, []int)
func (*InstanceMsg) Marshal ¶
func (m *InstanceMsg) Marshal() (dAtA []byte, err 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 { // The API being called (api.service). Api string `protobuf:"bytes,1,opt,name=api,proto3" json:"api,omitempty"` // The version of the API (api.version). ApiVersion string `protobuf:"bytes,2,opt,name=api_version,json=apiVersion,proto3" json:"api_version,omitempty"` // The API operation is being called. ApiOperation string `protobuf:"bytes,3,opt,name=api_operation,json=apiOperation,proto3" json:"api_operation,omitempty"` // API key used in API call. ApiKey string `protobuf:"bytes,4,opt,name=api_key,json=apiKey,proto3" json:"api_key,omitempty"` // Timestamp of API call. Timestamp string `protobuf:"bytes,5,opt,name=timestamp,proto3" json:"timestamp,omitempty"` }
Represents instance configuration schema for 'apikey' template.
func (*InstanceParam) Descriptor ¶
func (*InstanceParam) Descriptor() ([]byte, []int)
func (*InstanceParam) Marshal ¶
func (m *InstanceParam) Marshal() (dAtA []byte, err 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 Type ¶
type Type struct { }
Contains inferred type information about specific instance of 'apikey' template. This is passed to infrastructure backends during configuration-time through [InfrastructureBackend.CreateSession][TODO: Link to this fragment].
func (*Type) Descriptor ¶
func (*Type) ProtoMessage ¶
func (*Type) ProtoMessage()
func (*Type) XXX_DiscardUnknown ¶
func (m *Type) XXX_DiscardUnknown()