v3

package
v1.5.2 Latest Latest
Warning

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

Go to latest
Published: Oct 16, 2020 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

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"`
	XXX_NoUnkeyedLiteral struct{}                   `json:"-"`
	XXX_unrecognized     []byte                     `json:"-"`
	XXX_sizecache        int32                      `json:"-"`
}

MetadataKey provides a general interface using `key` and `path` to retrieve value from :ref:`Metadata <envoy_api_msg_config.core.v3.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

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

func (*MetadataKey) Equal

func (this *MetadataKey) Equal(that interface{}) bool

func (*MetadataKey) GetKey

func (m *MetadataKey) GetKey() string

func (*MetadataKey) GetPath

func (m *MetadataKey) GetPath() []*MetadataKey_PathSegment

func (*MetadataKey) ProtoMessage

func (*MetadataKey) ProtoMessage()

func (*MetadataKey) Reset

func (m *MetadataKey) Reset()

func (*MetadataKey) String

func (m *MetadataKey) String() string

func (*MetadataKey) XXX_DiscardUnknown

func (m *MetadataKey) XXX_DiscardUnknown()

func (*MetadataKey) XXX_Marshal

func (m *MetadataKey) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*MetadataKey) XXX_Merge

func (m *MetadataKey) XXX_Merge(src proto.Message)

func (*MetadataKey) XXX_Size

func (m *MetadataKey) XXX_Size() int

func (*MetadataKey) XXX_Unmarshal

func (m *MetadataKey) XXX_Unmarshal(b []byte) error

type MetadataKey_PathSegment

type MetadataKey_PathSegment struct {
	// Types that are valid to be assigned to Segment:
	//	*MetadataKey_PathSegment_Key
	Segment              isMetadataKey_PathSegment_Segment `protobuf_oneof:"segment"`
	XXX_NoUnkeyedLiteral struct{}                          `json:"-"`
	XXX_unrecognized     []byte                            `json:"-"`
	XXX_sizecache        int32                             `json:"-"`
}

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

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

func (*MetadataKey_PathSegment) Equal

func (this *MetadataKey_PathSegment) Equal(that interface{}) bool

func (*MetadataKey_PathSegment) GetKey

func (m *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) Reset

func (m *MetadataKey_PathSegment) Reset()

func (*MetadataKey_PathSegment) String

func (m *MetadataKey_PathSegment) String() string

func (*MetadataKey_PathSegment) XXX_DiscardUnknown

func (m *MetadataKey_PathSegment) XXX_DiscardUnknown()

func (*MetadataKey_PathSegment) XXX_Marshal

func (m *MetadataKey_PathSegment) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*MetadataKey_PathSegment) XXX_Merge

func (m *MetadataKey_PathSegment) XXX_Merge(src proto.Message)

func (*MetadataKey_PathSegment) XXX_OneofWrappers

func (*MetadataKey_PathSegment) XXX_OneofWrappers() []interface{}

XXX_OneofWrappers is for the internal use of the proto package.

func (*MetadataKey_PathSegment) XXX_Size

func (m *MetadataKey_PathSegment) XXX_Size() int

func (*MetadataKey_PathSegment) XXX_Unmarshal

func (m *MetadataKey_PathSegment) XXX_Unmarshal(b []byte) error

type MetadataKey_PathSegment_Key

type MetadataKey_PathSegment_Key struct {
	Key string `protobuf:"bytes,1,opt,name=key,proto3,oneof" json:"key,omitempty"`
}

func (*MetadataKey_PathSegment_Key) Equal

func (this *MetadataKey_PathSegment_Key) Equal(that interface{}) bool

type MetadataKind

type MetadataKind struct {
	// Types that are valid to be assigned to Kind:
	//	*MetadataKind_Request_
	//	*MetadataKind_Route_
	//	*MetadataKind_Cluster_
	//	*MetadataKind_Host_
	Kind                 isMetadataKind_Kind `protobuf_oneof:"kind"`
	XXX_NoUnkeyedLiteral struct{}            `json:"-"`
	XXX_unrecognized     []byte              `json:"-"`
	XXX_sizecache        int32               `json:"-"`
}

Describes what kind of metadata.

func (*MetadataKind) Descriptor

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

func (*MetadataKind) Equal

func (this *MetadataKind) Equal(that interface{}) bool

func (*MetadataKind) GetCluster

func (m *MetadataKind) GetCluster() *MetadataKind_Cluster

func (*MetadataKind) GetHost

func (m *MetadataKind) GetHost() *MetadataKind_Host

func (*MetadataKind) GetKind

func (m *MetadataKind) GetKind() isMetadataKind_Kind

func (*MetadataKind) GetRequest

func (m *MetadataKind) GetRequest() *MetadataKind_Request

func (*MetadataKind) GetRoute

func (m *MetadataKind) GetRoute() *MetadataKind_Route

func (*MetadataKind) ProtoMessage

func (*MetadataKind) ProtoMessage()

func (*MetadataKind) Reset

func (m *MetadataKind) Reset()

func (*MetadataKind) String

func (m *MetadataKind) String() string

func (*MetadataKind) XXX_DiscardUnknown

func (m *MetadataKind) XXX_DiscardUnknown()

func (*MetadataKind) XXX_Marshal

func (m *MetadataKind) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*MetadataKind) XXX_Merge

func (m *MetadataKind) XXX_Merge(src proto.Message)

func (*MetadataKind) XXX_OneofWrappers

func (*MetadataKind) XXX_OneofWrappers() []interface{}

XXX_OneofWrappers is for the internal use of the proto package.

func (*MetadataKind) XXX_Size

func (m *MetadataKind) XXX_Size() int

func (*MetadataKind) XXX_Unmarshal

func (m *MetadataKind) XXX_Unmarshal(b []byte) error

type MetadataKind_Cluster

type MetadataKind_Cluster struct {
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Represents metadata from :ref:`the upstream cluster<envoy_api_field_config.cluster.v3.Cluster.metadata>`.

func (*MetadataKind_Cluster) Descriptor

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

func (*MetadataKind_Cluster) Equal

func (this *MetadataKind_Cluster) Equal(that interface{}) bool

func (*MetadataKind_Cluster) ProtoMessage

func (*MetadataKind_Cluster) ProtoMessage()

func (*MetadataKind_Cluster) Reset

func (m *MetadataKind_Cluster) Reset()

func (*MetadataKind_Cluster) String

func (m *MetadataKind_Cluster) String() string

func (*MetadataKind_Cluster) XXX_DiscardUnknown

func (m *MetadataKind_Cluster) XXX_DiscardUnknown()

func (*MetadataKind_Cluster) XXX_Marshal

func (m *MetadataKind_Cluster) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*MetadataKind_Cluster) XXX_Merge

func (m *MetadataKind_Cluster) XXX_Merge(src proto.Message)

func (*MetadataKind_Cluster) XXX_Size

func (m *MetadataKind_Cluster) XXX_Size() int

func (*MetadataKind_Cluster) XXX_Unmarshal

func (m *MetadataKind_Cluster) XXX_Unmarshal(b []byte) error

type MetadataKind_Cluster_

type MetadataKind_Cluster_ struct {
	Cluster *MetadataKind_Cluster `protobuf:"bytes,3,opt,name=cluster,proto3,oneof" json:"cluster,omitempty"`
}

func (*MetadataKind_Cluster_) Equal

func (this *MetadataKind_Cluster_) Equal(that interface{}) bool

type MetadataKind_Host

type MetadataKind_Host struct {
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Represents metadata from :ref:`the upstream host<envoy_api_field_config.endpoint.v3.LbEndpoint.metadata>`.

func (*MetadataKind_Host) Descriptor

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

func (*MetadataKind_Host) Equal

func (this *MetadataKind_Host) Equal(that interface{}) bool

func (*MetadataKind_Host) ProtoMessage

func (*MetadataKind_Host) ProtoMessage()

func (*MetadataKind_Host) Reset

func (m *MetadataKind_Host) Reset()

func (*MetadataKind_Host) String

func (m *MetadataKind_Host) String() string

func (*MetadataKind_Host) XXX_DiscardUnknown

func (m *MetadataKind_Host) XXX_DiscardUnknown()

func (*MetadataKind_Host) XXX_Marshal

func (m *MetadataKind_Host) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*MetadataKind_Host) XXX_Merge

func (m *MetadataKind_Host) XXX_Merge(src proto.Message)

func (*MetadataKind_Host) XXX_Size

func (m *MetadataKind_Host) XXX_Size() int

func (*MetadataKind_Host) XXX_Unmarshal

func (m *MetadataKind_Host) XXX_Unmarshal(b []byte) error

type MetadataKind_Host_

type MetadataKind_Host_ struct {
	Host *MetadataKind_Host `protobuf:"bytes,4,opt,name=host,proto3,oneof" json:"host,omitempty"`
}

func (*MetadataKind_Host_) Equal

func (this *MetadataKind_Host_) Equal(that interface{}) bool

type MetadataKind_Request

type MetadataKind_Request struct {
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Represents dynamic metadata associated with the request.

func (*MetadataKind_Request) Descriptor

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

func (*MetadataKind_Request) Equal

func (this *MetadataKind_Request) Equal(that interface{}) bool

func (*MetadataKind_Request) ProtoMessage

func (*MetadataKind_Request) ProtoMessage()

func (*MetadataKind_Request) Reset

func (m *MetadataKind_Request) Reset()

func (*MetadataKind_Request) String

func (m *MetadataKind_Request) String() string

func (*MetadataKind_Request) XXX_DiscardUnknown

func (m *MetadataKind_Request) XXX_DiscardUnknown()

func (*MetadataKind_Request) XXX_Marshal

func (m *MetadataKind_Request) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*MetadataKind_Request) XXX_Merge

func (m *MetadataKind_Request) XXX_Merge(src proto.Message)

func (*MetadataKind_Request) XXX_Size

func (m *MetadataKind_Request) XXX_Size() int

func (*MetadataKind_Request) XXX_Unmarshal

func (m *MetadataKind_Request) XXX_Unmarshal(b []byte) error

type MetadataKind_Request_

type MetadataKind_Request_ struct {
	Request *MetadataKind_Request `protobuf:"bytes,1,opt,name=request,proto3,oneof" json:"request,omitempty"`
}

func (*MetadataKind_Request_) Equal

func (this *MetadataKind_Request_) Equal(that interface{}) bool

type MetadataKind_Route

type MetadataKind_Route struct {
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Represents metadata from :ref:`the route<envoy_api_field_config.route.v3.Route.metadata>`.

func (*MetadataKind_Route) Descriptor

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

func (*MetadataKind_Route) Equal

func (this *MetadataKind_Route) Equal(that interface{}) bool

func (*MetadataKind_Route) ProtoMessage

func (*MetadataKind_Route) ProtoMessage()

func (*MetadataKind_Route) Reset

func (m *MetadataKind_Route) Reset()

func (*MetadataKind_Route) String

func (m *MetadataKind_Route) String() string

func (*MetadataKind_Route) XXX_DiscardUnknown

func (m *MetadataKind_Route) XXX_DiscardUnknown()

func (*MetadataKind_Route) XXX_Marshal

func (m *MetadataKind_Route) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*MetadataKind_Route) XXX_Merge

func (m *MetadataKind_Route) XXX_Merge(src proto.Message)

func (*MetadataKind_Route) XXX_Size

func (m *MetadataKind_Route) XXX_Size() int

func (*MetadataKind_Route) XXX_Unmarshal

func (m *MetadataKind_Route) XXX_Unmarshal(b []byte) error

type MetadataKind_Route_

type MetadataKind_Route_ struct {
	Route *MetadataKind_Route `protobuf:"bytes,2,opt,name=route,proto3,oneof" json:"route,omitempty"`
}

func (*MetadataKind_Route_) Equal

func (this *MetadataKind_Route_) Equal(that interface{}) bool

Jump to

Keyboard shortcuts

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