Documentation
¶
Index ¶
- Variables
- type Descriptor
- func (*Descriptor) Descriptor() ([]byte, []int)deprecated
- func (x *Descriptor) GetDescriptorKey() string
- func (m *Descriptor) GetExprSpecifier() isDescriptor_ExprSpecifier
- func (x *Descriptor) GetParsed() *v1alpha1.Expr
- func (x *Descriptor) GetSkipIfError() bool
- func (x *Descriptor) GetText() string
- func (*Descriptor) ProtoMessage()
- func (x *Descriptor) ProtoReflect() protoreflect.Message
- func (x *Descriptor) Reset()
- func (x *Descriptor) String() string
- func (m *Descriptor) Validate() error
- func (m *Descriptor) ValidateAll() error
- type DescriptorMultiError
- type DescriptorValidationError
- type Descriptor_Parsed
- type Descriptor_Text
Constants ¶
This section is empty.
Variables ¶
var File_envoy_extensions_rate_limit_descriptors_expr_v3_expr_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type Descriptor ¶
type Descriptor struct { // The key to use in the descriptor entry. DescriptorKey string `protobuf:"bytes,1,opt,name=descriptor_key,json=descriptorKey,proto3" json:"descriptor_key,omitempty"` // If set to true, Envoy skips the descriptor if the expression evaluates to an error. // By default, the rate limit is not applied when an expression produces an error. SkipIfError bool `protobuf:"varint,2,opt,name=skip_if_error,json=skipIfError,proto3" json:"skip_if_error,omitempty"` // Types that are assignable to ExprSpecifier: // *Descriptor_Text // *Descriptor_Parsed ExprSpecifier isDescriptor_ExprSpecifier `protobuf_oneof:"expr_specifier"` // contains filtered or unexported fields }
The following descriptor entry is appended with a value computed from a symbolic Common Expression Language expression. See :ref:`attributes <arch_overview_attributes>` for the set of available attributes.
.. code-block:: cpp
("<descriptor_key>", "<expression_value>")
func (*Descriptor) Descriptor
deprecated
func (*Descriptor) Descriptor() ([]byte, []int)
Deprecated: Use Descriptor.ProtoReflect.Descriptor instead.
func (*Descriptor) GetDescriptorKey ¶
func (x *Descriptor) GetDescriptorKey() string
func (*Descriptor) GetExprSpecifier ¶
func (m *Descriptor) GetExprSpecifier() isDescriptor_ExprSpecifier
func (*Descriptor) GetParsed ¶
func (x *Descriptor) GetParsed() *v1alpha1.Expr
func (*Descriptor) GetSkipIfError ¶
func (x *Descriptor) GetSkipIfError() bool
func (*Descriptor) GetText ¶
func (x *Descriptor) GetText() string
func (*Descriptor) ProtoMessage ¶
func (*Descriptor) ProtoMessage()
func (*Descriptor) ProtoReflect ¶
func (x *Descriptor) ProtoReflect() protoreflect.Message
func (*Descriptor) Reset ¶
func (x *Descriptor) Reset()
func (*Descriptor) String ¶
func (x *Descriptor) String() string
func (*Descriptor) Validate ¶
func (m *Descriptor) Validate() error
Validate checks the field values on Descriptor 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 (*Descriptor) ValidateAll ¶ added in v0.10.0
func (m *Descriptor) ValidateAll() error
ValidateAll checks the field values on Descriptor 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 DescriptorMultiError, or nil if none found.
type DescriptorMultiError ¶ added in v0.10.0
type DescriptorMultiError []error
DescriptorMultiError is an error wrapping multiple validation errors returned by Descriptor.ValidateAll() if the designated constraints aren't met.
func (DescriptorMultiError) AllErrors ¶ added in v0.10.0
func (m DescriptorMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (DescriptorMultiError) Error ¶ added in v0.10.0
func (m DescriptorMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type DescriptorValidationError ¶
type DescriptorValidationError struct {
// contains filtered or unexported fields
}
DescriptorValidationError is the validation error returned by Descriptor.Validate if the designated constraints aren't met.
func (DescriptorValidationError) Cause ¶
func (e DescriptorValidationError) Cause() error
Cause function returns cause value.
func (DescriptorValidationError) Error ¶
func (e DescriptorValidationError) Error() string
Error satisfies the builtin error interface
func (DescriptorValidationError) ErrorName ¶
func (e DescriptorValidationError) ErrorName() string
ErrorName returns error name.
func (DescriptorValidationError) Field ¶
func (e DescriptorValidationError) Field() string
Field function returns field value.
func (DescriptorValidationError) Key ¶
func (e DescriptorValidationError) Key() bool
Key function returns key value.
func (DescriptorValidationError) Reason ¶
func (e DescriptorValidationError) Reason() string
Reason function returns reason value.
type Descriptor_Parsed ¶
type Descriptor_Text ¶
type Descriptor_Text struct { // Expression in a text form, e.g. "connection.requested_server_name". Text string `protobuf:"bytes,3,opt,name=text,proto3,oneof"` }