Documentation
¶
Index ¶
- Variables
- type Geoip
- func (*Geoip) Descriptor() ([]byte, []int)deprecated
- func (x *Geoip) GetProvider() *v3.TypedExtensionConfig
- func (x *Geoip) GetXffConfig() *Geoip_XffConfig
- func (*Geoip) ProtoMessage()
- func (x *Geoip) ProtoReflect() protoreflect.Message
- func (x *Geoip) Reset()
- func (x *Geoip) String() string
- func (m *Geoip) Validate() error
- func (m *Geoip) ValidateAll() error
- type GeoipMultiError
- type GeoipValidationError
- type Geoip_XffConfig
- func (*Geoip_XffConfig) Descriptor() ([]byte, []int)deprecated
- func (x *Geoip_XffConfig) GetXffNumTrustedHops() uint32
- func (*Geoip_XffConfig) ProtoMessage()
- func (x *Geoip_XffConfig) ProtoReflect() protoreflect.Message
- func (x *Geoip_XffConfig) Reset()
- func (x *Geoip_XffConfig) String() string
- func (m *Geoip_XffConfig) Validate() error
- func (m *Geoip_XffConfig) ValidateAll() error
- type Geoip_XffConfigMultiError
- type Geoip_XffConfigValidationError
- func (e Geoip_XffConfigValidationError) Cause() error
- func (e Geoip_XffConfigValidationError) Error() string
- func (e Geoip_XffConfigValidationError) ErrorName() string
- func (e Geoip_XffConfigValidationError) Field() string
- func (e Geoip_XffConfigValidationError) Key() bool
- func (e Geoip_XffConfigValidationError) Reason() string
Constants ¶
This section is empty.
Variables ¶
var File_envoy_extensions_filters_http_geoip_v3_geoip_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type Geoip ¶
type Geoip struct {
// If set, the :ref:`xff_num_trusted_hops <envoy_v3_api_field_extensions.filters.http.geoip.v3.Geoip.XffConfig.xff_num_trusted_hops>` field will be used to determine
// trusted client address from “x-forwarded-for“ header.
// Otherwise, the immediate downstream connection source address will be used.
// [#next-free-field: 2]
XffConfig *Geoip_XffConfig `protobuf:"bytes,1,opt,name=xff_config,json=xffConfig,proto3" json:"xff_config,omitempty"`
// Geoip driver specific configuration which depends on the driver being instantiated.
// See the geoip drivers for examples:
//
// - :ref:`MaxMindConfig <envoy_v3_api_msg_extensions.geoip_providers.maxmind.v3.MaxMindConfig>`
// [#extension-category: envoy.geoip_providers]
Provider *v3.TypedExtensionConfig `protobuf:"bytes,3,opt,name=provider,proto3" json:"provider,omitempty"`
// contains filtered or unexported fields
}
func (*Geoip) Descriptor
deprecated
func (*Geoip) GetProvider ¶
func (x *Geoip) GetProvider() *v3.TypedExtensionConfig
func (*Geoip) GetXffConfig ¶
func (x *Geoip) GetXffConfig() *Geoip_XffConfig
func (*Geoip) ProtoMessage ¶
func (*Geoip) ProtoMessage()
func (*Geoip) ProtoReflect ¶
func (x *Geoip) ProtoReflect() protoreflect.Message
func (*Geoip) Validate ¶
Validate checks the field values on Geoip 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 (*Geoip) ValidateAll ¶
ValidateAll checks the field values on Geoip 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 GeoipMultiError, or nil if none found.
type GeoipMultiError ¶
type GeoipMultiError []error
GeoipMultiError is an error wrapping multiple validation errors returned by Geoip.ValidateAll() if the designated constraints aren't met.
func (GeoipMultiError) AllErrors ¶
func (m GeoipMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (GeoipMultiError) Error ¶
func (m GeoipMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type GeoipValidationError ¶
type GeoipValidationError struct {
// contains filtered or unexported fields
}
GeoipValidationError is the validation error returned by Geoip.Validate if the designated constraints aren't met.
func (GeoipValidationError) Cause ¶
func (e GeoipValidationError) Cause() error
Cause function returns cause value.
func (GeoipValidationError) Error ¶
func (e GeoipValidationError) Error() string
Error satisfies the builtin error interface
func (GeoipValidationError) ErrorName ¶
func (e GeoipValidationError) ErrorName() string
ErrorName returns error name.
func (GeoipValidationError) Field ¶
func (e GeoipValidationError) Field() string
Field function returns field value.
func (GeoipValidationError) Key ¶
func (e GeoipValidationError) Key() bool
Key function returns key value.
func (GeoipValidationError) Reason ¶
func (e GeoipValidationError) Reason() string
Reason function returns reason value.
type Geoip_XffConfig ¶
type Geoip_XffConfig struct {
// The number of additional ingress proxy hops from the right side of the
// :ref:`config_http_conn_man_headers_x-forwarded-for` HTTP header to trust when
// determining the origin client's IP address. The default is zero if this option
// is not specified. See the documentation for
// :ref:`config_http_conn_man_headers_x-forwarded-for` for more information.
XffNumTrustedHops uint32 `protobuf:"varint,1,opt,name=xff_num_trusted_hops,json=xffNumTrustedHops,proto3" json:"xff_num_trusted_hops,omitempty"`
// contains filtered or unexported fields
}
func (*Geoip_XffConfig) Descriptor
deprecated
func (*Geoip_XffConfig) Descriptor() ([]byte, []int)
Deprecated: Use Geoip_XffConfig.ProtoReflect.Descriptor instead.
func (*Geoip_XffConfig) GetXffNumTrustedHops ¶
func (x *Geoip_XffConfig) GetXffNumTrustedHops() uint32
func (*Geoip_XffConfig) ProtoMessage ¶
func (*Geoip_XffConfig) ProtoMessage()
func (*Geoip_XffConfig) ProtoReflect ¶
func (x *Geoip_XffConfig) ProtoReflect() protoreflect.Message
func (*Geoip_XffConfig) Reset ¶
func (x *Geoip_XffConfig) Reset()
func (*Geoip_XffConfig) String ¶
func (x *Geoip_XffConfig) String() string
func (*Geoip_XffConfig) Validate ¶
func (m *Geoip_XffConfig) Validate() error
Validate checks the field values on Geoip_XffConfig 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 (*Geoip_XffConfig) ValidateAll ¶
func (m *Geoip_XffConfig) ValidateAll() error
ValidateAll checks the field values on Geoip_XffConfig 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 Geoip_XffConfigMultiError, or nil if none found.
type Geoip_XffConfigMultiError ¶
type Geoip_XffConfigMultiError []error
Geoip_XffConfigMultiError is an error wrapping multiple validation errors returned by Geoip_XffConfig.ValidateAll() if the designated constraints aren't met.
func (Geoip_XffConfigMultiError) AllErrors ¶
func (m Geoip_XffConfigMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (Geoip_XffConfigMultiError) Error ¶
func (m Geoip_XffConfigMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type Geoip_XffConfigValidationError ¶
type Geoip_XffConfigValidationError struct {
// contains filtered or unexported fields
}
Geoip_XffConfigValidationError is the validation error returned by Geoip_XffConfig.Validate if the designated constraints aren't met.
func (Geoip_XffConfigValidationError) Cause ¶
func (e Geoip_XffConfigValidationError) Cause() error
Cause function returns cause value.
func (Geoip_XffConfigValidationError) Error ¶
func (e Geoip_XffConfigValidationError) Error() string
Error satisfies the builtin error interface
func (Geoip_XffConfigValidationError) ErrorName ¶
func (e Geoip_XffConfigValidationError) ErrorName() string
ErrorName returns error name.
func (Geoip_XffConfigValidationError) Field ¶
func (e Geoip_XffConfigValidationError) Field() string
Field function returns field value.
func (Geoip_XffConfigValidationError) Key ¶
func (e Geoip_XffConfigValidationError) Key() bool
Key function returns key value.
func (Geoip_XffConfigValidationError) Reason ¶
func (e Geoip_XffConfigValidationError) Reason() string
Reason function returns reason value.
Source Files