http_route

package
v0.15.0 Latest Latest
Warning

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

 Go to latest Published: Nov 21, 2024 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var File_http_route_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type HeaderMatch 

type HeaderMatch struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Types that are assignable to Value:
	//
	//	*HeaderMatch_Exact
	//	*HeaderMatch_Regex
	Value isHeaderMatch_Value `protobuf_oneof:"value"`
	// contains filtered or unexported fields
}

Describes how to match a header by name and value.

func (*HeaderMatch) Descriptor deprecated 

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

Deprecated: Use HeaderMatch.ProtoReflect.Descriptor instead.

func (*HeaderMatch) GetExact 

func (x *HeaderMatch) GetExact() []byte

func (*HeaderMatch) GetName 

func (x *HeaderMatch) GetName() string

func (*HeaderMatch) GetRegex 

func (x *HeaderMatch) GetRegex() string

func (*HeaderMatch) GetValue 

func (m *HeaderMatch) GetValue() isHeaderMatch_Value

func (*HeaderMatch) ProtoMessage 

func (*HeaderMatch) ProtoMessage()

func (*HeaderMatch) ProtoReflect 

func (x *HeaderMatch) ProtoReflect() protoreflect.Message

func (*HeaderMatch) Reset 

func (x *HeaderMatch) Reset()

func (*HeaderMatch) String 

func (x *HeaderMatch) String() string

type HeaderMatch_Exact 

type HeaderMatch_Exact struct {
	Exact []byte `protobuf:"bytes,2,opt,name=exact,proto3,oneof"`
}

type HeaderMatch_Regex 

type HeaderMatch_Regex struct {
	Regex string `protobuf:"bytes,3,opt,name=regex,proto3,oneof"`
}

type HostMatch 

type HostMatch struct {

	// Types that are assignable to Match:
	//
	//	*HostMatch_Exact
	//	*HostMatch_Suffix_
	Match isHostMatch_Match `protobuf_oneof:"match"`
	// contains filtered or unexported fields
}

Describes how to match an `:authority` or `host` header.

func (*HostMatch) Descriptor deprecated 

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

Deprecated: Use HostMatch.ProtoReflect.Descriptor instead.

func (*HostMatch) GetExact 

func (x *HostMatch) GetExact() string

func (*HostMatch) GetMatch 

func (m *HostMatch) GetMatch() isHostMatch_Match

func (*HostMatch) GetSuffix 

func (x *HostMatch) GetSuffix() *HostMatch_Suffix

func (*HostMatch) ProtoMessage 

func (*HostMatch) ProtoMessage()

func (*HostMatch) ProtoReflect 

func (x *HostMatch) ProtoReflect() protoreflect.Message

func (*HostMatch) Reset 

func (x *HostMatch) Reset()

func (*HostMatch) String 

func (x *HostMatch) String() string

type HostMatch_Exact 

type HostMatch_Exact struct {
	// Match an exact hostname, e.g. www.example.com.
	Exact string `protobuf:"bytes,1,opt,name=exact,proto3,oneof"`
}

type HostMatch_Suffix 

type HostMatch_Suffix struct {
	ReverseLabels []string `protobuf:"bytes,1,rep,name=reverse_labels,json=reverseLabels,proto3" json:"reverse_labels,omitempty"`
	// contains filtered or unexported fields
}

A match like `*.example.com` is encoded as [com, example].

func (*HostMatch_Suffix) Descriptor deprecated 

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

Deprecated: Use HostMatch_Suffix.ProtoReflect.Descriptor instead.

func (*HostMatch_Suffix) GetReverseLabels 

func (x *HostMatch_Suffix) GetReverseLabels() []string

func (*HostMatch_Suffix) ProtoMessage 

func (*HostMatch_Suffix) ProtoMessage()

func (*HostMatch_Suffix) ProtoReflect 

func (x *HostMatch_Suffix) ProtoReflect() protoreflect.Message

func (*HostMatch_Suffix) Reset 

func (x *HostMatch_Suffix) Reset()

func (*HostMatch_Suffix) String 

func (x *HostMatch_Suffix) String() string

type HostMatch_Suffix_ 

type HostMatch_Suffix_ struct {
	// Match a hostname as a wildcard suffix, e.g. *.example.com.
	Suffix *HostMatch_Suffix `protobuf:"bytes,2,opt,name=suffix,proto3,oneof"`
}

