Documentation
¶
Index ¶
- Variables
- type Parameters
- func (*Parameters) Descriptor() ([]byte, []int)deprecated
- func (m *Parameters) Equal(that interface{}) bool
- func (x *Parameters) GetHeaders() map[string]string
- func (x *Parameters) GetPath() *wrappers.StringValue
- func (m *Parameters) Hash(hasher hash.Hash64) (uint64, error)
- func (*Parameters) ProtoMessage()
- func (x *Parameters) ProtoReflect() protoreflect.Message
- func (x *Parameters) Reset()
- func (x *Parameters) String() string
- type RequestMatch
- func (*RequestMatch) Descriptor() ([]byte, []int)deprecated
- func (m *RequestMatch) Equal(that interface{}) bool
- func (x *RequestMatch) GetClearRouteCache() bool
- func (x *RequestMatch) GetMatcher() *matchers.Matcher
- func (x *RequestMatch) GetRequestTransformation() *transformation.Transformation
- func (x *RequestMatch) GetResponseTransformation() *transformation.Transformation
- func (m *RequestMatch) Hash(hasher hash.Hash64) (uint64, error)
- func (*RequestMatch) ProtoMessage()
- func (x *RequestMatch) ProtoReflect() protoreflect.Message
- func (x *RequestMatch) Reset()
- func (x *RequestMatch) String() string
- type RequestResponseTransformations
- func (*RequestResponseTransformations) Descriptor() ([]byte, []int)deprecated
- func (m *RequestResponseTransformations) Equal(that interface{}) bool
- func (x *RequestResponseTransformations) GetRequestTransforms() []*RequestMatch
- func (x *RequestResponseTransformations) GetResponseTransforms() []*ResponseMatch
- func (m *RequestResponseTransformations) Hash(hasher hash.Hash64) (uint64, error)
- func (*RequestResponseTransformations) ProtoMessage()
- func (x *RequestResponseTransformations) ProtoReflect() protoreflect.Message
- func (x *RequestResponseTransformations) Reset()
- func (x *RequestResponseTransformations) String() string
- type ResponseMatch
- func (*ResponseMatch) Descriptor() ([]byte, []int)deprecated
- func (m *ResponseMatch) Equal(that interface{}) bool
- func (x *ResponseMatch) GetMatchers() []*matchers.HeaderMatcher
- func (x *ResponseMatch) GetResponseCodeDetails() string
- func (x *ResponseMatch) GetResponseTransformation() *transformation.Transformation
- func (m *ResponseMatch) Hash(hasher hash.Hash64) (uint64, error)
- func (*ResponseMatch) ProtoMessage()
- func (x *ResponseMatch) ProtoReflect() protoreflect.Message
- func (x *ResponseMatch) Reset()
- func (x *ResponseMatch) String() string
- type TransformationStages
- func (*TransformationStages) Descriptor() ([]byte, []int)deprecated
- func (m *TransformationStages) Equal(that interface{}) bool
- func (x *TransformationStages) GetEarly() *RequestResponseTransformations
- func (x *TransformationStages) GetInheritTransformation() bool
- func (x *TransformationStages) GetRegular() *RequestResponseTransformations
- func (m *TransformationStages) Hash(hasher hash.Hash64) (uint64, error)
- func (*TransformationStages) ProtoMessage()
- func (x *TransformationStages) ProtoReflect() protoreflect.Message
- func (x *TransformationStages) Reset()
- func (x *TransformationStages) String() string
- type Transformations
- func (*Transformations) Descriptor() ([]byte, []int)deprecated
- func (m *Transformations) Equal(that interface{}) bool
- func (x *Transformations) GetClearRouteCache() bool
- func (x *Transformations) GetRequestTransformation() *transformation.Transformation
- func (x *Transformations) GetResponseTransformation() *transformation.Transformation
- func (m *Transformations) Hash(hasher hash.Hash64) (uint64, error)
- func (*Transformations) ProtoMessage()
- func (x *Transformations) ProtoReflect() protoreflect.Message
- func (x *Transformations) Reset()
- func (x *Transformations) String() string
Constants ¶
This section is empty.
Variables ¶
View Source
var File_github_com_solo_io_gloo_projects_gloo_api_v1_options_transformation_parameters_proto protoreflect.FileDescriptor
View Source
var File_github_com_solo_io_gloo_projects_gloo_api_v1_options_transformation_transformation_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type Parameters ¶
type Parameters struct { // headers that will be used to extract data for processing output templates // Gloo will search for parameters by their name in header value strings, enclosed in single // curly braces // Example: // extensions: // parameters: // headers: // x-user-id: '{userId}' Headers map[string]string `` /* 155-byte string literal not displayed */ // part of the (or the entire) path that will be used extract data for processing output templates // Gloo will search for parameters by their name in header value strings, enclosed in single // curly braces // Example: // extensions: // parameters: // path: /users/{ userId } Path *wrappers.StringValue `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"` // contains filtered or unexported fields }
func (*Parameters) Descriptor
deprecated
func (*Parameters) Descriptor() ([]byte, []int)
Deprecated: Use Parameters.ProtoReflect.Descriptor instead.
func (*Parameters) GetHeaders ¶
func (x *Parameters) GetHeaders() map[string]string
func (*Parameters) GetPath ¶
func (x *Parameters) GetPath() *wrappers.StringValue
func (*Parameters) Hash ¶ added in v1.2.13
func (m *Parameters) Hash(hasher hash.Hash64) (uint64, error)
Hash function
func (*Parameters) ProtoMessage ¶
func (*Parameters) ProtoMessage()
func (*Parameters) ProtoReflect ¶ added in v1.6.0
func (x *Parameters) ProtoReflect() protoreflect.Message
func (*Parameters) Reset ¶
func (x *Parameters) Reset()
func (*Parameters) String ¶
func (x *Parameters) String() string
type RequestMatch ¶ added in v1.4.6
type RequestMatch struct { // Matches on the request properties. Matcher *matchers.Matcher `protobuf:"bytes,1,opt,name=matcher,proto3" json:"matcher,omitempty"` // Should we clear the route cache if a transformation was matched. ClearRouteCache bool `protobuf:"varint,2,opt,name=clear_route_cache,json=clearRouteCache,proto3" json:"clear_route_cache,omitempty"` // Transformation to apply on the request. RequestTransformation *transformation.Transformation `protobuf:"bytes,3,opt,name=request_transformation,json=requestTransformation,proto3" json:"request_transformation,omitempty"` // Transformation to apply on the response. ResponseTransformation *transformation.Transformation `` /* 127-byte string literal not displayed */ // contains filtered or unexported fields }
func (*RequestMatch) Descriptor
deprecated
added in
v1.4.6
func (*RequestMatch) Descriptor() ([]byte, []int)
Deprecated: Use RequestMatch.ProtoReflect.Descriptor instead.
func (*RequestMatch) Equal ¶ added in v1.4.6
func (m *RequestMatch) Equal(that interface{}) bool
Equal function
func (*RequestMatch) GetClearRouteCache ¶ added in v1.4.6
func (x *RequestMatch) GetClearRouteCache() bool
func (*RequestMatch) GetMatcher ¶ added in v1.4.6
func (x *RequestMatch) GetMatcher() *matchers.Matcher
func (*RequestMatch) GetRequestTransformation ¶ added in v1.4.6
func (x *RequestMatch) GetRequestTransformation() *transformation.Transformation
func (*RequestMatch) GetResponseTransformation ¶ added in v1.4.6
func (x *RequestMatch) GetResponseTransformation() *transformation.Transformation
func (*RequestMatch) Hash ¶ added in v1.4.6
func (m *RequestMatch) Hash(hasher hash.Hash64) (uint64, error)
Hash function
func (*RequestMatch) ProtoMessage ¶ added in v1.4.6
func (*RequestMatch) ProtoMessage()
func (*RequestMatch) ProtoReflect ¶ added in v1.6.0
func (x *RequestMatch) ProtoReflect() protoreflect.Message
func (*RequestMatch) Reset ¶ added in v1.4.6
func (x *RequestMatch) Reset()
func (*RequestMatch) String ¶ added in v1.4.6
func (x *RequestMatch) String() string
type RequestResponseTransformations ¶ added in v1.4.6
type RequestResponseTransformations struct { // Transformations to apply on the request. The first request that matches will apply. RequestTransforms []*RequestMatch `protobuf:"bytes,1,rep,name=request_transforms,json=requestTransforms,proto3" json:"request_transforms,omitempty"` // Transformations to apply on the response. This field is only consulted if there is no // response transformation in the matched `request_transforms`. i.e. Only one response transformation // will be executed. The first response transformation that matches will // apply. ResponseTransforms []*ResponseMatch `protobuf:"bytes,2,rep,name=response_transforms,json=responseTransforms,proto3" json:"response_transforms,omitempty"` // contains filtered or unexported fields }
func (*RequestResponseTransformations) Descriptor
deprecated
added in
v1.4.6
func (*RequestResponseTransformations) Descriptor() ([]byte, []int)
Deprecated: Use RequestResponseTransformations.ProtoReflect.Descriptor instead.
func (*RequestResponseTransformations) Equal ¶ added in v1.4.6
func (m *RequestResponseTransformations) Equal(that interface{}) bool
Equal function
func (*RequestResponseTransformations) GetRequestTransforms ¶ added in v1.4.6
func (x *RequestResponseTransformations) GetRequestTransforms() []*RequestMatch
func (*RequestResponseTransformations) GetResponseTransforms ¶ added in v1.4.6
func (x *RequestResponseTransformations) GetResponseTransforms() []*ResponseMatch
func (*RequestResponseTransformations) Hash ¶ added in v1.4.6
func (m *RequestResponseTransformations) Hash(hasher hash.Hash64) (uint64, error)
Hash function
func (*RequestResponseTransformations) ProtoMessage ¶ added in v1.4.6
func (*RequestResponseTransformations) ProtoMessage()
func (*RequestResponseTransformations) ProtoReflect ¶ added in v1.6.0
func (x *RequestResponseTransformations) ProtoReflect() protoreflect.Message
func (*RequestResponseTransformations) Reset ¶ added in v1.4.6
func (x *RequestResponseTransformations) Reset()
func (*RequestResponseTransformations) String ¶ added in v1.4.6
func (x *RequestResponseTransformations) String() string
type ResponseMatch ¶ added in v1.4.6
type ResponseMatch struct { // Response headers to match on. Matchers []*matchers.HeaderMatcher `protobuf:"bytes,1,rep,name=matchers,proto3" json:"matchers,omitempty"` // Response code detail to match on. To see the response code details for your usecase, // you can use the envoy access log %RESPONSE_CODE_DETAILS% formatter to log it. ResponseCodeDetails string `protobuf:"bytes,2,opt,name=response_code_details,json=responseCodeDetails,proto3" json:"response_code_details,omitempty"` // Transformation to apply on the response. ResponseTransformation *transformation.Transformation `` /* 127-byte string literal not displayed */ // contains filtered or unexported fields }
func (*ResponseMatch) Descriptor
deprecated
added in
v1.4.6
func (*ResponseMatch) Descriptor() ([]byte, []int)
Deprecated: Use ResponseMatch.ProtoReflect.Descriptor instead.
func (*ResponseMatch) Equal ¶ added in v1.4.6
func (m *ResponseMatch) Equal(that interface{}) bool
Equal function
func (*ResponseMatch) GetMatchers ¶ added in v1.4.6
func (x *ResponseMatch) GetMatchers() []*matchers.HeaderMatcher
func (*ResponseMatch) GetResponseCodeDetails ¶ added in v1.4.6
func (x *ResponseMatch) GetResponseCodeDetails() string
func (*ResponseMatch) GetResponseTransformation ¶ added in v1.4.6
func (x *ResponseMatch) GetResponseTransformation() *transformation.Transformation
func (*ResponseMatch) Hash ¶ added in v1.4.6
func (m *ResponseMatch) Hash(hasher hash.Hash64) (uint64, error)
Hash function
func (*ResponseMatch) ProtoMessage ¶ added in v1.4.6
func (*ResponseMatch) ProtoMessage()
func (*ResponseMatch) ProtoReflect ¶ added in v1.6.0
func (x *ResponseMatch) ProtoReflect() protoreflect.Message
func (*ResponseMatch) Reset ¶ added in v1.4.6
func (x *ResponseMatch) Reset()
func (*ResponseMatch) String ¶ added in v1.4.6
func (x *ResponseMatch) String() string
type TransformationStages ¶ added in v1.4.6
type TransformationStages struct { // Early transformations happen before most other options (Like Auth and Rate Limit). Early *RequestResponseTransformations `protobuf:"bytes,1,opt,name=early,proto3" json:"early,omitempty"` // Regular transformations happen after Auth and Rate limit decisions has been made. Regular *RequestResponseTransformations `protobuf:"bytes,2,opt,name=regular,proto3" json:"regular,omitempty"` // Inherit transformation config from parent. This has no affect on VirtualHost level transformations. // If a RouteTable or Route wants to inherit transformations from it's parent RouteTable or VirtualHost, // this should be set to true, else transformations from parents will not be inherited. // Transformations are ordered so the child's transformation gets priority, so in the case where a child // and parent's transformation matchers are the same, only the child's transformation will run because // only one transformation will run per stage. // Defaults to false. InheritTransformation bool `protobuf:"varint,3,opt,name=inherit_transformation,json=inheritTransformation,proto3" json:"inherit_transformation,omitempty"` // contains filtered or unexported fields }
func (*TransformationStages) Descriptor
deprecated
added in
v1.4.6
func (*TransformationStages) Descriptor() ([]byte, []int)
Deprecated: Use TransformationStages.ProtoReflect.Descriptor instead.
func (*TransformationStages) Equal ¶ added in v1.4.6
func (m *TransformationStages) Equal(that interface{}) bool
Equal function
func (*TransformationStages) GetEarly ¶ added in v1.4.6
func (x *TransformationStages) GetEarly() *RequestResponseTransformations
func (*TransformationStages) GetInheritTransformation ¶ added in v1.7.7
func (x *TransformationStages) GetInheritTransformation() bool
func (*TransformationStages) GetRegular ¶ added in v1.4.6
func (x *TransformationStages) GetRegular() *RequestResponseTransformations
func (*TransformationStages) Hash ¶ added in v1.4.6
func (m *TransformationStages) Hash(hasher hash.Hash64) (uint64, error)
Hash function
func (*TransformationStages) ProtoMessage ¶ added in v1.4.6
func (*TransformationStages) ProtoMessage()
func (*TransformationStages) ProtoReflect ¶ added in v1.6.0
func (x *TransformationStages) ProtoReflect() protoreflect.Message
func (*TransformationStages) Reset ¶ added in v1.4.6
func (x *TransformationStages) Reset()
func (*TransformationStages) String ¶ added in v1.4.6
func (x *TransformationStages) String() string
type Transformations ¶ added in v1.4.6
type Transformations struct { // Apply a transformation to requests. RequestTransformation *transformation.Transformation `protobuf:"bytes,1,opt,name=request_transformation,json=requestTransformation,proto3" json:"request_transformation,omitempty"` // Clear the route cache if the request transformation was applied. ClearRouteCache bool `protobuf:"varint,3,opt,name=clear_route_cache,json=clearRouteCache,proto3" json:"clear_route_cache,omitempty"` // Apply a transformation to responses. ResponseTransformation *transformation.Transformation `` /* 127-byte string literal not displayed */ // contains filtered or unexported fields }
func (*Transformations) Descriptor
deprecated
added in
v1.4.6
func (*Transformations) Descriptor() ([]byte, []int)
Deprecated: Use Transformations.ProtoReflect.Descriptor instead.
func (*Transformations) Equal ¶ added in v1.4.6
func (m *Transformations) Equal(that interface{}) bool
Equal function
func (*Transformations) GetClearRouteCache ¶ added in v1.4.6
func (x *Transformations) GetClearRouteCache() bool
func (*Transformations) GetRequestTransformation ¶ added in v1.4.6
func (x *Transformations) GetRequestTransformation() *transformation.Transformation
func (*Transformations) GetResponseTransformation ¶ added in v1.4.6
func (x *Transformations) GetResponseTransformation() *transformation.Transformation
func (*Transformations) Hash ¶ added in v1.4.6
func (m *Transformations) Hash(hasher hash.Hash64) (uint64, error)
Hash function
func (*Transformations) ProtoMessage ¶ added in v1.4.6
func (*Transformations) ProtoMessage()
func (*Transformations) ProtoReflect ¶ added in v1.6.0
func (x *Transformations) ProtoReflect() protoreflect.Message
func (*Transformations) Reset ¶ added in v1.4.6
func (x *Transformations) Reset()
func (*Transformations) String ¶ added in v1.4.6
func (x *Transformations) String() string
Click to show internal directories.
Click to hide internal directories.