Documentation
¶
Index ¶
- Constants
- Variables
- type FileAccessLog
- func (x *FileAccessLog) ClearAccessLogFormat()
- func (x *FileAccessLog) ClearFormat()deprecated
- func (x *FileAccessLog) ClearJsonFormat()deprecated
- func (x *FileAccessLog) ClearLogFormat()
- func (x *FileAccessLog) ClearTypedJsonFormat()deprecated
- func (x *FileAccessLog) GetAccessLogFormat() isFileAccessLog_AccessLogFormat
- func (x *FileAccessLog) GetFormat() stringdeprecated
- func (x *FileAccessLog) GetJsonFormat() *structpb.Structdeprecated
- func (x *FileAccessLog) GetLogFormat() *v3.SubstitutionFormatString
- func (x *FileAccessLog) GetPath() string
- func (x *FileAccessLog) GetTypedJsonFormat() *structpb.Structdeprecated
- func (x *FileAccessLog) HasAccessLogFormat() bool
- func (x *FileAccessLog) HasFormat() booldeprecated
- func (x *FileAccessLog) HasJsonFormat() booldeprecated
- func (x *FileAccessLog) HasLogFormat() bool
- func (x *FileAccessLog) HasTypedJsonFormat() booldeprecated
- func (*FileAccessLog) ProtoMessage()
- func (x *FileAccessLog) ProtoReflect() protoreflect.Message
- func (x *FileAccessLog) Reset()
- func (x *FileAccessLog) SetFormat(v string)deprecated
- func (x *FileAccessLog) SetJsonFormat(v *structpb.Struct)deprecated
- func (x *FileAccessLog) SetLogFormat(v *v3.SubstitutionFormatString)
- func (x *FileAccessLog) SetPath(v string)
- func (x *FileAccessLog) SetTypedJsonFormat(v *structpb.Struct)deprecated
- func (x *FileAccessLog) String() string
- func (x *FileAccessLog) WhichAccessLogFormat() case_FileAccessLog_AccessLogFormat
- type FileAccessLog_Format
- type FileAccessLog_JsonFormat
- type FileAccessLog_LogFormat
- type FileAccessLog_TypedJsonFormat
- type FileAccessLog_builder
Constants ¶
const FileAccessLog_AccessLogFormat_not_set_case case_FileAccessLog_AccessLogFormat = 0
const FileAccessLog_Format_case case_FileAccessLog_AccessLogFormat = 2
const FileAccessLog_JsonFormat_case case_FileAccessLog_AccessLogFormat = 3
const FileAccessLog_LogFormat_case case_FileAccessLog_AccessLogFormat = 5
const FileAccessLog_TypedJsonFormat_case case_FileAccessLog_AccessLogFormat = 4
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 valid to be assigned 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) ClearAccessLogFormat ¶
func (x *FileAccessLog) ClearAccessLogFormat()
func (*FileAccessLog) ClearFormat
deprecated
func (x *FileAccessLog) ClearFormat()
Deprecated: Marked as deprecated in envoy/extensions/access_loggers/file/v3/file.proto.
func (*FileAccessLog) ClearJsonFormat
deprecated
func (x *FileAccessLog) ClearJsonFormat()
Deprecated: Marked as deprecated in envoy/extensions/access_loggers/file/v3/file.proto.
func (*FileAccessLog) ClearLogFormat ¶
func (x *FileAccessLog) ClearLogFormat()
func (*FileAccessLog) ClearTypedJsonFormat
deprecated
func (x *FileAccessLog) ClearTypedJsonFormat()
Deprecated: Marked as deprecated in envoy/extensions/access_loggers/file/v3/file.proto.
func (*FileAccessLog) GetAccessLogFormat ¶
func (x *FileAccessLog) GetAccessLogFormat() isFileAccessLog_AccessLogFormat
func (*FileAccessLog) GetFormat
deprecated
func (x *FileAccessLog) GetFormat() string
Deprecated: Marked as deprecated in envoy/extensions/access_loggers/file/v3/file.proto.
func (*FileAccessLog) GetJsonFormat
deprecated
func (x *FileAccessLog) GetJsonFormat() *structpb.Struct
Deprecated: Marked as deprecated in envoy/extensions/access_loggers/file/v3/file.proto.
func (*FileAccessLog) GetLogFormat ¶
func (x *FileAccessLog) GetLogFormat() *v3.SubstitutionFormatString
func (*FileAccessLog) GetPath ¶
func (x *FileAccessLog) GetPath() string
func (*FileAccessLog) GetTypedJsonFormat
deprecated
func (x *FileAccessLog) GetTypedJsonFormat() *structpb.Struct
Deprecated: Marked as deprecated in envoy/extensions/access_loggers/file/v3/file.proto.
func (*FileAccessLog) HasAccessLogFormat ¶
func (x *FileAccessLog) HasAccessLogFormat() bool
func (*FileAccessLog) HasFormat
deprecated
func (x *FileAccessLog) HasFormat() bool
Deprecated: Marked as deprecated in envoy/extensions/access_loggers/file/v3/file.proto.
func (*FileAccessLog) HasJsonFormat
deprecated
func (x *FileAccessLog) HasJsonFormat() bool
Deprecated: Marked as deprecated in envoy/extensions/access_loggers/file/v3/file.proto.
func (*FileAccessLog) HasLogFormat ¶
func (x *FileAccessLog) HasLogFormat() bool
func (*FileAccessLog) HasTypedJsonFormat
deprecated
func (x *FileAccessLog) HasTypedJsonFormat() bool
Deprecated: Marked as deprecated in envoy/extensions/access_loggers/file/v3/file.proto.
func (*FileAccessLog) ProtoMessage ¶
func (*FileAccessLog) ProtoMessage()
func (*FileAccessLog) ProtoReflect ¶
func (x *FileAccessLog) ProtoReflect() protoreflect.Message
func (*FileAccessLog) Reset ¶
func (x *FileAccessLog) Reset()
func (*FileAccessLog) SetFormat
deprecated
func (x *FileAccessLog) SetFormat(v string)
Deprecated: Marked as deprecated in envoy/extensions/access_loggers/file/v3/file.proto.
func (*FileAccessLog) SetJsonFormat
deprecated
func (x *FileAccessLog) SetJsonFormat(v *structpb.Struct)
Deprecated: Marked as deprecated in envoy/extensions/access_loggers/file/v3/file.proto.
func (*FileAccessLog) SetLogFormat ¶
func (x *FileAccessLog) SetLogFormat(v *v3.SubstitutionFormatString)
func (*FileAccessLog) SetPath ¶
func (x *FileAccessLog) SetPath(v string)
func (*FileAccessLog) SetTypedJsonFormat
deprecated
func (x *FileAccessLog) SetTypedJsonFormat(v *structpb.Struct)
Deprecated: Marked as deprecated in envoy/extensions/access_loggers/file/v3/file.proto.
func (*FileAccessLog) String ¶
func (x *FileAccessLog) String() string
func (*FileAccessLog) WhichAccessLogFormat ¶
func (x *FileAccessLog) WhichAccessLogFormat() case_FileAccessLog_AccessLogFormat
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: Marked as deprecated in envoy/extensions/access_loggers/file/v3/file.proto.
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: Marked as deprecated in envoy/extensions/access_loggers/file/v3/file.proto.
JsonFormat *structpb.Struct `protobuf:"bytes,3,opt,name=json_format,json=jsonFormat,proto3,oneof"`
}
type FileAccessLog_LogFormat ¶
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: Marked as deprecated in envoy/extensions/access_loggers/file/v3/file.proto.
TypedJsonFormat *structpb.Struct `protobuf:"bytes,4,opt,name=typed_json_format,json=typedJsonFormat,proto3,oneof"`
}
type FileAccessLog_builder ¶
type FileAccessLog_builder struct {
// A path to a local file to which to write the access log entries.
Path string
// Fields of oneof AccessLogFormat:
// 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: Marked as deprecated in envoy/extensions/access_loggers/file/v3/file.proto.
Format *string
// 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: Marked as deprecated in envoy/extensions/access_loggers/file/v3/file.proto.
JsonFormat *structpb.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: Marked as deprecated in envoy/extensions/access_loggers/file/v3/file.proto.
TypedJsonFormat *structpb.Struct
// Configuration to form access log data and format.
// If not specified, use :ref:`default format <config_access_log_default_format>`.
LogFormat *v3.SubstitutionFormatString
// contains filtered or unexported fields
}
func (FileAccessLog_builder) Build ¶
func (b0 FileAccessLog_builder) Build() *FileAccessLog
Source Files
¶
- file.pb.go