headers

Documentation

Index

• Variables
• type HeaderManipulation
  • func (*HeaderManipulation) Descriptor() ([]byte, []int)
  • func (m *HeaderManipulation) Equal(that interface{}) bool
  • func (x *HeaderManipulation) GetRequestHeadersToAdd() []*core.HeaderValueOption
  • func (x *HeaderManipulation) GetRequestHeadersToRemove() []string
  • func (x *HeaderManipulation) GetResponseHeadersToAdd() []*HeaderValueOption
  • func (x *HeaderManipulation) GetResponseHeadersToRemove() []string
  • func (m *HeaderManipulation) Hash(hasher hash.Hash64) (uint64, error)
  • func (*HeaderManipulation) ProtoMessage()
  • func (x *HeaderManipulation) ProtoReflect() protoreflect.Message
  • func (x *HeaderManipulation) Reset()
  • func (x *HeaderManipulation) String() string
• type HeaderValue
  • func (*HeaderValue) Descriptor() ([]byte, []int)
  • func (m *HeaderValue) Equal(that interface{}) bool
  • func (x *HeaderValue) GetKey() string
  • func (x *HeaderValue) GetValue() string
  • func (m *HeaderValue) Hash(hasher hash.Hash64) (uint64, error)
  • func (*HeaderValue) ProtoMessage()
  • func (x *HeaderValue) ProtoReflect() protoreflect.Message
  • func (x *HeaderValue) Reset()
  • func (x *HeaderValue) String() string
• type HeaderValueOption
  • func (*HeaderValueOption) Descriptor() ([]byte, []int)
  • func (m *HeaderValueOption) Equal(that interface{}) bool
  • func (x *HeaderValueOption) GetAppend() *wrappers.BoolValue
  • func (x *HeaderValueOption) GetHeader() *HeaderValue
  • func (m *HeaderValueOption) Hash(hasher hash.Hash64) (uint64, error)
  • func (*HeaderValueOption) ProtoMessage()
  • func (x *HeaderValueOption) ProtoReflect() protoreflect.Message
  • func (x *HeaderValueOption) Reset()
  • func (x *HeaderValueOption) String() string

Variables

var File_github_com_solo_io_gloo_projects_gloo_api_v1_options_headers_headers_proto protoreflect.FileDescriptor

Types

type HeaderManipulation

type HeaderManipulation struct {

	// Specifies a list of HTTP headers that should be added to each request
	// handled by this route or virtual host. For more information, including
	// details on header value syntax, see the
	// [Envoy documentation](https://www.envoyproxy.io/docs/envoy/latest/configuration/http_conn_man/headers#config-http-conn-man-headers-custom-request-headers) .
	RequestHeadersToAdd []*core.HeaderValueOption `protobuf:"bytes,1,rep,name=request_headers_to_add,json=requestHeadersToAdd,proto3" json:"request_headers_to_add,omitempty"`
	// Specifies a list of HTTP headers that should be removed from each request
	// handled by this route or virtual host.
	RequestHeadersToRemove []string `` /* 131-byte string literal not displayed */
	// Specifies a list of HTTP headers that should be added to each response
	// handled by this route or host. For more information, including
	// details on header value syntax, see the
	// [Envoy documentation](https://www.envoyproxy.io/docs/envoy/latest/configuration/http_conn_man/headers#config-http-conn-man-headers-custom-request-headers) .
	ResponseHeadersToAdd []*HeaderValueOption `protobuf:"bytes,3,rep,name=response_headers_to_add,json=responseHeadersToAdd,proto3" json:"response_headers_to_add,omitempty"`
	// Specifies a list of HTTP headers that should be removed from each response
	// handled by this route or virtual host.
	ResponseHeadersToRemove []string `` /* 134-byte string literal not displayed */
	// contains filtered or unexported fields
}

This plugin provides configuration options to append and remove headers from requests and responses HeaderManipulation can be specified on routes, virtual hosts, or weighted destinations

func (*HeaderManipulation) Descriptor

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

Deprecated: Use HeaderManipulation.ProtoReflect.Descriptor instead.

func (*HeaderManipulation) Equal

func (m *HeaderManipulation) Equal(that interface{}) bool

Equal function

func (*HeaderManipulation) GetRequestHeadersToAdd

func (x *HeaderManipulation) GetRequestHeadersToAdd() []*core.HeaderValueOption

func (*HeaderManipulation) GetRequestHeadersToRemove

func (x *HeaderManipulation) GetRequestHeadersToRemove() []string

func (*HeaderManipulation) GetResponseHeadersToAdd

func (x *HeaderManipulation) GetResponseHeadersToAdd() []*HeaderValueOption

func (*HeaderManipulation) GetResponseHeadersToRemove

func (x *HeaderManipulation) GetResponseHeadersToRemove() []string

func (*HeaderManipulation) Hash

func (m *HeaderManipulation) Hash(hasher hash.Hash64) (uint64, error)

Hash function

func (*HeaderManipulation) ProtoMessage

func (*HeaderManipulation) ProtoMessage()

func (*HeaderManipulation) ProtoReflect

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

func (*HeaderManipulation) Reset

func (x *HeaderManipulation) Reset()

func (*HeaderManipulation) String

func (x *HeaderManipulation) String() string

type HeaderValue

type HeaderValue struct {

	// Header name.
	Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	// Header value.
	Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

Header name/value pair.

func (*HeaderValue) Descriptor

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

Deprecated: Use HeaderValue.ProtoReflect.Descriptor instead.

func (*HeaderValue) Equal

func (m *HeaderValue) Equal(that interface{}) bool

Equal function

func (*HeaderValue) GetKey

func (x *HeaderValue) GetKey() string

func (*HeaderValue) GetValue

func (x *HeaderValue) GetValue() string

func (*HeaderValue) Hash

func (m *HeaderValue) Hash(hasher hash.Hash64) (uint64, error)

Hash function

func (*HeaderValue) ProtoMessage

func (*HeaderValue) ProtoMessage()

func (*HeaderValue) ProtoReflect

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

func (*HeaderValue) Reset

func (x *HeaderValue) Reset()

func (*HeaderValue) String

func (x *HeaderValue) String() string

type HeaderValueOption

type HeaderValueOption struct {

	// Header name/value pair that this option applies to.
	Header *HeaderValue `protobuf:"bytes,1,opt,name=header,proto3" json:"header,omitempty"`
	// Should the value be appended? If true (default), the value is appended to
	// existing values.
	Append *wrappers.BoolValue `protobuf:"bytes,2,opt,name=append,proto3" json:"append,omitempty"`
	// contains filtered or unexported fields
}

Header name/value pair plus option to control append behavior.

func (*HeaderValueOption) Descriptor

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

Deprecated: Use HeaderValueOption.ProtoReflect.Descriptor instead.

func (*HeaderValueOption) Equal

func (m *HeaderValueOption) Equal(that interface{}) bool

Equal function

func (*HeaderValueOption) GetAppend

func (x *HeaderValueOption) GetAppend() *wrappers.BoolValue

func (*HeaderValueOption) GetHeader

func (x *HeaderValueOption) GetHeader() *HeaderValue

func (*HeaderValueOption) Hash

func (m *HeaderValueOption) Hash(hasher hash.Hash64) (uint64, error)

Hash function

func (*HeaderValueOption) ProtoMessage

func (*HeaderValueOption) ProtoMessage()

func (*HeaderValueOption) ProtoReflect

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

func (*HeaderValueOption) Reset

func (x *HeaderValueOption) Reset()

func (*HeaderValueOption) String

func (x *HeaderValueOption) String() string