Documentation ¶
Index ¶
- Variables
- type MetadataKey
- func (*MetadataKey) Descriptor() ([]byte, []int)deprecated
- func (x *MetadataKey) GetKey() string
- func (x *MetadataKey) GetPath() []*MetadataKey_PathSegment
- func (*MetadataKey) ProtoMessage()
- func (x *MetadataKey) ProtoReflect() protoreflect.Message
- func (x *MetadataKey) Reset()
- func (x *MetadataKey) String() string
- func (m *MetadataKey) Validate() error
- type MetadataKeyValidationError
- func (e MetadataKeyValidationError) Cause() error
- func (e MetadataKeyValidationError) Error() string
- func (e MetadataKeyValidationError) ErrorName() string
- func (e MetadataKeyValidationError) Field() string
- func (e MetadataKeyValidationError) Key() bool
- func (e MetadataKeyValidationError) Reason() string
- type MetadataKey_PathSegment
- func (*MetadataKey_PathSegment) Descriptor() ([]byte, []int)deprecated
- func (x *MetadataKey_PathSegment) GetKey() string
- func (m *MetadataKey_PathSegment) GetSegment() isMetadataKey_PathSegment_Segment
- func (*MetadataKey_PathSegment) ProtoMessage()
- func (x *MetadataKey_PathSegment) ProtoReflect() protoreflect.Message
- func (x *MetadataKey_PathSegment) Reset()
- func (x *MetadataKey_PathSegment) String() string
- func (m *MetadataKey_PathSegment) Validate() error
- type MetadataKey_PathSegmentValidationError
- func (e MetadataKey_PathSegmentValidationError) Cause() error
- func (e MetadataKey_PathSegmentValidationError) Error() string
- func (e MetadataKey_PathSegmentValidationError) ErrorName() string
- func (e MetadataKey_PathSegmentValidationError) Field() string
- func (e MetadataKey_PathSegmentValidationError) Key() bool
- func (e MetadataKey_PathSegmentValidationError) Reason() string
- type MetadataKey_PathSegment_Key
- type MetadataKind
- func (*MetadataKind) Descriptor() ([]byte, []int)deprecated
- func (x *MetadataKind) GetCluster() *MetadataKind_Cluster
- func (x *MetadataKind) GetHost() *MetadataKind_Host
- func (m *MetadataKind) GetKind() isMetadataKind_Kind
- func (x *MetadataKind) GetRequest() *MetadataKind_Request
- func (x *MetadataKind) GetRoute() *MetadataKind_Route
- func (*MetadataKind) ProtoMessage()
- func (x *MetadataKind) ProtoReflect() protoreflect.Message
- func (x *MetadataKind) Reset()
- func (x *MetadataKind) String() string
- func (m *MetadataKind) Validate() error
- type MetadataKindValidationError
- func (e MetadataKindValidationError) Cause() error
- func (e MetadataKindValidationError) Error() string
- func (e MetadataKindValidationError) ErrorName() string
- func (e MetadataKindValidationError) Field() string
- func (e MetadataKindValidationError) Key() bool
- func (e MetadataKindValidationError) Reason() string
- type MetadataKind_Cluster
- func (*MetadataKind_Cluster) Descriptor() ([]byte, []int)deprecated
- func (*MetadataKind_Cluster) ProtoMessage()
- func (x *MetadataKind_Cluster) ProtoReflect() protoreflect.Message
- func (x *MetadataKind_Cluster) Reset()
- func (x *MetadataKind_Cluster) String() string
- func (m *MetadataKind_Cluster) Validate() error
- type MetadataKind_ClusterValidationError
- func (e MetadataKind_ClusterValidationError) Cause() error
- func (e MetadataKind_ClusterValidationError) Error() string
- func (e MetadataKind_ClusterValidationError) ErrorName() string
- func (e MetadataKind_ClusterValidationError) Field() string
- func (e MetadataKind_ClusterValidationError) Key() bool
- func (e MetadataKind_ClusterValidationError) Reason() string
- type MetadataKind_Cluster_
- type MetadataKind_Host
- type MetadataKind_HostValidationError
- func (e MetadataKind_HostValidationError) Cause() error
- func (e MetadataKind_HostValidationError) Error() string
- func (e MetadataKind_HostValidationError) ErrorName() string
- func (e MetadataKind_HostValidationError) Field() string
- func (e MetadataKind_HostValidationError) Key() bool
- func (e MetadataKind_HostValidationError) Reason() string
- type MetadataKind_Host_
- type MetadataKind_Request
- func (*MetadataKind_Request) Descriptor() ([]byte, []int)deprecated
- func (*MetadataKind_Request) ProtoMessage()
- func (x *MetadataKind_Request) ProtoReflect() protoreflect.Message
- func (x *MetadataKind_Request) Reset()
- func (x *MetadataKind_Request) String() string
- func (m *MetadataKind_Request) Validate() error
- type MetadataKind_RequestValidationError
- func (e MetadataKind_RequestValidationError) Cause() error
- func (e MetadataKind_RequestValidationError) Error() string
- func (e MetadataKind_RequestValidationError) ErrorName() string
- func (e MetadataKind_RequestValidationError) Field() string
- func (e MetadataKind_RequestValidationError) Key() bool
- func (e MetadataKind_RequestValidationError) Reason() string
- type MetadataKind_Request_
- type MetadataKind_Route
- func (*MetadataKind_Route) Descriptor() ([]byte, []int)deprecated
- func (*MetadataKind_Route) ProtoMessage()
- func (x *MetadataKind_Route) ProtoReflect() protoreflect.Message
- func (x *MetadataKind_Route) Reset()
- func (x *MetadataKind_Route) String() string
- func (m *MetadataKind_Route) Validate() error
- type MetadataKind_RouteValidationError
- func (e MetadataKind_RouteValidationError) Cause() error
- func (e MetadataKind_RouteValidationError) Error() string
- func (e MetadataKind_RouteValidationError) ErrorName() string
- func (e MetadataKind_RouteValidationError) Field() string
- func (e MetadataKind_RouteValidationError) Key() bool
- func (e MetadataKind_RouteValidationError) Reason() string
- type MetadataKind_Route_
Constants ¶
This section is empty.
Variables ¶
var File_envoy_type_metadata_v2_metadata_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type MetadataKey ¶
type MetadataKey struct { // The key name of Metadata to retrieve the Struct from the metadata. // Typically, it represents a builtin subsystem or custom extension. Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"` // The path to retrieve the Value from the Struct. It can be a prefix or a full path, // e.g. “[prop, xyz]“ for a struct or “[prop, foo]“ for a string in the example, // which depends on the particular scenario. // // Note: Due to that only the key type segment is supported, the path can not specify a list // unless the list is the last segment. Path []*MetadataKey_PathSegment `protobuf:"bytes,2,rep,name=path,proto3" json:"path,omitempty"` // contains filtered or unexported fields }
MetadataKey provides a general interface using `key` and `path` to retrieve value from :ref:`Metadata <envoy_api_msg_core.Metadata>`.
For example, for the following Metadata:
.. code-block:: yaml
filter_metadata: envoy.xxx: prop: foo: bar xyz: hello: envoy
The following MetadataKey will retrieve a string value "bar" from the Metadata.
.. code-block:: yaml
key: envoy.xxx path: - key: prop - key: foo
func (*MetadataKey) Descriptor
deprecated
func (*MetadataKey) Descriptor() ([]byte, []int)
Deprecated: Use MetadataKey.ProtoReflect.Descriptor instead.
func (*MetadataKey) GetKey ¶
func (x *MetadataKey) GetKey() string
func (*MetadataKey) GetPath ¶
func (x *MetadataKey) GetPath() []*MetadataKey_PathSegment
func (*MetadataKey) ProtoMessage ¶
func (*MetadataKey) ProtoMessage()
func (*MetadataKey) ProtoReflect ¶
func (x *MetadataKey) ProtoReflect() protoreflect.Message
func (*MetadataKey) Reset ¶
func (x *MetadataKey) Reset()
func (*MetadataKey) String ¶
func (x *MetadataKey) String() string
func (*MetadataKey) Validate ¶
func (m *MetadataKey) Validate() error
Validate checks the field values on MetadataKey with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type MetadataKeyValidationError ¶
type MetadataKeyValidationError struct {
// contains filtered or unexported fields
}
MetadataKeyValidationError is the validation error returned by MetadataKey.Validate if the designated constraints aren't met.
func (MetadataKeyValidationError) Cause ¶
func (e MetadataKeyValidationError) Cause() error
Cause function returns cause value.
func (MetadataKeyValidationError) Error ¶
func (e MetadataKeyValidationError) Error() string
Error satisfies the builtin error interface
func (MetadataKeyValidationError) ErrorName ¶
func (e MetadataKeyValidationError) ErrorName() string
ErrorName returns error name.
func (MetadataKeyValidationError) Field ¶
func (e MetadataKeyValidationError) Field() string
Field function returns field value.
func (MetadataKeyValidationError) Key ¶
func (e MetadataKeyValidationError) Key() bool
Key function returns key value.
func (MetadataKeyValidationError) Reason ¶
func (e MetadataKeyValidationError) Reason() string
Reason function returns reason value.
type MetadataKey_PathSegment ¶
type MetadataKey_PathSegment struct { // Types that are assignable to Segment: // *MetadataKey_PathSegment_Key Segment isMetadataKey_PathSegment_Segment `protobuf_oneof:"segment"` // contains filtered or unexported fields }
Specifies the segment in a path to retrieve value from Metadata. Currently it is only supported to specify the key, i.e. field name, as one segment of a path.
func (*MetadataKey_PathSegment) Descriptor
deprecated
func (*MetadataKey_PathSegment) Descriptor() ([]byte, []int)
Deprecated: Use MetadataKey_PathSegment.ProtoReflect.Descriptor instead.
func (*MetadataKey_PathSegment) GetKey ¶
func (x *MetadataKey_PathSegment) GetKey() string
func (*MetadataKey_PathSegment) GetSegment ¶
func (m *MetadataKey_PathSegment) GetSegment() isMetadataKey_PathSegment_Segment
func (*MetadataKey_PathSegment) ProtoMessage ¶
func (*MetadataKey_PathSegment) ProtoMessage()
func (*MetadataKey_PathSegment) ProtoReflect ¶
func (x *MetadataKey_PathSegment) ProtoReflect() protoreflect.Message
func (*MetadataKey_PathSegment) Reset ¶
func (x *MetadataKey_PathSegment) Reset()
func (*MetadataKey_PathSegment) String ¶
func (x *MetadataKey_PathSegment) String() string
func (*MetadataKey_PathSegment) Validate ¶
func (m *MetadataKey_PathSegment) Validate() error
Validate checks the field values on MetadataKey_PathSegment with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type MetadataKey_PathSegmentValidationError ¶
type MetadataKey_PathSegmentValidationError struct {
// contains filtered or unexported fields
}
MetadataKey_PathSegmentValidationError is the validation error returned by MetadataKey_PathSegment.Validate if the designated constraints aren't met.
func (MetadataKey_PathSegmentValidationError) Cause ¶
func (e MetadataKey_PathSegmentValidationError) Cause() error
Cause function returns cause value.
func (MetadataKey_PathSegmentValidationError) Error ¶
func (e MetadataKey_PathSegmentValidationError) Error() string
Error satisfies the builtin error interface
func (MetadataKey_PathSegmentValidationError) ErrorName ¶
func (e MetadataKey_PathSegmentValidationError) ErrorName() string
ErrorName returns error name.
func (MetadataKey_PathSegmentValidationError) Field ¶
func (e MetadataKey_PathSegmentValidationError) Field() string
Field function returns field value.
func (MetadataKey_PathSegmentValidationError) Key ¶
func (e MetadataKey_PathSegmentValidationError) Key() bool
Key function returns key value.
func (MetadataKey_PathSegmentValidationError) Reason ¶
func (e MetadataKey_PathSegmentValidationError) Reason() string
Reason function returns reason value.
type MetadataKey_PathSegment_Key ¶
type MetadataKey_PathSegment_Key struct { // If specified, use the key to retrieve the value in a Struct. Key string `protobuf:"bytes,1,opt,name=key,proto3,oneof"` }
type MetadataKind ¶
type MetadataKind struct { // Types that are assignable to Kind: // *MetadataKind_Request_ // *MetadataKind_Route_ // *MetadataKind_Cluster_ // *MetadataKind_Host_ Kind isMetadataKind_Kind `protobuf_oneof:"kind"` // contains filtered or unexported fields }
Describes what kind of metadata.
func (*MetadataKind) Descriptor
deprecated
func (*MetadataKind) Descriptor() ([]byte, []int)
Deprecated: Use MetadataKind.ProtoReflect.Descriptor instead.
func (*MetadataKind) GetCluster ¶
func (x *MetadataKind) GetCluster() *MetadataKind_Cluster
func (*MetadataKind) GetHost ¶
func (x *MetadataKind) GetHost() *MetadataKind_Host
func (*MetadataKind) GetKind ¶
func (m *MetadataKind) GetKind() isMetadataKind_Kind
func (*MetadataKind) GetRequest ¶
func (x *MetadataKind) GetRequest() *MetadataKind_Request
func (*MetadataKind) GetRoute ¶
func (x *MetadataKind) GetRoute() *MetadataKind_Route
func (*MetadataKind) ProtoMessage ¶
func (*MetadataKind) ProtoMessage()
func (*MetadataKind) ProtoReflect ¶
func (x *MetadataKind) ProtoReflect() protoreflect.Message
func (*MetadataKind) Reset ¶
func (x *MetadataKind) Reset()
func (*MetadataKind) String ¶
func (x *MetadataKind) String() string
func (*MetadataKind) Validate ¶
func (m *MetadataKind) Validate() error
Validate checks the field values on MetadataKind with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type MetadataKindValidationError ¶
type MetadataKindValidationError struct {
// contains filtered or unexported fields
}
MetadataKindValidationError is the validation error returned by MetadataKind.Validate if the designated constraints aren't met.
func (MetadataKindValidationError) Cause ¶
func (e MetadataKindValidationError) Cause() error
Cause function returns cause value.
func (MetadataKindValidationError) Error ¶
func (e MetadataKindValidationError) Error() string
Error satisfies the builtin error interface
func (MetadataKindValidationError) ErrorName ¶
func (e MetadataKindValidationError) ErrorName() string
ErrorName returns error name.
func (MetadataKindValidationError) Field ¶
func (e MetadataKindValidationError) Field() string
Field function returns field value.
func (MetadataKindValidationError) Key ¶
func (e MetadataKindValidationError) Key() bool
Key function returns key value.
func (MetadataKindValidationError) Reason ¶
func (e MetadataKindValidationError) Reason() string
Reason function returns reason value.
type MetadataKind_Cluster ¶
type MetadataKind_Cluster struct {
// contains filtered or unexported fields
}
Represents metadata from :ref:`the upstream cluster<envoy_api_field_Cluster.metadata>`.
func (*MetadataKind_Cluster) Descriptor
deprecated
func (*MetadataKind_Cluster) Descriptor() ([]byte, []int)
Deprecated: Use MetadataKind_Cluster.ProtoReflect.Descriptor instead.
func (*MetadataKind_Cluster) ProtoMessage ¶
func (*MetadataKind_Cluster) ProtoMessage()
func (*MetadataKind_Cluster) ProtoReflect ¶
func (x *MetadataKind_Cluster) ProtoReflect() protoreflect.Message
func (*MetadataKind_Cluster) Reset ¶
func (x *MetadataKind_Cluster) Reset()
func (*MetadataKind_Cluster) String ¶
func (x *MetadataKind_Cluster) String() string
func (*MetadataKind_Cluster) Validate ¶
func (m *MetadataKind_Cluster) Validate() error
Validate checks the field values on MetadataKind_Cluster with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type MetadataKind_ClusterValidationError ¶
type MetadataKind_ClusterValidationError struct {
// contains filtered or unexported fields
}
MetadataKind_ClusterValidationError is the validation error returned by MetadataKind_Cluster.Validate if the designated constraints aren't met.
func (MetadataKind_ClusterValidationError) Cause ¶
func (e MetadataKind_ClusterValidationError) Cause() error
Cause function returns cause value.
func (MetadataKind_ClusterValidationError) Error ¶
func (e MetadataKind_ClusterValidationError) Error() string
Error satisfies the builtin error interface
func (MetadataKind_ClusterValidationError) ErrorName ¶
func (e MetadataKind_ClusterValidationError) ErrorName() string
ErrorName returns error name.
func (MetadataKind_ClusterValidationError) Field ¶
func (e MetadataKind_ClusterValidationError) Field() string
Field function returns field value.
func (MetadataKind_ClusterValidationError) Key ¶
func (e MetadataKind_ClusterValidationError) Key() bool
Key function returns key value.
func (MetadataKind_ClusterValidationError) Reason ¶
func (e MetadataKind_ClusterValidationError) Reason() string
Reason function returns reason value.
type MetadataKind_Cluster_ ¶
type MetadataKind_Cluster_ struct { // Cluster kind of metadata. Cluster *MetadataKind_Cluster `protobuf:"bytes,3,opt,name=cluster,proto3,oneof"` }
type MetadataKind_Host ¶
type MetadataKind_Host struct {
// contains filtered or unexported fields
}
Represents metadata from :ref:`the upstream host<envoy_api_field_endpoint.LbEndpoint.metadata>`.
func (*MetadataKind_Host) Descriptor
deprecated
func (*MetadataKind_Host) Descriptor() ([]byte, []int)
Deprecated: Use MetadataKind_Host.ProtoReflect.Descriptor instead.
func (*MetadataKind_Host) ProtoMessage ¶
func (*MetadataKind_Host) ProtoMessage()
func (*MetadataKind_Host) ProtoReflect ¶
func (x *MetadataKind_Host) ProtoReflect() protoreflect.Message
func (*MetadataKind_Host) Reset ¶
func (x *MetadataKind_Host) Reset()
func (*MetadataKind_Host) String ¶
func (x *MetadataKind_Host) String() string
func (*MetadataKind_Host) Validate ¶
func (m *MetadataKind_Host) Validate() error
Validate checks the field values on MetadataKind_Host with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type MetadataKind_HostValidationError ¶
type MetadataKind_HostValidationError struct {
// contains filtered or unexported fields
}
MetadataKind_HostValidationError is the validation error returned by MetadataKind_Host.Validate if the designated constraints aren't met.
func (MetadataKind_HostValidationError) Cause ¶
func (e MetadataKind_HostValidationError) Cause() error
Cause function returns cause value.
func (MetadataKind_HostValidationError) Error ¶
func (e MetadataKind_HostValidationError) Error() string
Error satisfies the builtin error interface
func (MetadataKind_HostValidationError) ErrorName ¶
func (e MetadataKind_HostValidationError) ErrorName() string
ErrorName returns error name.
func (MetadataKind_HostValidationError) Field ¶
func (e MetadataKind_HostValidationError) Field() string
Field function returns field value.
func (MetadataKind_HostValidationError) Key ¶
func (e MetadataKind_HostValidationError) Key() bool
Key function returns key value.
func (MetadataKind_HostValidationError) Reason ¶
func (e MetadataKind_HostValidationError) Reason() string
Reason function returns reason value.
type MetadataKind_Host_ ¶
type MetadataKind_Host_ struct { // Host kind of metadata. Host *MetadataKind_Host `protobuf:"bytes,4,opt,name=host,proto3,oneof"` }
type MetadataKind_Request ¶
type MetadataKind_Request struct {
// contains filtered or unexported fields
}
Represents dynamic metadata associated with the request.
func (*MetadataKind_Request) Descriptor
deprecated
func (*MetadataKind_Request) Descriptor() ([]byte, []int)
Deprecated: Use MetadataKind_Request.ProtoReflect.Descriptor instead.
func (*MetadataKind_Request) ProtoMessage ¶
func (*MetadataKind_Request) ProtoMessage()
func (*MetadataKind_Request) ProtoReflect ¶
func (x *MetadataKind_Request) ProtoReflect() protoreflect.Message
func (*MetadataKind_Request) Reset ¶
func (x *MetadataKind_Request) Reset()
func (*MetadataKind_Request) String ¶
func (x *MetadataKind_Request) String() string
func (*MetadataKind_Request) Validate ¶
func (m *MetadataKind_Request) Validate() error
Validate checks the field values on MetadataKind_Request with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type MetadataKind_RequestValidationError ¶
type MetadataKind_RequestValidationError struct {
// contains filtered or unexported fields
}
MetadataKind_RequestValidationError is the validation error returned by MetadataKind_Request.Validate if the designated constraints aren't met.
func (MetadataKind_RequestValidationError) Cause ¶
func (e MetadataKind_RequestValidationError) Cause() error
Cause function returns cause value.
func (MetadataKind_RequestValidationError) Error ¶
func (e MetadataKind_RequestValidationError) Error() string
Error satisfies the builtin error interface
func (MetadataKind_RequestValidationError) ErrorName ¶
func (e MetadataKind_RequestValidationError) ErrorName() string
ErrorName returns error name.
func (MetadataKind_RequestValidationError) Field ¶
func (e MetadataKind_RequestValidationError) Field() string
Field function returns field value.
func (MetadataKind_RequestValidationError) Key ¶
func (e MetadataKind_RequestValidationError) Key() bool
Key function returns key value.
func (MetadataKind_RequestValidationError) Reason ¶
func (e MetadataKind_RequestValidationError) Reason() string
Reason function returns reason value.
type MetadataKind_Request_ ¶
type MetadataKind_Request_ struct { // Request kind of metadata. Request *MetadataKind_Request `protobuf:"bytes,1,opt,name=request,proto3,oneof"` }
type MetadataKind_Route ¶
type MetadataKind_Route struct {
// contains filtered or unexported fields
}
Represents metadata from :ref:`the route<envoy_api_field_route.Route.metadata>`.
func (*MetadataKind_Route) Descriptor
deprecated
func (*MetadataKind_Route) Descriptor() ([]byte, []int)
Deprecated: Use MetadataKind_Route.ProtoReflect.Descriptor instead.
func (*MetadataKind_Route) ProtoMessage ¶
func (*MetadataKind_Route) ProtoMessage()
func (*MetadataKind_Route) ProtoReflect ¶
func (x *MetadataKind_Route) ProtoReflect() protoreflect.Message
func (*MetadataKind_Route) Reset ¶
func (x *MetadataKind_Route) Reset()
func (*MetadataKind_Route) String ¶
func (x *MetadataKind_Route) String() string
func (*MetadataKind_Route) Validate ¶
func (m *MetadataKind_Route) Validate() error
Validate checks the field values on MetadataKind_Route with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type MetadataKind_RouteValidationError ¶
type MetadataKind_RouteValidationError struct {
// contains filtered or unexported fields
}
MetadataKind_RouteValidationError is the validation error returned by MetadataKind_Route.Validate if the designated constraints aren't met.
func (MetadataKind_RouteValidationError) Cause ¶
func (e MetadataKind_RouteValidationError) Cause() error
Cause function returns cause value.
func (MetadataKind_RouteValidationError) Error ¶
func (e MetadataKind_RouteValidationError) Error() string
Error satisfies the builtin error interface
func (MetadataKind_RouteValidationError) ErrorName ¶
func (e MetadataKind_RouteValidationError) ErrorName() string
ErrorName returns error name.
func (MetadataKind_RouteValidationError) Field ¶
func (e MetadataKind_RouteValidationError) Field() string
Field function returns field value.
func (MetadataKind_RouteValidationError) Key ¶
func (e MetadataKind_RouteValidationError) Key() bool
Key function returns key value.
func (MetadataKind_RouteValidationError) Reason ¶
func (e MetadataKind_RouteValidationError) Reason() string
Reason function returns reason value.
type MetadataKind_Route_ ¶
type MetadataKind_Route_ struct { // Route kind of metadata. Route *MetadataKind_Route `protobuf:"bytes,2,opt,name=route,proto3,oneof"` }