Struct OkHttpResponse

pub struct OkHttpResponse {
    pub headers: Vec<HeaderValueOption>,
    pub headers_to_remove: Vec<String>,
    pub dynamic_metadata: Option<Struct>,
    pub response_headers_to_add: Vec<HeaderValueOption>,
    pub query_parameters_to_set: Vec<QueryParameter>,
    pub query_parameters_to_remove: Vec<String>,
}

HTTP attributes for an OK response. [#next-free-field: 9]

Fields

headers: Vec<HeaderValueOption>

HTTP entity headers in addition to the original request headers. This allows the authorization service to append, to add or to override headers from the original request before dispatching it to the upstream. Note that the :ref:append field in HeaderValueOption <envoy_v3_api_field_config.core.v3.HeaderValueOption.append> defaults to false when used in this message. By setting the append field to true, the filter will append the correspondent header value to the matched request header. By leaving append as false, the filter will either add a new header, or override an existing one if there is a match.

headers_to_remove: Vec<String>

HTTP entity headers to remove from the original request before dispatching it to the upstream. This allows the authorization service to act on auth related headers (like Authorization), process them, and consume them. Under this model, the upstream will either receive the request (if it’s authorized) or not receive it (if it’s not), but will not see headers containing authorization credentials.

Pseudo headers (such as :authority, :method, :path etc), as well as the header Host, may not be removed as that would make the request malformed. If mentioned in headers_to_remove these special headers will be ignored.

When using the HTTP service this must instead be set by the HTTP authorization service as a comma separated list like so: x-envoy-auth-headers-to-remove: one-auth-header, another-auth-header.

dynamic_metadata: Option<Struct>

👎Deprecated

This field has been deprecated in favor of :ref:CheckResponse.dynamic_metadata <envoy_v3_api_field_service.auth.v3.CheckResponse.dynamic_metadata>. Until it is removed, setting this field overrides :ref:CheckResponse.dynamic_metadata <envoy_v3_api_field_service.auth.v3.CheckResponse.dynamic_metadata>.

response_headers_to_add: Vec<HeaderValueOption>

This field allows the authorization service to send HTTP response headers to the downstream client on success. Note that the :ref:append field in HeaderValueOption <envoy_v3_api_field_config.core.v3.HeaderValueOption.append> defaults to false when used in this message.

query_parameters_to_set: Vec<QueryParameter>

This field allows the authorization service to set (and overwrite) query string parameters on the original request before it is sent upstream.

query_parameters_to_remove: Vec<String>

This field allows the authorization service to specify which query parameters should be removed from the original request before it is sent upstream. Each element in this list is a case-sensitive query parameter name to be removed.

Trait Implementations

impl Clone for OkHttpResponse

fn clone(&self) -> OkHttpResponse

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OkHttpResponse

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for OkHttpResponse

fn default() -> Self

Returns the “default value” for a type.

impl Message for OkHttpResponse

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl Name for OkHttpResponse

const NAME: &'static str = "OkHttpResponse"

Simple name for this Message. This name is the same as it appears in the source .proto file, e.g. FooBar.

const PACKAGE: &'static str = "envoy.service.auth.v3"

Package name this message type is contained in. They are domain-like and delimited by ., e.g. google.protobuf.

fn full_name() -> String

Fully-qualified unique name for this Message. It’s prefixed with the package name and names of any parent messages, e.g. google.rpc.BadRequest.FieldViolation. By default, this is the package name followed by the message name. Fully-qualified names must be unique within a domain of Type URLs.

fn type_url() -> String

Type URL for this Message, which by default is the full name with a leading slash, but may also include a leading domain name, e.g. type.googleapis.com/google.profile.Person. This can be used when serializing into the google.protobuf.Any type.

impl PartialEq for OkHttpResponse

fn eq(&self, other: &OkHttpResponse) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for OkHttpResponse