package pick_firstv3

import "github.com/envoyproxy/go-control-plane/envoy/extensions/load_balancing_policies/pick_first/v3"

Index

Variables

var File_envoy_extensions_load_balancing_policies_pick_first_v3_pick_first_proto protoreflect.FileDescriptor

Types

type PickFirst

type PickFirst struct {

	// If set to true, instructs the LB policy to shuffle the list of addresses
	// received from the name resolver before attempting to connect to them.
	ShuffleAddressList bool `protobuf:"varint,1,opt,name=shuffle_address_list,json=shuffleAddressList,proto3" json:"shuffle_address_list,omitempty"`
	// contains filtered or unexported fields
}

This configuration allows the built-in PICK_FIRST LB policy to be configured via the LB policy extension point.

func (*PickFirst) Descriptor

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

Deprecated: Use PickFirst.ProtoReflect.Descriptor instead.

func (*PickFirst) GetShuffleAddressList

func (x *PickFirst) GetShuffleAddressList() bool

func (*PickFirst) ProtoMessage

func (*PickFirst) ProtoMessage()

func (*PickFirst) ProtoReflect

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

func (*PickFirst) Reset

func (x *PickFirst) Reset()

func (*PickFirst) String

func (x *PickFirst) String() string

func (*PickFirst) Validate

func (m *PickFirst) Validate() error

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

func (m *PickFirst) ValidateAll() error

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

type PickFirstMultiError

type PickFirstMultiError []error

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

func (PickFirstMultiError) AllErrors

func (m PickFirstMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (PickFirstMultiError) Error

func (m PickFirstMultiError) Error() string

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

type PickFirstValidationError

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

PickFirstValidationError is the validation error returned by PickFirst.Validate if the designated constraints aren't met.

func (PickFirstValidationError) Cause

func (e PickFirstValidationError) Cause() error

Cause function returns cause value.

func (PickFirstValidationError) Error

func (e PickFirstValidationError) Error() string

Error satisfies the builtin error interface

func (PickFirstValidationError) ErrorName

func (e PickFirstValidationError) ErrorName() string

ErrorName returns error name.

func (PickFirstValidationError) Field

func (e PickFirstValidationError) Field() string

Field function returns field value.

func (PickFirstValidationError) Key

Key function returns key value.

func (PickFirstValidationError) Reason

func (e PickFirstValidationError) Reason() string

Reason function returns reason value.

Source Files

pick_first.pb.go pick_first.pb.validate.go

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

Tools for package owners.