file_system_http_cachev3

Documentation

Index

• Variables
• type FileSystemHttpCacheConfig
  • func (*FileSystemHttpCacheConfig) Descriptor() ([]byte, []int)
  • func (x *FileSystemHttpCacheConfig) GetCachePath() string
  • func (x *FileSystemHttpCacheConfig) GetCacheSubdivisions() uint32
  • func (x *FileSystemHttpCacheConfig) GetManagerConfig() *v3.AsyncFileManagerConfig
  • func (x *FileSystemHttpCacheConfig) GetMaxCacheEntryCount() *wrappers.UInt64Value
  • func (x *FileSystemHttpCacheConfig) GetMaxCacheEntrySizeBytes() *wrappers.UInt64Value
  • func (x *FileSystemHttpCacheConfig) GetMaxCacheSizeBytes() *wrappers.UInt64Value
  • func (*FileSystemHttpCacheConfig) ProtoMessage()
  • func (x *FileSystemHttpCacheConfig) ProtoReflect() protoreflect.Message
  • func (x *FileSystemHttpCacheConfig) Reset()
  • func (x *FileSystemHttpCacheConfig) String() string
  • func (m *FileSystemHttpCacheConfig) Validate() error
  • func (m *FileSystemHttpCacheConfig) ValidateAll() error
• type FileSystemHttpCacheConfigMultiError
  • func (m FileSystemHttpCacheConfigMultiError) AllErrors() []error
  • func (m FileSystemHttpCacheConfigMultiError) Error() string
• type FileSystemHttpCacheConfigValidationError
  • func (e FileSystemHttpCacheConfigValidationError) Cause() error
  • func (e FileSystemHttpCacheConfigValidationError) Error() string
  • func (e FileSystemHttpCacheConfigValidationError) ErrorName() string
  • func (e FileSystemHttpCacheConfigValidationError) Field() string
  • func (e FileSystemHttpCacheConfigValidationError) Key() bool
  • func (e FileSystemHttpCacheConfigValidationError) Reason() string

Variables

var File_envoy_extensions_http_cache_file_system_http_cache_v3_file_system_http_cache_proto protoreflect.FileDescriptor

Types

type FileSystemHttpCacheConfig

type FileSystemHttpCacheConfig struct {

	// Configuration of a manager for how the file system is used asynchronously.
	ManagerConfig *v3.AsyncFileManagerConfig `protobuf:"bytes,1,opt,name=manager_config,json=managerConfig,proto3" json:"manager_config,omitempty"`
	// Path at which the cache files will be stored.
	//
	// This also doubles as the unique identifier for a cache, so a cache can be shared
	// between different routes, or separate paths can be used to specify separate caches.
	//
	// If the same “cache_path“ is used in more than one “CacheConfig“, the rest of the
	// “FileSystemHttpCacheConfig“ must also match, and will refer to the same cache
	// instance.
	CachePath string `protobuf:"bytes,2,opt,name=cache_path,json=cachePath,proto3" json:"cache_path,omitempty"`
	// The maximum size of the cache in bytes - when reached, another entry is removed.
	//
	// This is measured as the sum of file sizes, such that it includes headers, trailers,
	// and metadata, but does not include e.g. file system overhead and block size padding.
	//
	// If unset there is no limit except file system failure.
	//
	// [#not-implemented-hide:]
	MaxCacheSizeBytes *wrappers.UInt64Value `protobuf:"bytes,3,opt,name=max_cache_size_bytes,json=maxCacheSizeBytes,proto3" json:"max_cache_size_bytes,omitempty"`
	// The maximum size of a cache entry in bytes - larger responses will not be cached.
	//
	// This is measured as the file size for the cache entry, such that it includes
	// headers, trailers, and metadata.
	//
	// If unset there is no limit.
	//
	// [#not-implemented-hide:]
	MaxCacheEntrySizeBytes *wrappers.UInt64Value `` /* 133-byte string literal not displayed */
	// The maximum number of cache entries - when reached, another entry is removed.
	//
	// If unset there is no limit.
	//
	// [#not-implemented-hide:]
	MaxCacheEntryCount *wrappers.UInt64Value `protobuf:"bytes,5,opt,name=max_cache_entry_count,json=maxCacheEntryCount,proto3" json:"max_cache_entry_count,omitempty"`
	// A number of folders into which to subdivide the cache.
	//
	// Setting this can help with performance in file systems where a large number of inodes
	// in a single branch degrades performance. The optimal value in that case would be
	// “sqrt(expected_cache_entry_count)“.
	//
	// On file systems that perform well with many inodes, the default value of 1 should be used.
	//
	// [#not-implemented-hide:]
	CacheSubdivisions uint32 `protobuf:"varint,6,opt,name=cache_subdivisions,json=cacheSubdivisions,proto3" json:"cache_subdivisions,omitempty"`
	// contains filtered or unexported fields
}

