Documentation ¶
Index ¶
- Variables
- type CacheConfig
- func (*CacheConfig) Descriptor() ([]byte, []int)deprecated
- func (x *CacheConfig) GetAllowedVaryHeaders() []*matcher.StringMatcher
- func (x *CacheConfig) GetKeyCreatorParams() *CacheConfig_KeyCreatorParams
- func (x *CacheConfig) GetMaxBodyBytes() uint32
- func (x *CacheConfig) GetTypedConfig() *any.Any
- func (*CacheConfig) ProtoMessage()
- func (x *CacheConfig) ProtoReflect() protoreflect.Message
- func (x *CacheConfig) Reset()
- func (x *CacheConfig) String() string
- func (m *CacheConfig) Validate() error
- type CacheConfigValidationError
- func (e CacheConfigValidationError) Cause() error
- func (e CacheConfigValidationError) Error() string
- func (e CacheConfigValidationError) ErrorName() string
- func (e CacheConfigValidationError) Field() string
- func (e CacheConfigValidationError) Key() bool
- func (e CacheConfigValidationError) Reason() string
- type CacheConfig_KeyCreatorParams
- func (*CacheConfig_KeyCreatorParams) Descriptor() ([]byte, []int)deprecated
- func (x *CacheConfig_KeyCreatorParams) GetExcludeHost() bool
- func (x *CacheConfig_KeyCreatorParams) GetExcludeScheme() bool
- func (x *CacheConfig_KeyCreatorParams) GetQueryParametersExcluded() []*route.QueryParameterMatcher
- func (x *CacheConfig_KeyCreatorParams) GetQueryParametersIncluded() []*route.QueryParameterMatcher
- func (*CacheConfig_KeyCreatorParams) ProtoMessage()
- func (x *CacheConfig_KeyCreatorParams) ProtoReflect() protoreflect.Message
- func (x *CacheConfig_KeyCreatorParams) Reset()
- func (x *CacheConfig_KeyCreatorParams) String() string
- func (m *CacheConfig_KeyCreatorParams) Validate() error
- type CacheConfig_KeyCreatorParamsValidationError
- func (e CacheConfig_KeyCreatorParamsValidationError) Cause() error
- func (e CacheConfig_KeyCreatorParamsValidationError) Error() string
- func (e CacheConfig_KeyCreatorParamsValidationError) ErrorName() string
- func (e CacheConfig_KeyCreatorParamsValidationError) Field() string
- func (e CacheConfig_KeyCreatorParamsValidationError) Key() bool
- func (e CacheConfig_KeyCreatorParamsValidationError) Reason() string
Constants ¶
This section is empty.
Variables ¶
var File_envoy_config_filter_http_cache_v2alpha_cache_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type CacheConfig ¶
type CacheConfig struct { // Config specific to the cache storage implementation. TypedConfig *any.Any `protobuf:"bytes,1,opt,name=typed_config,json=typedConfig,proto3" json:"typed_config,omitempty"` // List of matching rules that defines allowed *Vary* headers. // // The *vary* response header holds a list of header names that affect the // contents of a response, as described by // https://httpwg.org/specs/rfc7234.html#caching.negotiated.responses. // // During insertion, *allowed_vary_headers* acts as a allowlist: if a // response's *vary* header mentions any header names that aren't matched by any rules in // *allowed_vary_headers*, that response will not be cached. // // During lookup, *allowed_vary_headers* controls what request headers will be // sent to the cache storage implementation. AllowedVaryHeaders []*matcher.StringMatcher `protobuf:"bytes,2,rep,name=allowed_vary_headers,json=allowedVaryHeaders,proto3" json:"allowed_vary_headers,omitempty"` // [#not-implemented-hide:] // <TODO(toddmgreer) implement key customization> // // Modifies cache key creation by restricting which parts of the URL are included. KeyCreatorParams *CacheConfig_KeyCreatorParams `protobuf:"bytes,3,opt,name=key_creator_params,json=keyCreatorParams,proto3" json:"key_creator_params,omitempty"` // [#not-implemented-hide:] // <TODO(toddmgreer) implement size limit> // // Max body size the cache filter will insert into a cache. 0 means unlimited (though the cache // storage implementation may have its own limit beyond which it will reject insertions). MaxBodyBytes uint32 `protobuf:"varint,4,opt,name=max_body_bytes,json=maxBodyBytes,proto3" json:"max_body_bytes,omitempty"` // contains filtered or unexported fields }
func (*CacheConfig) Descriptor
deprecated
func (*CacheConfig) Descriptor() ([]byte, []int)
Deprecated: Use CacheConfig.ProtoReflect.Descriptor instead.
func (*CacheConfig) GetAllowedVaryHeaders ¶
func (x *CacheConfig) GetAllowedVaryHeaders() []*matcher.StringMatcher
func (*CacheConfig) GetKeyCreatorParams ¶
func (x *CacheConfig) GetKeyCreatorParams() *CacheConfig_KeyCreatorParams
func (*CacheConfig) GetMaxBodyBytes ¶
func (x *CacheConfig) GetMaxBodyBytes() uint32
func (*CacheConfig) GetTypedConfig ¶
func (x *CacheConfig) GetTypedConfig() *any.Any
func (*CacheConfig) ProtoMessage ¶
func (*CacheConfig) ProtoMessage()
func (*CacheConfig) ProtoReflect ¶ added in v1.7.0
func (x *CacheConfig) ProtoReflect() protoreflect.Message
func (*CacheConfig) Reset ¶
func (x *CacheConfig) Reset()
func (*CacheConfig) String ¶
func (x *CacheConfig) String() string
func (*CacheConfig) Validate ¶
func (m *CacheConfig) Validate() error
Validate checks the field values on CacheConfig with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type CacheConfigValidationError ¶
type CacheConfigValidationError struct {
// contains filtered or unexported fields
}
CacheConfigValidationError is the validation error returned by CacheConfig.Validate if the designated constraints aren't met.
func (CacheConfigValidationError) Cause ¶
func (e CacheConfigValidationError) Cause() error
Cause function returns cause value.
func (CacheConfigValidationError) Error ¶
func (e CacheConfigValidationError) Error() string
Error satisfies the builtin error interface
func (CacheConfigValidationError) ErrorName ¶
func (e CacheConfigValidationError) ErrorName() string
ErrorName returns error name.
func (CacheConfigValidationError) Field ¶
func (e CacheConfigValidationError) Field() string
Field function returns field value.
func (CacheConfigValidationError) Key ¶
func (e CacheConfigValidationError) Key() bool
Key function returns key value.
func (CacheConfigValidationError) Reason ¶
func (e CacheConfigValidationError) Reason() string
Reason function returns reason value.
type CacheConfig_KeyCreatorParams ¶
type CacheConfig_KeyCreatorParams struct { // If true, exclude the URL scheme from the cache key. Set to true if your origins always // produce the same response for http and https requests. ExcludeScheme bool `protobuf:"varint,1,opt,name=exclude_scheme,json=excludeScheme,proto3" json:"exclude_scheme,omitempty"` // If true, exclude the host from the cache key. Set to true if your origins' responses don't // ever depend on host. ExcludeHost bool `protobuf:"varint,2,opt,name=exclude_host,json=excludeHost,proto3" json:"exclude_host,omitempty"` // If *query_parameters_included* is nonempty, only query parameters matched // by one or more of its matchers are included in the cache key. Any other // query params will not affect cache lookup. QueryParametersIncluded []*route.QueryParameterMatcher `` /* 132-byte string literal not displayed */ // If *query_parameters_excluded* is nonempty, query parameters matched by one // or more of its matchers are excluded from the cache key (even if also // matched by *query_parameters_included*), and will not affect cache lookup. QueryParametersExcluded []*route.QueryParameterMatcher `` /* 132-byte string literal not displayed */ // contains filtered or unexported fields }
[#not-implemented-hide:] Modifies cache key creation by restricting which parts of the URL are included.
func (*CacheConfig_KeyCreatorParams) Descriptor
deprecated
func (*CacheConfig_KeyCreatorParams) Descriptor() ([]byte, []int)
Deprecated: Use CacheConfig_KeyCreatorParams.ProtoReflect.Descriptor instead.
func (*CacheConfig_KeyCreatorParams) GetExcludeHost ¶
func (x *CacheConfig_KeyCreatorParams) GetExcludeHost() bool
func (*CacheConfig_KeyCreatorParams) GetExcludeScheme ¶
func (x *CacheConfig_KeyCreatorParams) GetExcludeScheme() bool
func (*CacheConfig_KeyCreatorParams) GetQueryParametersExcluded ¶
func (x *CacheConfig_KeyCreatorParams) GetQueryParametersExcluded() []*route.QueryParameterMatcher
func (*CacheConfig_KeyCreatorParams) GetQueryParametersIncluded ¶
func (x *CacheConfig_KeyCreatorParams) GetQueryParametersIncluded() []*route.QueryParameterMatcher
func (*CacheConfig_KeyCreatorParams) ProtoMessage ¶
func (*CacheConfig_KeyCreatorParams) ProtoMessage()
func (*CacheConfig_KeyCreatorParams) ProtoReflect ¶ added in v1.7.0
func (x *CacheConfig_KeyCreatorParams) ProtoReflect() protoreflect.Message
func (*CacheConfig_KeyCreatorParams) Reset ¶
func (x *CacheConfig_KeyCreatorParams) Reset()
func (*CacheConfig_KeyCreatorParams) String ¶
func (x *CacheConfig_KeyCreatorParams) String() string
func (*CacheConfig_KeyCreatorParams) Validate ¶
func (m *CacheConfig_KeyCreatorParams) Validate() error
Validate checks the field values on CacheConfig_KeyCreatorParams with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type CacheConfig_KeyCreatorParamsValidationError ¶
type CacheConfig_KeyCreatorParamsValidationError struct {
// contains filtered or unexported fields
}
CacheConfig_KeyCreatorParamsValidationError is the validation error returned by CacheConfig_KeyCreatorParams.Validate if the designated constraints aren't met.
func (CacheConfig_KeyCreatorParamsValidationError) Cause ¶
func (e CacheConfig_KeyCreatorParamsValidationError) Cause() error
Cause function returns cause value.
func (CacheConfig_KeyCreatorParamsValidationError) Error ¶
func (e CacheConfig_KeyCreatorParamsValidationError) Error() string
Error satisfies the builtin error interface
func (CacheConfig_KeyCreatorParamsValidationError) ErrorName ¶
func (e CacheConfig_KeyCreatorParamsValidationError) ErrorName() string
ErrorName returns error name.
func (CacheConfig_KeyCreatorParamsValidationError) Field ¶
func (e CacheConfig_KeyCreatorParamsValidationError) Field() string
Field function returns field value.
func (CacheConfig_KeyCreatorParamsValidationError) Key ¶
func (e CacheConfig_KeyCreatorParamsValidationError) Key() bool
Key function returns key value.
func (CacheConfig_KeyCreatorParamsValidationError) Reason ¶
func (e CacheConfig_KeyCreatorParamsValidationError) Reason() string
Reason function returns reason value.