package commonv3

import "github.com/envoyproxy/go-control-plane/envoy/extensions/geoip_providers/common/v3"

Index

Variables 

var File_envoy_extensions_geoip_providers_common_v3_common_proto protoreflect.FileDescriptor

Types

type CommonGeoipProviderConfig 

type CommonGeoipProviderConfig struct {

	// Configuration for geolocation headers to add to request.
	GeoHeadersToAdd *CommonGeoipProviderConfig_GeolocationHeadersToAdd `protobuf:"bytes,1,opt,name=geo_headers_to_add,json=geoHeadersToAdd,proto3" json:"geo_headers_to_add,omitempty"`
	// contains filtered or unexported fields
}

func (*CommonGeoipProviderConfig) Descriptor 

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

Deprecated: Use CommonGeoipProviderConfig.ProtoReflect.Descriptor instead.

func (*CommonGeoipProviderConfig) GetGeoHeadersToAdd 

func (x *CommonGeoipProviderConfig) GetGeoHeadersToAdd() *CommonGeoipProviderConfig_GeolocationHeadersToAdd

func (*CommonGeoipProviderConfig) ProtoMessage 

func (*CommonGeoipProviderConfig) ProtoMessage()

func (*CommonGeoipProviderConfig) ProtoReflect 

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

func (*CommonGeoipProviderConfig) Reset 

func (x *CommonGeoipProviderConfig) Reset()

func (*CommonGeoipProviderConfig) String 

func (x *CommonGeoipProviderConfig) String() string

func (*CommonGeoipProviderConfig) Validate 

func (m *CommonGeoipProviderConfig) Validate() error

Validate checks the field values on CommonGeoipProviderConfig 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 (*CommonGeoipProviderConfig) ValidateAll 

func (m *CommonGeoipProviderConfig) ValidateAll() error

ValidateAll checks the field values on CommonGeoipProviderConfig 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 CommonGeoipProviderConfigMultiError, or nil if none found.

type CommonGeoipProviderConfigMultiError 

type CommonGeoipProviderConfigMultiError []error

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

func (CommonGeoipProviderConfigMultiError) AllErrors 

func (m CommonGeoipProviderConfigMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (CommonGeoipProviderConfigMultiError) Error 

func (m CommonGeoipProviderConfigMultiError) Error() string

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

type CommonGeoipProviderConfigValidationError 

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

CommonGeoipProviderConfigValidationError is the validation error returned by CommonGeoipProviderConfig.Validate if the designated constraints aren't met.

func (CommonGeoipProviderConfigValidationError) Cause 

func (e CommonGeoipProviderConfigValidationError) Cause() error

Cause function returns cause value.

func (CommonGeoipProviderConfigValidationError) Error 

func (e CommonGeoipProviderConfigValidationError) Error() string

Error satisfies the builtin error interface

func (CommonGeoipProviderConfigValidationError) ErrorName 

func (e CommonGeoipProviderConfigValidationError) ErrorName() string

ErrorName returns error name.

func (CommonGeoipProviderConfigValidationError) Field 

func (e CommonGeoipProviderConfigValidationError) Field() string

Field function returns field value.

func (CommonGeoipProviderConfigValidationError) Key 

func (e CommonGeoipProviderConfigValidationError) Key() bool

Key function returns key value.

func (CommonGeoipProviderConfigValidationError) Reason 

func (e CommonGeoipProviderConfigValidationError) Reason() string

Reason function returns reason value.

type CommonGeoipProviderConfig_GeolocationHeadersToAdd 

type CommonGeoipProviderConfig_GeolocationHeadersToAdd struct {

	// If set, the header will be used to populate the country ISO code associated with the IP address.
	Country string `protobuf:"bytes,1,opt,name=country,proto3" json:"country,omitempty"`
	// If set, the header will be used to populate the city associated with the IP address.
	City string `protobuf:"bytes,2,opt,name=city,proto3" json:"city,omitempty"`
	// If set, the header will be used to populate the region ISO code associated with the IP address.
	// The least specific subdivision will be selected as region value.
	Region string `protobuf:"bytes,3,opt,name=region,proto3" json:"region,omitempty"`
	// If set, the header will be used to populate the ASN associated with the IP address.
	Asn string `protobuf:"bytes,4,opt,name=asn,proto3" json:"asn,omitempty"`
	// If set, the IP address will be checked if it belongs to any type of anonymization network (e.g. VPN, public proxy etc)
	// and header will be populated with the check result. Header value will be set to either "true" or "false" depending on the check result.
	IsAnon string `protobuf:"bytes,5,opt,name=is_anon,json=isAnon,proto3" json:"is_anon,omitempty"`
	// If set, the IP address will be checked if it belongs to a VPN and header will be populated with the check result.
	// Header value will be set to either "true" or "false" depending on the check result.
	AnonVpn string `protobuf:"bytes,6,opt,name=anon_vpn,json=anonVpn,proto3" json:"anon_vpn,omitempty"`
	// If set, the IP address will be checked if it belongs to a hosting provider and header will be populated with the check result.
	// Header value will be set to either "true" or "false" depending on the check result.
	AnonHosting string `protobuf:"bytes,7,opt,name=anon_hosting,json=anonHosting,proto3" json:"anon_hosting,omitempty"`
	// If set, the IP address will be checked if it belongs to a TOR exit node and header will be populated with the check result.
	// Header value will be set to either "true" or "false" depending on the check result.
	AnonTor string `protobuf:"bytes,8,opt,name=anon_tor,json=anonTor,proto3" json:"anon_tor,omitempty"`
	// If set, the IP address will be checked if it belongs to a public proxy and header will be populated with the check result.
	// Header value will be set to either "true" or "false" depending on the check result.
	AnonProxy string `protobuf:"bytes,9,opt,name=anon_proxy,json=anonProxy,proto3" json:"anon_proxy,omitempty"`
	// contains filtered or unexported fields
}

The set of geolocation headers to add to request. If any of the configured headers is present in the incoming request, it will be overridden by the :ref:`Geoip filter <config_http_filters_geoip>`. [#next-free-field: 10]

func (*CommonGeoipProviderConfig_GeolocationHeadersToAdd) Descriptor 

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

Deprecated: Use CommonGeoipProviderConfig_GeolocationHeadersToAdd.ProtoReflect.Descriptor instead.

func (*CommonGeoipProviderConfig_GeolocationHeadersToAdd) GetAnonHosting 

func (x *CommonGeoipProviderConfig_GeolocationHeadersToAdd) GetAnonHosting() string

func (*CommonGeoipProviderConfig_GeolocationHeadersToAdd) GetAnonProxy 

func (x *CommonGeoipProviderConfig_GeolocationHeadersToAdd) GetAnonProxy() string

func (*CommonGeoipProviderConfig_GeolocationHeadersToAdd) GetAnonTor 

func (x *CommonGeoipProviderConfig_GeolocationHeadersToAdd) GetAnonTor() string

func (*CommonGeoipProviderConfig_GeolocationHeadersToAdd) GetAnonVpn 

func (x *CommonGeoipProviderConfig_GeolocationHeadersToAdd) GetAnonVpn() string

func (*CommonGeoipProviderConfig_GeolocationHeadersToAdd) GetAsn 

func (x *CommonGeoipProviderConfig_GeolocationHeadersToAdd) GetAsn() string

func (*CommonGeoipProviderConfig_GeolocationHeadersToAdd) GetCity 

func (x *CommonGeoipProviderConfig_GeolocationHeadersToAdd) GetCity() string

func (*CommonGeoipProviderConfig_GeolocationHeadersToAdd) GetCountry 

func (x *CommonGeoipProviderConfig_GeolocationHeadersToAdd) GetCountry() string

func (*CommonGeoipProviderConfig_GeolocationHeadersToAdd) GetIsAnon 

func (x *CommonGeoipProviderConfig_GeolocationHeadersToAdd) GetIsAnon() string

func (*CommonGeoipProviderConfig_GeolocationHeadersToAdd) GetRegion 

func (x *CommonGeoipProviderConfig_GeolocationHeadersToAdd) GetRegion() string

func (*CommonGeoipProviderConfig_GeolocationHeadersToAdd) ProtoMessage 

func (*CommonGeoipProviderConfig_GeolocationHeadersToAdd) ProtoMessage()

func (*CommonGeoipProviderConfig_GeolocationHeadersToAdd) ProtoReflect 

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

func (*CommonGeoipProviderConfig_GeolocationHeadersToAdd) Reset 

func (x *CommonGeoipProviderConfig_GeolocationHeadersToAdd) Reset()

func (*CommonGeoipProviderConfig_GeolocationHeadersToAdd) String 

func (x *CommonGeoipProviderConfig_GeolocationHeadersToAdd) String() string

func (*CommonGeoipProviderConfig_GeolocationHeadersToAdd) Validate 

func (m *CommonGeoipProviderConfig_GeolocationHeadersToAdd) Validate() error

Validate checks the field values on CommonGeoipProviderConfig_GeolocationHeadersToAdd 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 (*CommonGeoipProviderConfig_GeolocationHeadersToAdd) ValidateAll 

func (m *CommonGeoipProviderConfig_GeolocationHeadersToAdd) ValidateAll() error

ValidateAll checks the field values on CommonGeoipProviderConfig_GeolocationHeadersToAdd 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 CommonGeoipProviderConfig_GeolocationHeadersToAddMultiError, or nil if none found.

type CommonGeoipProviderConfig_GeolocationHeadersToAddMultiError 

type CommonGeoipProviderConfig_GeolocationHeadersToAddMultiError []error

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

func (CommonGeoipProviderConfig_GeolocationHeadersToAddMultiError) AllErrors 

func (m CommonGeoipProviderConfig_GeolocationHeadersToAddMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (CommonGeoipProviderConfig_GeolocationHeadersToAddMultiError) Error 

func (m CommonGeoipProviderConfig_GeolocationHeadersToAddMultiError) Error() string

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

type CommonGeoipProviderConfig_GeolocationHeadersToAddValidationError 

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

CommonGeoipProviderConfig_GeolocationHeadersToAddValidationError is the validation error returned by CommonGeoipProviderConfig_GeolocationHeadersToAdd.Validate if the designated constraints aren't met.

func (CommonGeoipProviderConfig_GeolocationHeadersToAddValidationError) Cause 

func (e CommonGeoipProviderConfig_GeolocationHeadersToAddValidationError) Cause() error

Cause function returns cause value.

func (CommonGeoipProviderConfig_GeolocationHeadersToAddValidationError) Error 

func (e CommonGeoipProviderConfig_GeolocationHeadersToAddValidationError) Error() string

Error satisfies the builtin error interface

func (CommonGeoipProviderConfig_GeolocationHeadersToAddValidationError) ErrorName 

func (e CommonGeoipProviderConfig_GeolocationHeadersToAddValidationError) ErrorName() string

ErrorName returns error name.

func (CommonGeoipProviderConfig_GeolocationHeadersToAddValidationError) Field 

func (e CommonGeoipProviderConfig_GeolocationHeadersToAddValidationError) Field() string

Field function returns field value.

func (CommonGeoipProviderConfig_GeolocationHeadersToAddValidationError) Key 

func (e CommonGeoipProviderConfig_GeolocationHeadersToAddValidationError) Key() bool

Key function returns key value.

func (CommonGeoipProviderConfig_GeolocationHeadersToAddValidationError) Reason 

func (e CommonGeoipProviderConfig_GeolocationHeadersToAddValidationError) Reason() string

Reason function returns reason value.

Source Files

common.pb.go common.pb.validate.go

Version
v1.32.4 (latest)
Published
Feb 3, 2025
Platform
linux/amd64
Imports
18 packages
Last checked
1 day ago –

Tools for package owners.