Configuration for a cache implementation that caches in the local file system.

By default this cache uses a least-recently-used eviction strategy. [#next-free-field: 7]

func (*FileSystemHttpCacheConfig) Descriptor

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

Deprecated: Use FileSystemHttpCacheConfig.ProtoReflect.Descriptor instead.

func (*FileSystemHttpCacheConfig) GetCachePath

func (x *FileSystemHttpCacheConfig) GetCachePath() string

func (*FileSystemHttpCacheConfig) GetCacheSubdivisions

func (x *FileSystemHttpCacheConfig) GetCacheSubdivisions() uint32

func (*FileSystemHttpCacheConfig) GetManagerConfig

func (x *FileSystemHttpCacheConfig) GetManagerConfig() *v3.AsyncFileManagerConfig

func (*FileSystemHttpCacheConfig) GetMaxCacheEntryCount

func (x *FileSystemHttpCacheConfig) GetMaxCacheEntryCount() *wrappers.UInt64Value

func (*FileSystemHttpCacheConfig) GetMaxCacheEntrySizeBytes

func (x *FileSystemHttpCacheConfig) GetMaxCacheEntrySizeBytes() *wrappers.UInt64Value

func (*FileSystemHttpCacheConfig) GetMaxCacheSizeBytes

func (x *FileSystemHttpCacheConfig) GetMaxCacheSizeBytes() *wrappers.UInt64Value

func (*FileSystemHttpCacheConfig) ProtoMessage

func (*FileSystemHttpCacheConfig) ProtoMessage()

func (*FileSystemHttpCacheConfig) ProtoReflect

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

func (*FileSystemHttpCacheConfig) Reset

func (x *FileSystemHttpCacheConfig) Reset()

func (*FileSystemHttpCacheConfig) String

func (x *FileSystemHttpCacheConfig) String() string

func (*FileSystemHttpCacheConfig) Validate

func (m *FileSystemHttpCacheConfig) Validate() error

Validate checks the field values on FileSystemHttpCacheConfig with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*FileSystemHttpCacheConfig) ValidateAll

func (m *FileSystemHttpCacheConfig) ValidateAll() error

ValidateAll checks the field values on FileSystemHttpCacheConfig with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in FileSystemHttpCacheConfigMultiError, or nil if none found.

type FileSystemHttpCacheConfigMultiError

type FileSystemHttpCacheConfigMultiError []error

FileSystemHttpCacheConfigMultiError is an error wrapping multiple validation errors returned by FileSystemHttpCacheConfig.ValidateAll() if the designated constraints aren't met.

func (FileSystemHttpCacheConfigMultiError) AllErrors

func (m FileSystemHttpCacheConfigMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (FileSystemHttpCacheConfigMultiError) Error

func (m FileSystemHttpCacheConfigMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type FileSystemHttpCacheConfigValidationError

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

FileSystemHttpCacheConfigValidationError is the validation error returned by FileSystemHttpCacheConfig.Validate if the designated constraints aren't met.

func (FileSystemHttpCacheConfigValidationError) Cause

func (e FileSystemHttpCacheConfigValidationError) Cause() error

Cause function returns cause value.

func (FileSystemHttpCacheConfigValidationError) Error

func (e FileSystemHttpCacheConfigValidationError) Error() string

Error satisfies the builtin error interface

func (FileSystemHttpCacheConfigValidationError) ErrorName

func (e FileSystemHttpCacheConfigValidationError) ErrorName() string

ErrorName returns error name.

func (FileSystemHttpCacheConfigValidationError) Field

func (e FileSystemHttpCacheConfigValidationError) Field() string

Field function returns field value.

func (FileSystemHttpCacheConfigValidationError) Key

func (e FileSystemHttpCacheConfigValidationError) Key() bool

Key function returns key value.

func (FileSystemHttpCacheConfigValidationError) Reason

func (e FileSystemHttpCacheConfigValidationError) Reason() string

Reason function returns reason value.