httpv3

package
v1.37.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 13, 2026 License: Apache-2.0 Imports: 20 Imported by: 30

Documentation

Index

Constants

This section is empty.

Variables

View Source
var File_envoy_type_http_v3_cookie_proto protoreflect.FileDescriptor
View Source
var File_envoy_type_http_v3_path_transformation_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type Cookie struct {

	// The name that will be used to obtain cookie value from downstream HTTP request or generate
	// new cookie for downstream.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Duration of cookie. This will be used to set the expiry time of a new cookie when it is
	// generated. Set this to 0s to use a session cookie and disable cookie expiration.
	Ttl *durationpb.Duration `protobuf:"bytes,2,opt,name=ttl,proto3" json:"ttl,omitempty"`
	// Path of cookie. This will be used to set the path of a new cookie when it is generated.
	// If no path is specified here, no path will be set for the cookie.
	Path string `protobuf:"bytes,3,opt,name=path,proto3" json:"path,omitempty"`
	// Additional attributes for the cookie. They will be used when generating a new cookie.
	Attributes []*CookieAttribute `protobuf:"bytes,4,rep,name=attributes,proto3" json:"attributes,omitempty"`
	// contains filtered or unexported fields
}

Cookie defines an API for obtaining or generating HTTP cookie.

func (*Cookie) Descriptor deprecated

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

Deprecated: Use Cookie.ProtoReflect.Descriptor instead.

func (*Cookie) GetAttributes added in v1.35.0

func (x *Cookie) GetAttributes() []*CookieAttribute

func (*Cookie) GetName

func (x *Cookie) GetName() string

func (*Cookie) GetPath

func (x *Cookie) GetPath() string

func (*Cookie) GetTtl

func (x *Cookie) GetTtl() *durationpb.Duration

func (*Cookie) ProtoMessage

func (*Cookie) ProtoMessage()

func (*Cookie) ProtoReflect

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

func (*Cookie) Reset

func (x *Cookie) Reset()

func (*Cookie) String

func (x *Cookie) String() string

func (*Cookie) Validate

func (m *Cookie) Validate() error

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

func (m *Cookie) ValidateAll() error

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

type CookieAttribute added in v1.35.0