type HttpFailureInjector 

type HttpFailureInjector struct {

	// The status code to use in the HTTP response. Must be specified.
	Status uint32 `protobuf:"varint,1,opt,name=status,proto3" json:"status,omitempty"`
	// An error message to log and include in the `l5d-proxy-err` header.
	Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
	// If specified, the rate of requests that should be failed. If not specified,
	// ALL requests are failed.
	Ratio *Ratio `protobuf:"bytes,3,opt,name=ratio,proto3" json:"ratio,omitempty"`
	// contains filtered or unexported fields
}

Configures a route to respond with a fixed response.

func (*HttpFailureInjector) Descriptor deprecated 

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

Deprecated: Use HttpFailureInjector.ProtoReflect.Descriptor instead.

func (*HttpFailureInjector) GetMessage 

func (x *HttpFailureInjector) GetMessage() string

func (*HttpFailureInjector) GetRatio 

func (x *HttpFailureInjector) GetRatio() *Ratio

func (*HttpFailureInjector) GetStatus 

func (x *HttpFailureInjector) GetStatus() uint32

func (*HttpFailureInjector) ProtoMessage 

func (*HttpFailureInjector) ProtoMessage()

func (*HttpFailureInjector) ProtoReflect 

func (x *HttpFailureInjector) ProtoReflect() protoreflect.Message

func (*HttpFailureInjector) Reset 

func (x *HttpFailureInjector) Reset()

func (*HttpFailureInjector) String 

func (x *HttpFailureInjector) String() string

type HttpRouteMatch 

