envoy_extensions_access_loggers_file_v4alpha

Documentation

Index

• Variables
• type FileAccessLog
  • func (*FileAccessLog) Descriptor() ([]byte, []int)
  • func (m *FileAccessLog) GetAccessLogFormat() isFileAccessLog_AccessLogFormat
  • func (x *FileAccessLog) GetHiddenEnvoyDeprecatedFormat() string
  • func (x *FileAccessLog) GetHiddenEnvoyDeprecatedJsonFormat() *_struct.Struct
  • func (x *FileAccessLog) GetHiddenEnvoyDeprecatedTypedJsonFormat() *_struct.Struct
  • func (x *FileAccessLog) GetLogFormat() *v4alpha.SubstitutionFormatString
  • func (x *FileAccessLog) GetPath() string
  • func (*FileAccessLog) ProtoMessage()
  • func (x *FileAccessLog) ProtoReflect() protoreflect.Message
  • func (x *FileAccessLog) Reset()
  • func (x *FileAccessLog) String() string
  • func (m *FileAccessLog) Validate() error
• 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_HiddenEnvoyDeprecatedFormat
• type FileAccessLog_HiddenEnvoyDeprecatedJsonFormat
• type FileAccessLog_HiddenEnvoyDeprecatedTypedJsonFormat
• type FileAccessLog_LogFormat

Variables

var File_envoy_extensions_access_loggers_file_v4alpha_file_proto protoreflect.FileDescriptor

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_HiddenEnvoyDeprecatedFormat
	//	*FileAccessLog_HiddenEnvoyDeprecatedJsonFormat
	//	*FileAccessLog_HiddenEnvoyDeprecatedTypedJsonFormat
	//	*FileAccessLog_LogFormat
	AccessLogFormat isFileAccessLog_AccessLogFormat `protobuf_oneof:"access_log_format"`
	// contains filtered or unexported fields
}

Custom configuration for an :ref:`AccessLog <envoy_api_msg_config.accesslog.v4alpha.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

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

Deprecated: Use FileAccessLog.ProtoReflect.Descriptor instead.

func (*FileAccessLog) GetAccessLogFormat

func (m *FileAccessLog) GetAccessLogFormat() isFileAccessLog_AccessLogFormat

func (*FileAccessLog) GetHiddenEnvoyDeprecatedFormat

func (x *FileAccessLog) GetHiddenEnvoyDeprecatedFormat() string

Deprecated: Do not use.

func (*FileAccessLog) GetHiddenEnvoyDeprecatedJsonFormat

func (x *FileAccessLog) GetHiddenEnvoyDeprecatedJsonFormat() *_struct.Struct

Deprecated: Do not use.

func (*FileAccessLog) GetHiddenEnvoyDeprecatedTypedJsonFormat

func (x *FileAccessLog) GetHiddenEnvoyDeprecatedTypedJsonFormat() *_struct.Struct

Deprecated: Do not use.

func (*FileAccessLog) GetLogFormat

func (x *FileAccessLog) GetLogFormat() *v4alpha.SubstitutionFormatString

func (*FileAccessLog) GetPath

func (x *FileAccessLog) GetPath() string

func (*FileAccessLog) ProtoMessage

func (*FileAccessLog) ProtoMessage()

func (*FileAccessLog) ProtoReflect

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, an error is returned.

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_HiddenEnvoyDeprecatedFormat

type FileAccessLog_HiddenEnvoyDeprecatedFormat 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.
	HiddenEnvoyDeprecatedFormat string `protobuf:"bytes,2,opt,name=hidden_envoy_deprecated_format,json=hiddenEnvoyDeprecatedFormat,proto3,oneof"`
}

type FileAccessLog_HiddenEnvoyDeprecatedJsonFormat

type FileAccessLog_HiddenEnvoyDeprecatedJsonFormat 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.
	HiddenEnvoyDeprecatedJsonFormat *_struct.Struct `protobuf:"bytes,3,opt,name=hidden_envoy_deprecated_json_format,json=hiddenEnvoyDeprecatedJsonFormat,proto3,oneof"`
}

type FileAccessLog_HiddenEnvoyDeprecatedTypedJsonFormat

type FileAccessLog_HiddenEnvoyDeprecatedTypedJsonFormat 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.
	HiddenEnvoyDeprecatedTypedJsonFormat *_struct.Struct `protobuf:"bytes,4,opt,name=hidden_envoy_deprecated_typed_json_format,json=hiddenEnvoyDeprecatedTypedJsonFormat,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 *v4alpha.SubstitutionFormatString `protobuf:"bytes,5,opt,name=log_format,json=logFormat,proto3,oneof"`
}