type CookieAttribute struct {

	// The name of the cookie attribute.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The optional value of the cookie attribute.
	Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

CookieAttribute defines an API for adding additional attributes for a HTTP cookie.

func (*CookieAttribute) Descriptor deprecated added in v1.35.0

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

Deprecated: Use CookieAttribute.ProtoReflect.Descriptor instead.

func (*CookieAttribute) GetName added in v1.35.0

func (x *CookieAttribute) GetName() string

func (*CookieAttribute) GetValue added in v1.35.0

func (x *CookieAttribute) GetValue() string

func (*CookieAttribute) ProtoMessage added in v1.35.0

func (*CookieAttribute) ProtoMessage()

func (*CookieAttribute) ProtoReflect added in v1.35.0

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

func (*CookieAttribute) Reset added in v1.35.0

func (x *CookieAttribute) Reset()

func (*CookieAttribute) String added in v1.35.0

func (x *CookieAttribute) String() string

func (*CookieAttribute) Validate added in v1.35.0

func (m *CookieAttribute) Validate() error

Validate checks the field values on CookieAttribute 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 (*CookieAttribute) ValidateAll added in v1.35.0

func (m *CookieAttribute) ValidateAll() error

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

type CookieAttributeMultiError added in v1.35.0

type CookieAttributeMultiError []error

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

func (CookieAttributeMultiError) AllErrors added in v1.35.0

func (m CookieAttributeMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (CookieAttributeMultiError) Error added in v1.35.0

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

type CookieAttributeValidationError added in v1.35.0

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

CookieAttributeValidationError is the validation error returned by CookieAttribute.Validate if the designated constraints aren't met.

func (CookieAttributeValidationError) Cause added in v1.35.0

Cause function returns cause value.

func (CookieAttributeValidationError) Error added in v1.35.0

Error satisfies the builtin error interface

func (CookieAttributeValidationError) ErrorName added in v1.35.0

func (e CookieAttributeValidationError) ErrorName() string

ErrorName returns error name.

func (CookieAttributeValidationError) Field added in v1.35.0

Field function returns field value.

func (CookieAttributeValidationError) Key added in v1.35.0

Key function returns key value.

func (CookieAttributeValidationError) Reason added in v1.35.0

Reason function returns reason value.

type CookieMultiError

type CookieMultiError []error

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

func (CookieMultiError) AllErrors

func (m CookieMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (CookieMultiError) Error

func (m CookieMultiError) Error() string

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

type CookieValidationError

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

CookieValidationError is the validation error returned by Cookie.Validate if the designated constraints aren't met.

func (CookieValidationError) Cause

func (e CookieValidationError) Cause() error

Cause function returns cause value.

func (CookieValidationError) Error

func (e CookieValidationError) Error() string

Error satisfies the builtin error interface

func (CookieValidationError) ErrorName

func (e CookieValidationError) ErrorName() string

ErrorName returns error name.

func (CookieValidationError) Field

func (e CookieValidationError) Field() string

Field function returns field value.

func (CookieValidationError) Key

func (e CookieValidationError) Key() bool

Key function returns key value.

func (CookieValidationError) Reason

func (e CookieValidationError) Reason() string

Reason function returns reason value.

type PathTransformation

type PathTransformation struct {

	// A list of operations to apply. Transformations will be performed in the order that they appear.
	Operations []*PathTransformation_Operation `protobuf:"bytes,1,rep,name=operations,proto3" json:"operations,omitempty"`
	// contains filtered or unexported fields
}

func (*PathTransformation) Descriptor deprecated

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

Deprecated: Use PathTransformation.ProtoReflect.Descriptor instead.

func (*PathTransformation) GetOperations

func (x *PathTransformation) GetOperations() []*PathTransformation_Operation

func (*PathTransformation) ProtoMessage

func (*PathTransformation) ProtoMessage()

func (*PathTransformation) ProtoReflect

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

func (*PathTransformation) Reset

func (x *PathTransformation) Reset()

func (*PathTransformation) String

func (x *PathTransformation) String() string

func (*PathTransformation) Validate

func (m *PathTransformation) Validate() error

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

func (m *PathTransformation) ValidateAll() error

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

type PathTransformationMultiError

type PathTransformationMultiError []error

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

func (PathTransformationMultiError) AllErrors

func (m PathTransformationMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (PathTransformationMultiError) Error

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

type PathTransformationValidationError

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

PathTransformationValidationError is the validation error returned by PathTransformation.Validate if the designated constraints aren't met.

func (PathTransformationValidationError) Cause

Cause function returns cause value.

func (PathTransformationValidationError) Error

Error satisfies the builtin error interface

func (PathTransformationValidationError) ErrorName

ErrorName returns error name.

func (PathTransformationValidationError) Field

Field function returns field value.

func (PathTransformationValidationError) Key

Key function returns key value.

func (PathTransformationValidationError) Reason

Reason function returns reason value.

type PathTransformation_Operation

type PathTransformation_Operation struct {

	// Types that are valid to be assigned to OperationSpecifier:
	//
	//	*PathTransformation_Operation_NormalizePathRfc_3986
	//	*PathTransformation_Operation_MergeSlashes_
	OperationSpecifier isPathTransformation_Operation_OperationSpecifier `protobuf_oneof:"operation_specifier"`
	// contains filtered or unexported fields
}

A type of operation to alter text.

func (*PathTransformation_Operation) Descriptor deprecated

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

Deprecated: Use PathTransformation_Operation.ProtoReflect.Descriptor instead.

func (*PathTransformation_Operation) GetMergeSlashes

func (*PathTransformation_Operation) GetNormalizePathRfc_3986

func (*PathTransformation_Operation) GetOperationSpecifier

func (x *PathTransformation_Operation) GetOperationSpecifier() isPathTransformation_Operation_OperationSpecifier

func (*PathTransformation_Operation) ProtoMessage

func (*PathTransformation_Operation) ProtoMessage()

func (*PathTransformation_Operation) ProtoReflect

func (*PathTransformation_Operation) Reset

func (x *PathTransformation_Operation) Reset()

func (*PathTransformation_Operation) String

func (*PathTransformation_Operation) Validate

func (m *PathTransformation_Operation) Validate() error

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

func (m *PathTransformation_Operation) ValidateAll() error

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

type PathTransformation_OperationMultiError

type PathTransformation_OperationMultiError []error

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

func (PathTransformation_OperationMultiError) AllErrors

AllErrors returns a list of validation violation errors.

func (PathTransformation_OperationMultiError) Error

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

type PathTransformation_OperationValidationError

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

PathTransformation_OperationValidationError is the validation error returned by PathTransformation_Operation.Validate if the designated constraints aren't met.

func (PathTransformation_OperationValidationError) Cause

Cause function returns cause value.

func (PathTransformation_OperationValidationError) Error

Error satisfies the builtin error interface

func (PathTransformation_OperationValidationError) ErrorName

ErrorName returns error name.

func (PathTransformation_OperationValidationError) Field

Field function returns field value.

func (PathTransformation_OperationValidationError) Key

Key function returns key value.

func (PathTransformation_OperationValidationError) Reason

Reason function returns reason value.

type PathTransformation_Operation_MergeSlashes

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

Determines if adjacent slashes are merged into one. A common use case is for a request path header. Using this option in “:ref: PathNormalizationOptions <envoy_v3_api_msg_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.PathNormalizationOptions>“ will allow incoming requests with path “//dir///file“ to match against route with “prefix“ match set to “/dir“. When using for header transformations, note that slash merging is not part of `HTTP spec <https://tools.ietf.org/html/rfc3986>`_ and is provided for convenience.

func (*PathTransformation_Operation_MergeSlashes) Descriptor deprecated

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

Deprecated: Use PathTransformation_Operation_MergeSlashes.ProtoReflect.Descriptor instead.

func (*PathTransformation_Operation_MergeSlashes) ProtoMessage

func (*PathTransformation_Operation_MergeSlashes) ProtoReflect

func (*PathTransformation_Operation_MergeSlashes) Reset

func (*PathTransformation_Operation_MergeSlashes) String

func (*PathTransformation_Operation_MergeSlashes) Validate

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

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

type PathTransformation_Operation_MergeSlashesMultiError

type PathTransformation_Operation_MergeSlashesMultiError []error

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

func (PathTransformation_Operation_MergeSlashesMultiError) AllErrors

AllErrors returns a list of validation violation errors.

func (PathTransformation_Operation_MergeSlashesMultiError) Error

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

type PathTransformation_Operation_MergeSlashesValidationError

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

PathTransformation_Operation_MergeSlashesValidationError is the validation error returned by PathTransformation_Operation_MergeSlashes.Validate if the designated constraints aren't met.

func (PathTransformation_Operation_MergeSlashesValidationError) Cause

Cause function returns cause value.

func (PathTransformation_Operation_MergeSlashesValidationError) Error

Error satisfies the builtin error interface

func (PathTransformation_Operation_MergeSlashesValidationError) ErrorName

ErrorName returns error name.

func (PathTransformation_Operation_MergeSlashesValidationError) Field

Field function returns field value.

func (PathTransformation_Operation_MergeSlashesValidationError) Key

Key function returns key value.

func (PathTransformation_Operation_MergeSlashesValidationError) Reason

Reason function returns reason value.

type PathTransformation_Operation_MergeSlashes_

type PathTransformation_Operation_MergeSlashes_ struct {
	// Enable merging adjacent slashes.
	MergeSlashes *PathTransformation_Operation_MergeSlashes `protobuf:"bytes,3,opt,name=merge_slashes,json=mergeSlashes,proto3,oneof"`
}

type PathTransformation_Operation_NormalizePathRFC3986

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

Should text be normalized according to RFC 3986? This typically is used for path headers before any processing of requests by HTTP filters or routing. This applies percent-encoded normalization and path segment normalization. Fails on characters disallowed in URLs (e.g. NULLs). See `Normalization and Comparison <https://tools.ietf.org/html/rfc3986#section-6>`_ for details of normalization. Note that this options does not perform `case normalization <https://tools.ietf.org/html/rfc3986#section-6.2.2.1>`_

func (*PathTransformation_Operation_NormalizePathRFC3986) Descriptor deprecated

Deprecated: Use PathTransformation_Operation_NormalizePathRFC3986.ProtoReflect.Descriptor instead.

func (*PathTransformation_Operation_NormalizePathRFC3986) ProtoMessage

func (*PathTransformation_Operation_NormalizePathRFC3986) ProtoReflect

func (*PathTransformation_Operation_NormalizePathRFC3986) Reset

func (*PathTransformation_Operation_NormalizePathRFC3986) String

func (*PathTransformation_Operation_NormalizePathRFC3986) Validate

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

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

type PathTransformation_Operation_NormalizePathRFC3986MultiError

type PathTransformation_Operation_NormalizePathRFC3986MultiError []error

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

func (PathTransformation_Operation_NormalizePathRFC3986MultiError) AllErrors

AllErrors returns a list of validation violation errors.

func (PathTransformation_Operation_NormalizePathRFC3986MultiError) Error

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

type PathTransformation_Operation_NormalizePathRFC3986ValidationError

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

PathTransformation_Operation_NormalizePathRFC3986ValidationError is the validation error returned by PathTransformation_Operation_NormalizePathRFC3986.Validate if the designated constraints aren't met.

func (PathTransformation_Operation_NormalizePathRFC3986ValidationError) Cause

Cause function returns cause value.

func (PathTransformation_Operation_NormalizePathRFC3986ValidationError) Error

Error satisfies the builtin error interface

func (PathTransformation_Operation_NormalizePathRFC3986ValidationError) ErrorName

ErrorName returns error name.

func (PathTransformation_Operation_NormalizePathRFC3986ValidationError) Field

Field function returns field value.

func (PathTransformation_Operation_NormalizePathRFC3986ValidationError) Key

Key function returns key value.

func (PathTransformation_Operation_NormalizePathRFC3986ValidationError) Reason

Reason function returns reason value.

type PathTransformation_Operation_NormalizePathRfc_3986

type PathTransformation_Operation_NormalizePathRfc_3986 struct {
	// Enable path normalization per RFC 3986.
	NormalizePathRfc_3986 *PathTransformation_Operation_NormalizePathRFC3986 `protobuf:"bytes,2,opt,name=normalize_path_rfc_3986,json=normalizePathRfc3986,proto3,oneof"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL