builder

package
v2.7.4 Latest Latest
Warning

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

 Go to latest Published: Feb 18, 2025 License: Apache-2.0 Imports: 23 Imported by: 0

Documentation

Overview

Package builder implements builder filters.

Index

Constants

View Source 
const (
	// DataBuilderKind is the kind of DataBuilder.
	DataBuilderKind = "DataBuilder"
)
View Source 
const (
	// RequestAdaptorKind is the kind of RequestAdaptor.
	RequestAdaptorKind = "RequestAdaptor"
)
View Source 
const (
	// RequestBuilderKind is the kind of RequestBuilder.
	RequestBuilderKind = "RequestBuilder"
)
View Source 
const (
	// ResponseAdaptorKind is the kind of ResponseAdaptor.
	ResponseAdaptorKind = "ResponseAdaptor"
)
View Source 
const (
	// ResponseBuilderKind is the kind of ResponseBuilder.
	ResponseBuilderKind = "ResponseBuilder"
)
View Source 
const (
	// ResultBuilderKind is the kind of ResultBuilder.
	ResultBuilderKind = "ResultBuilder"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Builder 

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

Builder is the base HTTP builder.

func (*Builder) Close 

func (b *Builder) Close()

Close closes Builder.

func (*Builder) Status 

func (b *Builder) Status() interface{}

Status returns status.

type DataBuilder 

type DataBuilder struct {
	Builder
	// contains filtered or unexported fields
}

DataBuilder is filter DataBuilder.

func (*DataBuilder) Handle 

func (db *DataBuilder) Handle(ctx *context.Context) (result string)

Handle builds request.

func (*DataBuilder) Inherit 

func (db *DataBuilder) Inherit(previousGeneration filters.Filter)

Inherit inherits previous generation of DataBuilder.

func (*DataBuilder) Init 

func (db *DataBuilder) Init()

Init initializes DataBuilder.

func (*DataBuilder) Kind 

func (db *DataBuilder) Kind() *filters.Kind

Kind returns the kind of DataBuilder.

func (*DataBuilder) Name 

func (db *DataBuilder) Name() string

Name returns the name of the DataBuilder filter instance.

func (*DataBuilder) Spec 

func (db *DataBuilder) Spec() filters.Spec

Spec returns the spec used by the DataBuilder

type DataBuilderSpec 

type DataBuilderSpec struct {
	filters.BaseSpec `json:",inline"`
	Spec             `json:",inline"`
	DataKey          string `json:"dataKey,omitempty"`
}

DataBuilderSpec is DataBuilder Spec.

func (*DataBuilderSpec) Validate 

func (spec *DataBuilderSpec) Validate() error

Validate validates the DataBuilder Spec.

type RequestAdaptor 

type RequestAdaptor struct {
	Builder
	// contains filtered or unexported fields
}

RequestAdaptor is filter RequestAdaptor.

func (*RequestAdaptor) Close 

func (ra *RequestAdaptor) Close()

Close closes RequestAdaptor.

func (*RequestAdaptor) Handle 

func (ra *RequestAdaptor) Handle(ctx *context.Context) string

Handle adapts request.

func (*RequestAdaptor) Inherit 

func (ra *RequestAdaptor) Inherit(previousGeneration filters.Filter)

Inherit inherits previous generation of RequestAdaptor.

func (*RequestAdaptor) Init 

func (ra *RequestAdaptor) Init()

Init initializes RequestAdaptor.

func (*RequestAdaptor) Kind 

func (ra *RequestAdaptor) Kind() *filters.Kind

Kind returns the kind of RequestAdaptor.

func (*RequestAdaptor) Name 

func (ra *RequestAdaptor) Name() string

Name returns the name of the RequestAdaptor filter instance.

func (*RequestAdaptor) Spec 

func (ra *RequestAdaptor) Spec() filters.Spec

Spec returns the spec used by the RequestAdaptor

func (*RequestAdaptor) Status 

func (ra *RequestAdaptor) Status() interface{}

Status returns status.

type RequestAdaptorSpec 

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

	RequestAdaptorTemplate `json:",inline"`
	Compress               string      `json:"compress,omitempty"`
	Decompress             string      `json:"decompress,omitempty"`
	Sign                   *SignerSpec `json:"sign,omitempty"`
}

