Documentation
¶
Index ¶
- Variables
- type FileAccessLog
- func (*FileAccessLog) Descriptor() ([]byte, []int)deprecated
- func (m *FileAccessLog) GetAccessLogFormat() isFileAccessLog_AccessLogFormat
- func (x *FileAccessLog) GetFormat() stringdeprecated
- func (x *FileAccessLog) GetJsonFormat() *_struct.Structdeprecated
- func (x *FileAccessLog) GetLogFormat() *v3.SubstitutionFormatString
- func (x *FileAccessLog) GetPath() string
- func (x *FileAccessLog) GetTypedJsonFormat() *_struct.Structdeprecated
- func (*FileAccessLog) ProtoMessage()
- func (x *FileAccessLog) ProtoReflect() protoreflect.Message
- func (x *FileAccessLog) Reset()
- func (x *FileAccessLog) String() string
- func (m *FileAccessLog) Validate() error
- func (m *FileAccessLog) ValidateAll() error
- type FileAccessLogMultiError
- type FileAccessLogValidationError
- func (e FileAccessLogValidationError) Cause() error
- func (e FileAccessLogValidationError) Error() string
- func (e FileAccessLogValidationError) ErrorName() string
- func (e FileAccessLogValidationError) Field() string
- func (e FileAccessLogValidationError) Key() bool
- func (e FileAccessLogValidationError) Reason() string
- type FileAccessLog_Format
- type FileAccessLog_JsonFormat
- type FileAccessLog_LogFormat
- type FileAccessLog_TypedJsonFormat
Constants ¶
This section is empty.
Variables ¶
var File_envoy_extensions_access_loggers_file_v3_file_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type FileAccessLog ¶
type FileAccessLog struct { // A path to a local file to which to write the access log entries. Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"` // Types that are assignable to AccessLogFormat: // *FileAccessLog_Format // *FileAccessLog_JsonFormat // *FileAccessLog_TypedJsonFormat // *FileAccessLog_LogFormat AccessLogFormat isFileAccessLog_AccessLogFormat `protobuf_oneof:"access_log_format"` // contains filtered or unexported fields }
Custom configuration for an :ref:`AccessLog <envoy_v3_api_msg_config.accesslog.v3.AccessLog>` that writes log entries directly to a file. Configures the built-in *envoy.access_loggers.file* AccessLog. [#next-free-field: 6]
func (*FileAccessLog) Descriptor
deprecated
func (*FileAccessLog) Descriptor() ([]byte, []int)
Deprecated: Use FileAccessLog.ProtoReflect.Descriptor instead.
func (*FileAccessLog) GetAccessLogFormat ¶
func (m *FileAccessLog) GetAccessLogFormat() isFileAccessLog_AccessLogFormat
func (*FileAccessLog) GetFormat
deprecated
func (x *FileAccessLog) GetFormat() string
Deprecated: Do not use.
func (*FileAccessLog) GetJsonFormat
deprecated
func (x *FileAccessLog) GetJsonFormat() *_struct.Struct
Deprecated: Do not use.
func (*FileAccessLog) GetLogFormat ¶ added in v0.9.6
func (x *FileAccessLog) GetLogFormat() *v3.SubstitutionFormatString
func (*FileAccessLog) GetPath ¶
func (x *FileAccessLog) GetPath() string
func (*FileAccessLog) GetTypedJsonFormat
deprecated
func (x *FileAccessLog) GetTypedJsonFormat() *_struct.Struct
Deprecated: Do not use.
func (*FileAccessLog) ProtoMessage ¶
func (*FileAccessLog) ProtoMessage()
func (*FileAccessLog) ProtoReflect ¶ added in v0.9.6
func (x *FileAccessLog) ProtoReflect() protoreflect.Message
func (*FileAccessLog) Reset ¶
func (x *FileAccessLog) Reset()
func (*FileAccessLog) String ¶
func (x *FileAccessLog) String() string
func (*FileAccessLog) Validate ¶
func (m *FileAccessLog) Validate() error
Validate checks the field values on FileAccessLog 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 (*FileAccessLog) ValidateAll ¶ added in v0.10.0
func (m *FileAccessLog) ValidateAll() error
ValidateAll checks the field values on FileAccessLog 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 FileAccessLogMultiError, or nil if none found.
type FileAccessLogMultiError ¶ added in v0.10.0
type FileAccessLogMultiError []error
FileAccessLogMultiError is an error wrapping multiple validation errors returned by FileAccessLog.ValidateAll() if the designated constraints aren't met.
func (FileAccessLogMultiError) AllErrors ¶ added in v0.10.0
func (m FileAccessLogMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (FileAccessLogMultiError) Error ¶ added in v0.10.0
func (m FileAccessLogMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type FileAccessLogValidationError ¶
type FileAccessLogValidationError struct {
// contains filtered or unexported fields
}
FileAccessLogValidationError is the validation error returned by FileAccessLog.Validate if the designated constraints aren't met.
func (FileAccessLogValidationError) Cause ¶
func (e FileAccessLogValidationError) Cause() error
Cause function returns cause value.
func (FileAccessLogValidationError) Error ¶
func (e FileAccessLogValidationError) Error() string
Error satisfies the builtin error interface
func (FileAccessLogValidationError) ErrorName ¶
func (e FileAccessLogValidationError) ErrorName() string
ErrorName returns error name.
func (FileAccessLogValidationError) Field ¶
func (e FileAccessLogValidationError) Field() string
Field function returns field value.
func (FileAccessLogValidationError) Key ¶
func (e FileAccessLogValidationError) Key() bool
Key function returns key value.
func (FileAccessLogValidationError) Reason ¶
func (e FileAccessLogValidationError) Reason() string
Reason function returns reason value.
type FileAccessLog_Format ¶
type FileAccessLog_Format struct { // Access log :ref:`format string<config_access_log_format_strings>`. // Envoy supports :ref:`custom access log formats <config_access_log_format>` as well as a // :ref:`default format <config_access_log_default_format>`. // This field is deprecated. // Please use :ref:`log_format <envoy_v3_api_field_extensions.access_loggers.file.v3.FileAccessLog.log_format>`. // // Deprecated: Do not use. Format string `protobuf:"bytes,2,opt,name=format,proto3,oneof"` }
type FileAccessLog_JsonFormat ¶
type FileAccessLog_JsonFormat struct { // Access log :ref:`format dictionary<config_access_log_format_dictionaries>`. All values // are rendered as strings. // This field is deprecated. // Please use :ref:`log_format <envoy_v3_api_field_extensions.access_loggers.file.v3.FileAccessLog.log_format>`. // // Deprecated: Do not use. JsonFormat *_struct.Struct `protobuf:"bytes,3,opt,name=json_format,json=jsonFormat,proto3,oneof"` }
type FileAccessLog_LogFormat ¶ added in v0.9.6
type FileAccessLog_LogFormat struct { // Configuration to form access log data and format. // If not specified, use :ref:`default format <config_access_log_default_format>`. LogFormat *v3.SubstitutionFormatString `protobuf:"bytes,5,opt,name=log_format,json=logFormat,proto3,oneof"` }
type FileAccessLog_TypedJsonFormat ¶
type FileAccessLog_TypedJsonFormat struct { // Access log :ref:`format dictionary<config_access_log_format_dictionaries>`. Values are // rendered as strings, numbers, or boolean values as appropriate. Nested JSON objects may // be produced by some command operators (e.g.FILTER_STATE or DYNAMIC_METADATA). See the // documentation for a specific command operator for details. // This field is deprecated. // Please use :ref:`log_format <envoy_v3_api_field_extensions.access_loggers.file.v3.FileAccessLog.log_format>`. // // Deprecated: Do not use. TypedJsonFormat *_struct.Struct `protobuf:"bytes,4,opt,name=typed_json_format,json=typedJsonFormat,proto3,oneof"` }