checknothing

Documentation

Overview

Package checknothing is a generated protocol buffer package.

The `checknothing` template represents an empty block of data, which can useful in different testing scenarios.

Example config:

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

name: denyrequest
namespace: istio-system

spec: ```

CheckNothing represents an empty block of data that is used for Check-capable adapters which don't require any parameters. This is primarily intended for testing scenarios.

It is generated from these files:

mixer/template/checknothing/template_handler_service.proto

It has these top-level messages:

HandleCheckNothingRequest
InstanceMsg
Type
InstanceParam

Index

• Constants
• Variables
• func RegisterHandleCheckNothingServiceServer(s *grpc.Server, srv HandleCheckNothingServiceServer)
• type HandleCheckNothingRequest
  • func (*HandleCheckNothingRequest) Descriptor() ([]byte, []int)
  • func (m *HandleCheckNothingRequest) Marshal() (dAtA []byte, err error)
  • func (m *HandleCheckNothingRequest) MarshalTo(dAtA []byte) (int, error)
  • func (*HandleCheckNothingRequest) ProtoMessage()
  • func (m *HandleCheckNothingRequest) Reset()
  • func (m *HandleCheckNothingRequest) Size() (n int)
  • func (this *HandleCheckNothingRequest) String() string
  • func (m *HandleCheckNothingRequest) Unmarshal(dAtA []byte) error
• type HandleCheckNothingServiceClient
  • func NewHandleCheckNothingServiceClient(cc *grpc.ClientConn) HandleCheckNothingServiceClient
• type HandleCheckNothingServiceServer
• 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 = "checknothing"

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 RegisterHandleCheckNothingServiceServer

func RegisterHandleCheckNothingServiceServer(s *grpc.Server, srv HandleCheckNothingServiceServer)

Types

type HandleCheckNothingRequest

type HandleCheckNothingRequest struct {
	// 'checknothing' 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 HandleCheckNothing method.

func (*HandleCheckNothingRequest) Descriptor

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

func (*HandleCheckNothingRequest) Marshal

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

func (*HandleCheckNothingRequest) MarshalTo

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

func (*HandleCheckNothingRequest) ProtoMessage

func (*HandleCheckNothingRequest) ProtoMessage()

func (*HandleCheckNothingRequest) Reset

func (m *HandleCheckNothingRequest) Reset()

func (*HandleCheckNothingRequest) Size

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

func (*HandleCheckNothingRequest) String

func (this *HandleCheckNothingRequest) String() string

func (*HandleCheckNothingRequest) Unmarshal

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

type HandleCheckNothingServiceClient

type HandleCheckNothingServiceClient interface {
	// HandleCheckNothing is called by Mixer at request-time to deliver 'checknothing' instances to the backend.
	HandleCheckNothing(ctx context.Context, in *HandleCheckNothingRequest, opts ...grpc.CallOption) (*istio_mixer_adapter_model_v1beta11.CheckResult, error)
}

func NewHandleCheckNothingServiceClient

func NewHandleCheckNothingServiceClient(cc *grpc.ClientConn) HandleCheckNothingServiceClient

type HandleCheckNothingServiceServer

type HandleCheckNothingServiceServer interface {
	// HandleCheckNothing is called by Mixer at request-time to deliver 'checknothing' instances to the backend.
	HandleCheckNothing(context.Context, *HandleCheckNothingRequest) (*istio_mixer_adapter_model_v1beta11.CheckResult, error)
}

type Handler

type Handler interface {
	adapter.Handler

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

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

type HandlerBuilder

type HandlerBuilder interface {
	adapter.HandlerBuilder

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

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

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

CheckNothing represents an empty block of data that is used for Check-capable adapters which don't require any parameters. This is primarily intended for testing scenarios.

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"`
}

Contains instance payload for 'checknothing' template. This is passed to infrastructure backends during request-time through HandleCheckNothingService.HandleCheckNothing.

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 {
}

Represents instance configuration schema for 'checknothing' 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 {
}

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