RequestAdaptorSpec is HTTPAdaptor RequestAdaptorSpec.

func (*RequestAdaptorSpec) Validate 

func (spec *RequestAdaptorSpec) Validate() error

Validate verifies that at least one of the validations is defined.

type RequestAdaptorTemplate 

type RequestAdaptorTemplate struct {
	Host   string                `json:"host,omitempty"`
	Method string                `json:"method,omitempty" jsonschema:"format=httpmethod"`
	Path   *pathadaptor.Spec     `json:"path,omitempty"`
	Header *httpheader.AdaptSpec `json:"header,omitempty"`
	Body   string                `json:"body,omitempty"`
}

RequestAdaptorTemplate is the template of the request adaptor.

type RequestBuilder 

type RequestBuilder struct {
	Builder
	// contains filtered or unexported fields
}

RequestBuilder is filter RequestBuilder.

func (*RequestBuilder) Handle 

func (rb *RequestBuilder) Handle(ctx *context.Context) (result string)

Handle builds request.

func (*RequestBuilder) Inherit 

func (rb *RequestBuilder) Inherit(previousGeneration filters.Filter)

Inherit inherits previous generation of RequestBuilder.

func (*RequestBuilder) Init 

func (rb *RequestBuilder) Init()

Init initializes RequestBuilder.

func (*RequestBuilder) Kind 

func (rb *RequestBuilder) Kind() *filters.Kind

Kind returns the kind of RequestBuilder.

func (*RequestBuilder) Name 

func (rb *RequestBuilder) Name() string

Name returns the name of the RequestBuilder filter instance.

func (*RequestBuilder) Spec 

func (rb *RequestBuilder) Spec() filters.Spec

Spec returns the spec used by the RequestBuilder

type RequestBuilderSpec 

type RequestBuilderSpec struct {
	filters.BaseSpec `json:",inline"`
	Spec             `json:",inline"`
	SourceNamespace  string `json:"sourceNamespace,omitempty"`
	Protocol         string `json:"protocol,omitempty"`
}

RequestBuilderSpec is RequestBuilder Spec.

func (*RequestBuilderSpec) Validate 

func (spec *RequestBuilderSpec) Validate() error

Validate validates the RequestBuilder Spec.

type ResponseAdaptor 

type ResponseAdaptor struct {
	Builder
	// contains filtered or unexported fields
}

ResponseAdaptor is filter ResponseAdaptor.

func (*ResponseAdaptor) Close 

func (ra *ResponseAdaptor) Close()

Close closes ResponseAdaptor.

func (*ResponseAdaptor) Handle 

func (ra *ResponseAdaptor) Handle(ctx *context.Context) string

Handle adapts response.

func (*ResponseAdaptor) Inherit 

func (ra *ResponseAdaptor) Inherit(previousGeneration filters.Filter)

Inherit inherits previous generation of ResponseAdaptor.

func (*ResponseAdaptor) Init 

func (ra *ResponseAdaptor) Init()

Init initializes ResponseAdaptor.

func (*ResponseAdaptor) Kind 

func (ra *ResponseAdaptor) Kind() *filters.Kind

Kind returns the kind of ResponseAdaptor.

func (*ResponseAdaptor) Name 

func (ra *ResponseAdaptor) Name() string

Name returns the name of the ResponseAdaptor filter instance.

func (*ResponseAdaptor) Spec 

func (ra *ResponseAdaptor) Spec() filters.Spec

Spec returns the spec used by the ResponseAdaptor

func (*ResponseAdaptor) Status 

func (ra *ResponseAdaptor) Status() interface{}

Status returns status.

type ResponseAdaptorSpec 

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

	ResponseAdaptorTemplate `json:",inline"`
	Compress                string `json:"compress,omitempty"`
	Decompress              string `json:"decompress,omitempty"`
}

