package caresv3

import "github.com/envoyproxy/go-control-plane/envoy/extensions/network/dns_resolver/cares/v3"

Index ¶

• Variables
• type CaresDnsResolverConfig
• func (*CaresDnsResolverConfig) Descriptor() ([]byte, []int)
• func (x *CaresDnsResolverConfig) GetDnsResolverOptions() *v3.DnsResolverOptions
• func (x *CaresDnsResolverConfig) GetFilterUnroutableFamilies() bool
• func (x *CaresDnsResolverConfig) GetResolvers() []*v3.Address
• func (x *CaresDnsResolverConfig) GetUseResolversAsFallback() bool
• func (*CaresDnsResolverConfig) ProtoMessage()
• func (x *CaresDnsResolverConfig) ProtoReflect() protoreflect.Message
• func (x *CaresDnsResolverConfig) Reset()
• func (x *CaresDnsResolverConfig) String() string
• func (m *CaresDnsResolverConfig) Validate() error
• func (m *CaresDnsResolverConfig) ValidateAll() error
• type CaresDnsResolverConfigMultiError
• func (m CaresDnsResolverConfigMultiError) AllErrors() []error
• func (m CaresDnsResolverConfigMultiError) Error() string
• type CaresDnsResolverConfigValidationError
• func (e CaresDnsResolverConfigValidationError) Cause() error
• func (e CaresDnsResolverConfigValidationError) Error() string
• func (e CaresDnsResolverConfigValidationError) ErrorName() string
• func (e CaresDnsResolverConfigValidationError) Field() string
• func (e CaresDnsResolverConfigValidationError) Key() bool
• func (e CaresDnsResolverConfigValidationError) Reason() string

Variables ¶

var File_envoy_extensions_network_dns_resolver_cares_v3_cares_dns_resolver_proto protoreflect.FileDescriptor

Types ¶

type CaresDnsResolverConfig ¶

type CaresDnsResolverConfig struct {

	// A list of dns resolver addresses.
	// :ref:`use_resolvers_as_fallback<envoy_v3_api_field_extensions.network.dns_resolver.cares.v3.CaresDnsResolverConfig.use_resolvers_as_fallback>`
	// below dictates if the DNS client should override system defaults or only use the provided
	// resolvers if the system defaults are not available, i.e., as a fallback.
	Resolvers []*v3.Address `protobuf:"bytes,1,rep,name=resolvers,proto3" json:"resolvers,omitempty"`
	// If true use the resolvers listed in the
	// :ref:`resolvers<envoy_v3_api_field_extensions.network.dns_resolver.cares.v3.CaresDnsResolverConfig.resolvers>`
	// field only if c-ares is unable to obtain a
	// nameserver from the system (e.g., /etc/resolv.conf).
	// Otherwise, the resolvers listed in the resolvers list will override the default system
	// resolvers. Defaults to false.
	UseResolversAsFallback bool `protobuf:"varint,3,opt,name=use_resolvers_as_fallback,json=useResolversAsFallback,proto3" json:"use_resolvers_as_fallback,omitempty"`
	// The resolver will query available network interfaces and determine if there are no available
	// interfaces for a given IP family. It will then filter these addresses from the results it
	// presents. e.g., if there are no available IPv4 network interfaces, the resolver will not
	// provide IPv4 addresses.
	FilterUnroutableFamilies bool `protobuf:"varint,4,opt,name=filter_unroutable_families,json=filterUnroutableFamilies,proto3" json:"filter_unroutable_families,omitempty"`
	// Configuration of DNS resolver option flags which control the behavior of the DNS resolver.
	DnsResolverOptions *v3.DnsResolverOptions `protobuf:"bytes,2,opt,name=dns_resolver_options,json=dnsResolverOptions,proto3" json:"dns_resolver_options,omitempty"`
	// contains filtered or unexported fields
}

Configuration for c-ares DNS resolver.

func (*CaresDnsResolverConfig) Descriptor ¶

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

Deprecated: Use CaresDnsResolverConfig.ProtoReflect.Descriptor instead.

func (*CaresDnsResolverConfig) GetDnsResolverOptions ¶

func (x *CaresDnsResolverConfig) GetDnsResolverOptions() *v3.DnsResolverOptions

func (*CaresDnsResolverConfig) GetFilterUnroutableFamilies ¶

func (x *CaresDnsResolverConfig) GetFilterUnroutableFamilies() bool

func (*CaresDnsResolverConfig) GetResolvers ¶

func (x *CaresDnsResolverConfig) GetResolvers() []*v3.Address

func (*CaresDnsResolverConfig) GetUseResolversAsFallback ¶

func (x *CaresDnsResolverConfig) GetUseResolversAsFallback() bool

func (*CaresDnsResolverConfig) ProtoMessage ¶

func (*CaresDnsResolverConfig) ProtoMessage()

func (*CaresDnsResolverConfig) ProtoReflect ¶

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

func (*CaresDnsResolverConfig) Reset ¶

func (x *CaresDnsResolverConfig) Reset()

func (*CaresDnsResolverConfig) String ¶

func (x *CaresDnsResolverConfig) String() string

func (*CaresDnsResolverConfig) Validate ¶

func (m *CaresDnsResolverConfig) Validate() error

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

func (m *CaresDnsResolverConfig) ValidateAll() error

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

type CaresDnsResolverConfigMultiError ¶

type CaresDnsResolverConfigMultiError []error

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

func (CaresDnsResolverConfigMultiError) AllErrors ¶

func (m CaresDnsResolverConfigMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (CaresDnsResolverConfigMultiError) Error ¶

func (m CaresDnsResolverConfigMultiError) Error() string

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

type CaresDnsResolverConfigValidationError ¶

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

CaresDnsResolverConfigValidationError is the validation error returned by CaresDnsResolverConfig.Validate if the designated constraints aren't met.

func (CaresDnsResolverConfigValidationError) Cause ¶

func (e CaresDnsResolverConfigValidationError) Cause() error

Cause function returns cause value.

func (CaresDnsResolverConfigValidationError) Error ¶

func (e CaresDnsResolverConfigValidationError) Error() string

Error satisfies the builtin error interface

func (CaresDnsResolverConfigValidationError) ErrorName ¶

func (e CaresDnsResolverConfigValidationError) ErrorName() string

ErrorName returns error name.

func (CaresDnsResolverConfigValidationError) Field ¶

func (e CaresDnsResolverConfigValidationError) Field() string

Field function returns field value.

func (CaresDnsResolverConfigValidationError) Key ¶

func (e CaresDnsResolverConfigValidationError) Key() bool

Key function returns key value.

func (CaresDnsResolverConfigValidationError) Reason ¶

func (e CaresDnsResolverConfigValidationError) Reason() string

Reason function returns reason value.

Source Files ¶

cares_dns_resolver.pb.go cares_dns_resolver.pb.validate.go