type HttpRouteMatch struct {

	// Matches requests by path.
	Path *PathMatch `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
	// A set of header value matches that must be satisified. This match is not
	// comprehensive, so requests may include headers that are not covered by this
	// match.
	Headers []*HeaderMatch `protobuf:"bytes,2,rep,name=headers,proto3" json:"headers,omitempty"`
	// A set of query parmaeter value matches that must be satisified. This match
	// is not comprehensive, so requests may include query parameters that are not
	// covered by this match.
	QueryParams []*QueryParamMatch `protobuf:"bytes,3,rep,name=query_params,json=queryParams,proto3" json:"query_params,omitempty"`
	// If specified, restricts the match to a single HTTP method.
	Method *http_types.HttpMethod `protobuf:"bytes,4,opt,name=method,proto3" json:"method,omitempty"`
	// contains filtered or unexported fields
}

Describes a set of matches, ALL of which must apply.

func (*HttpRouteMatch) Descriptor deprecated 

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

Deprecated: Use HttpRouteMatch.ProtoReflect.Descriptor instead.

func (*HttpRouteMatch) GetHeaders 

func (x *HttpRouteMatch) GetHeaders() []*HeaderMatch

func (*HttpRouteMatch) GetMethod 

func (x *HttpRouteMatch) GetMethod() *http_types.HttpMethod

func (*HttpRouteMatch) GetPath 

func (x *HttpRouteMatch) GetPath() *PathMatch

func (*HttpRouteMatch) GetQueryParams 

func (x *HttpRouteMatch) GetQueryParams() []*QueryParamMatch

func (*HttpRouteMatch) ProtoMessage 

func (*HttpRouteMatch) ProtoMessage()

func (*HttpRouteMatch) ProtoReflect 

func (x *HttpRouteMatch) ProtoReflect() protoreflect.Message

func (*HttpRouteMatch) Reset 

func (x *HttpRouteMatch) Reset()

func (*HttpRouteMatch) String 

func (x *HttpRouteMatch) String() string

type PathMatch 

type PathMatch struct {

	// Types that are assignable to Kind:
	//
	//	*PathMatch_Exact
	//	*PathMatch_Prefix
	//	*PathMatch_Regex
	Kind isPathMatch_Kind `protobuf_oneof:"kind"`
	// contains filtered or unexported fields
}

Describes how to match a path.

func (*PathMatch) Descriptor deprecated 

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

Deprecated: Use PathMatch.ProtoReflect.Descriptor instead.

func (*PathMatch) GetExact 

func (x *PathMatch) GetExact() string

func (*PathMatch) GetKind 

func (m *PathMatch) GetKind() isPathMatch_Kind

func (*PathMatch) GetPrefix 

func (x *PathMatch) GetPrefix() string

func (*PathMatch) GetRegex 

func (x *PathMatch) GetRegex() string

func (*PathMatch) ProtoMessage 

func (*PathMatch) ProtoMessage()

func (*PathMatch) ProtoReflect 

func (x *PathMatch) ProtoReflect() protoreflect.Message

func (*PathMatch) Reset 

func (x *PathMatch) Reset()

func (*PathMatch) String 

func (x *PathMatch) String() string

type PathMatch_Exact 

type PathMatch_Exact struct {
	Exact string `protobuf:"bytes,1,opt,name=exact,proto3,oneof"`
}

type PathMatch_Prefix 

type PathMatch_Prefix struct {
	Prefix string `protobuf:"bytes,2,opt,name=prefix,proto3,oneof"`
}

type PathMatch_Regex 

type PathMatch_Regex struct {
	Regex string `protobuf:"bytes,3,opt,name=regex,proto3,oneof"`
}

type PathModifier 

type PathModifier struct {

	// Types that are assignable to Replace:
	//
	//	*PathModifier_Full
	//	*PathModifier_Prefix
	Replace isPathModifier_Replace `protobuf_oneof:"replace"`
	// contains filtered or unexported fields
}

Describes how a path value may be rewritten in a route.

func (*PathModifier) Descriptor deprecated 

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

Deprecated: Use PathModifier.ProtoReflect.Descriptor instead.

func (*PathModifier) GetFull 

func (x *PathModifier) GetFull() string

func (*PathModifier) GetPrefix 

func (x *PathModifier) GetPrefix() string

func (*PathModifier) GetReplace 

func (m *PathModifier) GetReplace() isPathModifier_Replace

func (*PathModifier) ProtoMessage 

func (*PathModifier) ProtoMessage()

func (*PathModifier) ProtoReflect 

func (x *PathModifier) ProtoReflect() protoreflect.Message

func (*PathModifier) Reset 

func (x *PathModifier) Reset()

func (*PathModifier) String 

func (x *PathModifier) String() string

type PathModifier_Full 

type PathModifier_Full struct {
	// Indicates that the path should be replaced with the given value.
	Full string `protobuf:"bytes,1,opt,name=full,proto3,oneof"`
}

type PathModifier_Prefix 

type PathModifier_Prefix struct {
	// Indicates that the path prefix should be replaced with the given
	// value. When used, the route MUST match the request with PathMatch
	// prefix match. Server implementations SHOULD prevent the useof prefix
	// modifiers on routes that do use a PathMatch prefix match. Proxyies
	// MUST not process requests for routes where this condition is not
	// satisfied.
	Prefix string `protobuf:"bytes,2,opt,name=prefix,proto3,oneof"`
}

type QueryParamMatch 

type QueryParamMatch struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Types that are assignable to Value:
	//
	//	*QueryParamMatch_Exact
	//	*QueryParamMatch_Regex
	Value isQueryParamMatch_Value `protobuf_oneof:"value"`
	// contains filtered or unexported fields
}

Describes how to match a query parameter by name and value.

func (*QueryParamMatch) Descriptor deprecated 

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

Deprecated: Use QueryParamMatch.ProtoReflect.Descriptor instead.

func (*QueryParamMatch) GetExact 

func (x *QueryParamMatch) GetExact() string

func (*QueryParamMatch) GetName 

func (x *QueryParamMatch) GetName() string

func (*QueryParamMatch) GetRegex 

func (x *QueryParamMatch) GetRegex() string

func (*QueryParamMatch) GetValue 

func (m *QueryParamMatch) GetValue() isQueryParamMatch_Value

func (*QueryParamMatch) ProtoMessage 

func (*QueryParamMatch) ProtoMessage()

func (*QueryParamMatch) ProtoReflect 

func (x *QueryParamMatch) ProtoReflect() protoreflect.Message

func (*QueryParamMatch) Reset 

func (x *QueryParamMatch) Reset()

func (*QueryParamMatch) String 

func (x *QueryParamMatch) String() string

type QueryParamMatch_Exact 

type QueryParamMatch_Exact struct {
	Exact string `protobuf:"bytes,2,opt,name=exact,proto3,oneof"`
}

type QueryParamMatch_Regex 

type QueryParamMatch_Regex struct {
	Regex string `protobuf:"bytes,3,opt,name=regex,proto3,oneof"`
}

type Ratio 

type Ratio struct {
	Numerator uint32 `protobuf:"varint,1,opt,name=numerator,proto3" json:"numerator,omitempty"`
	// MUST not be zero.
	Denominator uint32 `protobuf:"varint,2,opt,name=denominator,proto3" json:"denominator,omitempty"`
	// contains filtered or unexported fields
}

A ratio (i.e., of requests) to which an filter should be applied.

Represents fractional values on [0, 1].

func (*Ratio) Descriptor deprecated 

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

Deprecated: Use Ratio.ProtoReflect.Descriptor instead.

func (*Ratio) GetDenominator 

func (x *Ratio) GetDenominator() uint32

func (*Ratio) GetNumerator 

func (x *Ratio) GetNumerator() uint32

func (*Ratio) ProtoMessage 

func (*Ratio) ProtoMessage()

func (*Ratio) ProtoReflect 

func (x *Ratio) ProtoReflect() protoreflect.Message

func (*Ratio) Reset 

func (x *Ratio) Reset()

func (*Ratio) String 

func (x *Ratio) String() string

type RequestHeaderModifier 

type RequestHeaderModifier struct {

	// A list of headers name-value pairs to set on requests, augmenting any
	// existing values for the header.
	Add *http_types.Headers `protobuf:"bytes,1,opt,name=add,proto3" json:"add,omitempty"`
	// A list of headers name-value pairs to set on requests, replacing any
	// existing values for the header.
	Set *http_types.Headers `protobuf:"bytes,2,opt,name=set,proto3" json:"set,omitempty"`
	// A list of headers names to be removed from requests.
	Remove []string `protobuf:"bytes,3,rep,name=remove,proto3" json:"remove,omitempty"`
	// contains filtered or unexported fields
}

Configures a route to modify a request's headers.

Modifications are to be applied in the order they are described here: additions apply first, then sets, and then removals.

func (*RequestHeaderModifier) Descriptor deprecated 

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

Deprecated: Use RequestHeaderModifier.ProtoReflect.Descriptor instead.

func (*RequestHeaderModifier) GetAdd 

func (x *RequestHeaderModifier) GetAdd() *http_types.Headers

func (*RequestHeaderModifier) GetRemove 

func (x *RequestHeaderModifier) GetRemove() []string

func (*RequestHeaderModifier) GetSet 

func (x *RequestHeaderModifier) GetSet() *http_types.Headers

func (*RequestHeaderModifier) ProtoMessage 

func (*RequestHeaderModifier) ProtoMessage()

func (*RequestHeaderModifier) ProtoReflect 

func (x *RequestHeaderModifier) ProtoReflect() protoreflect.Message

func (*RequestHeaderModifier) Reset 

func (x *RequestHeaderModifier) Reset()

func (*RequestHeaderModifier) String 

func (x *RequestHeaderModifier) String() string

type RequestRedirect 

type RequestRedirect struct {

	// The scheme value to be used in the `location` header. If not specified,
	// the original request's scheme is used.
	Scheme *http_types.Scheme `protobuf:"bytes,1,opt,name=scheme,proto3" json:"scheme,omitempty"`
	// The host value to be used in the `location` header. If not specified, the
	// original request's host is used.
	Host string `protobuf:"bytes,2,opt,name=host,proto3" json:"host,omitempty"`
	// If set, configures how the request's path should be modified for use in
	// the `location` header. If not specified, the original request's path is
	// used.
	Path *PathModifier `protobuf:"bytes,3,opt,name=path,proto3" json:"path,omitempty"`
	// If set, specifies the port to use in the `location` header.
	Port uint32 `protobuf:"varint,4,opt,name=port,proto3" json:"port,omitempty"`
	// The status code to use in the HTTP response. If not specified, 301 is
	// used.
	Status uint32 `protobuf:"varint,5,opt,name=status,proto3" json:"status,omitempty"`
	// contains filtered or unexported fields
}

Configures a route to respond with a redirect response. The `location` header is set with the given URL parameters.

func (*RequestRedirect) Descriptor deprecated 

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

Deprecated: Use RequestRedirect.ProtoReflect.Descriptor instead.

func (*RequestRedirect) GetHost 

func (x *RequestRedirect) GetHost() string

func (*RequestRedirect) GetPath 

func (x *RequestRedirect) GetPath() *PathModifier

func (*RequestRedirect) GetPort 

func (x *RequestRedirect) GetPort() uint32

func (*RequestRedirect) GetScheme 

func (x *RequestRedirect) GetScheme() *http_types.Scheme

func (*RequestRedirect) GetStatus 

func (x *RequestRedirect) GetStatus() uint32

func (*RequestRedirect) ProtoMessage 

func (*RequestRedirect) ProtoMessage()

func (*RequestRedirect) ProtoReflect 

func (x *RequestRedirect) ProtoReflect() protoreflect.Message

func (*RequestRedirect) Reset 

func (x *RequestRedirect) Reset()

func (*RequestRedirect) String 

func (x *RequestRedirect) String() string

type ResponseHeaderModifier added in v0.11.0 

type ResponseHeaderModifier struct {

	// A list of headers name-value pairs to set on responses, augmenting any
	// existing values for the header.
	Add *http_types.Headers `protobuf:"bytes,1,opt,name=add,proto3" json:"add,omitempty"`
	// A list of headers name-value pairs to set on responses, replacing any
	// existing values for the header.
	Set *http_types.Headers `protobuf:"bytes,2,opt,name=set,proto3" json:"set,omitempty"`
	// A list of headers names to be removed from responses.
	Remove []string `protobuf:"bytes,3,rep,name=remove,proto3" json:"remove,omitempty"`
	// contains filtered or unexported fields
}

Configures a route to modify a response's headers.

Modifications are to be applied in the order they are described here: additions apply first, then sets, and then removals.

func (*ResponseHeaderModifier) Descriptor deprecated added in v0.11.0 

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

Deprecated: Use ResponseHeaderModifier.ProtoReflect.Descriptor instead.

func (*ResponseHeaderModifier) GetAdd added in v0.11.0 

func (x *ResponseHeaderModifier) GetAdd() *http_types.Headers

func (*ResponseHeaderModifier) GetRemove added in v0.11.0 

func (x *ResponseHeaderModifier) GetRemove() []string

func (*ResponseHeaderModifier) GetSet added in v0.11.0 

func (x *ResponseHeaderModifier) GetSet() *http_types.Headers

func (*ResponseHeaderModifier) ProtoMessage added in v0.11.0 

func (*ResponseHeaderModifier) ProtoMessage()

func (*ResponseHeaderModifier) ProtoReflect added in v0.11.0 

func (x *ResponseHeaderModifier) ProtoReflect() protoreflect.Message

func (*ResponseHeaderModifier) Reset added in v0.11.0 

func (x *ResponseHeaderModifier) Reset()

func (*ResponseHeaderModifier) String added in v0.11.0 

func (x *ResponseHeaderModifier) String() string

type Timeouts added in v0.14.0 

type Timeouts struct {

	// Limits the the time a stream may be active after all request frames have
	// been processed.
	Response *duration.Duration `protobuf:"bytes,1,opt,name=response,proto3" json:"response,omitempty"`
	// Limits the total duration of the stream from the request being initiated
	// until all frames have been processed.
	Request *duration.Duration `protobuf:"bytes,2,opt,name=request,proto3" json:"request,omitempty"`
	// Limits the amount of time a stream may be idle (i.e. with no frames being
	// processed).
	Idle *duration.Duration `protobuf:"bytes,3,opt,name=idle,proto3" json:"idle,omitempty"`
	// contains filtered or unexported fields
}

func (*Timeouts) Descriptor deprecated added in v0.14.0 

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

Deprecated: Use Timeouts.ProtoReflect.Descriptor instead.

func (*Timeouts) GetIdle added in v0.14.0 

func (x *Timeouts) GetIdle() *duration.Duration

func (*Timeouts) GetRequest added in v0.14.0 

func (x *Timeouts) GetRequest() *duration.Duration

func (*Timeouts) GetResponse added in v0.14.0 

func (x *Timeouts) GetResponse() *duration.Duration

func (*Timeouts) ProtoMessage added in v0.14.0 

func (*Timeouts) ProtoMessage()

func (*Timeouts) ProtoReflect added in v0.14.0 

func (x *Timeouts) ProtoReflect() protoreflect.Message

func (*Timeouts) Reset added in v0.14.0 

func (x *Timeouts) Reset()

func (*Timeouts) String added in v0.14.0 

func (x *Timeouts) String() string

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.