ResponseAdaptorSpec is HTTPAdaptor ResponseAdaptorSpec.

type ResponseAdaptorTemplate 

type ResponseAdaptorTemplate struct {
	Header *httpheader.AdaptSpec `json:"header,omitempty"`
	Body   string                `json:"body,omitempty"`
}

ResponseAdaptorTemplate is the template of ResponseAdaptor.

type ResponseBuilder 

type ResponseBuilder struct {
	Builder
	// contains filtered or unexported fields
}

ResponseBuilder is filter ResponseBuilder.

func (*ResponseBuilder) Handle 

func (rb *ResponseBuilder) Handle(ctx *context.Context) (result string)

Handle builds request.

func (*ResponseBuilder) Inherit 

func (rb *ResponseBuilder) Inherit(previousGeneration filters.Filter)

Inherit inherits previous generation of ResponseBuilder.

func (*ResponseBuilder) Init 

func (rb *ResponseBuilder) Init()

Init initializes ResponseBuilder.

func (*ResponseBuilder) Kind 

func (rb *ResponseBuilder) Kind() *filters.Kind

Kind returns the kind of ResponseBuilder.

func (*ResponseBuilder) Name 

func (rb *ResponseBuilder) Name() string

Name returns the name of the ResponseBuilder filter instance.

func (*ResponseBuilder) Spec 

func (rb *ResponseBuilder) Spec() filters.Spec

Spec returns the spec used by the ResponseBuilder

type ResponseBuilderSpec 

type ResponseBuilderSpec struct {
	filters.BaseSpec `json:",inline"`
	Spec             `json:",inline"`
	SourceNamespace  string `json:"sourceNamespace,omitempty"`
	Protocol         string `json:"protocol,omitempty"`
}

ResponseBuilderSpec is ResponseBuilder Spec.

func (*ResponseBuilderSpec) Validate 

func (spec *ResponseBuilderSpec) Validate() error

Validate validates the ResponseBuilder Spec.

type ResultBuilder 

type ResultBuilder struct {
	Builder
	// contains filtered or unexported fields
}

ResultBuilder is filter ResultBuilder.

func (*ResultBuilder) Handle 

func (rb *ResultBuilder) Handle(ctx *context.Context) (result string)

Handle builds result.

func (*ResultBuilder) Inherit 

func (rb *ResultBuilder) Inherit(previousGeneration filters.Filter)

Inherit inherits previous generation of ResultBuilder.

func (*ResultBuilder) Init 

func (rb *ResultBuilder) Init()

Init initializes ResultBuilder.

func (*ResultBuilder) Kind 

func (rb *ResultBuilder) Kind() *filters.Kind

Kind returns the kind of ResultBuilder.

func (*ResultBuilder) Name 

func (rb *ResultBuilder) Name() string

Name returns the name of the ResultBuilder filter instance.

func (*ResultBuilder) Spec 

func (rb *ResultBuilder) Spec() filters.Spec

Spec returns the spec used by the ResultBuilder

type ResultBuilderSpec 

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

ResultBuilderSpec is ResultBuilder Spec.

func (*ResultBuilderSpec) Validate 

func (spec *ResultBuilderSpec) Validate() error

Validate validates the ResultBuilder Spec.

type SignerSpec 

type SignerSpec struct {
	signer.Spec `json:",inline"`
	APIProvider string   `json:"apiProvider,omitempty" jsonschema:"enum=,enum=aws4"`
	Scopes      []string `json:"scopes,omitempty"`
}

SignerSpec is the spec of the request signer.

type Spec 

type Spec struct {
	LeftDelim  string `json:"leftDelim,omitempty"`
	RightDelim string `json:"rightDelim,omitempty"`
	Template   string `json:"template,omitempty"`
}

Spec is the spec of Builder.

func (*Spec) Validate 

func (spec *Spec) Validate() error

Validate validates the Builder Spec.

Source Files

View all Source files

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.