remotefilter

Documentation

Overview

Package remotefilter implements the RemoteFilter filter to invokes remote apis.

Index

• Constants
• type RemoteFilter
  • func (rf *RemoteFilter) Close()
  • func (rf *RemoteFilter) Handle(ctx *context.Context) (result string)
  • func (rf *RemoteFilter) Inherit(previousGeneration filters.Filter)
  • func (rf *RemoteFilter) Init()
  • func (rf *RemoteFilter) Kind() *filters.Kind
  • func (rf *RemoteFilter) Name() string
  • func (rf *RemoteFilter) Spec() filters.Spec
  • func (rf *RemoteFilter) Status() interface{}
• type Spec

Constants

const (
	// Kind is the kind of RemoteFilter.
	Kind = "RemoteFilter"
)

Types

type RemoteFilter

type RemoteFilter struct {
	// contains filtered or unexported fields
}

RemoteFilter is the filter making remote service acting like internal filter.

func (*RemoteFilter) Close

func (rf *RemoteFilter) Close()

Close closes RemoteFilter.

func (*RemoteFilter) Handle

func (rf *RemoteFilter) Handle(ctx *context.Context) (result string)

Handle handles Context by calling remote service.

func (*RemoteFilter) Inherit

func (rf *RemoteFilter) Inherit(previousGeneration filters.Filter)

Inherit inherits previous generation of RemoteFilter.

func (*RemoteFilter) Init

func (rf *RemoteFilter) Init()

Init initializes RemoteFilter.

func (*RemoteFilter) Kind

func (rf *RemoteFilter) Kind() *filters.Kind

Kind returns the kind of RemoteFilter.

func (*RemoteFilter) Name

func (rf *RemoteFilter) Name() string

Name returns the name of the RemoteFilter filter instance.

func (*RemoteFilter) Spec

func (rf *RemoteFilter) Spec() filters.Spec

Spec returns the spec used by the RemoteFilter

func (*RemoteFilter) Status

func (rf *RemoteFilter) Status() interface{}

Status returns status.

type Spec

type Spec struct {
	filters.BaseSpec `json:",inline"`

	URL     string `json:"url" jsonschema:"required,format=uri"`
	Timeout string `json:"timeout,omitempty" jsonschema:"format=duration"`
	// contains filtered or unexported fields
}

Spec describes RemoteFilter.