io.envoyproxy.envoy.service.auth.v4alpha

Interface OkHttpResponseOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

OkHttpResponse, OkHttpResponse.Builder

public interface OkHttpResponseOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
HeaderValueOption	getHeaders(int index) HTTP entity headers in addition to the original request headers.
int	getHeadersCount() HTTP entity headers in addition to the original request headers.
List<HeaderValueOption>	getHeadersList() HTTP entity headers in addition to the original request headers.
HeaderValueOptionOrBuilder	getHeadersOrBuilder(int index) HTTP entity headers in addition to the original request headers.
List<? extends HeaderValueOptionOrBuilder>	getHeadersOrBuilderList() HTTP entity headers in addition to the original request headers.
String	getHeadersToRemove(int index) HTTP entity headers to remove from the original request before dispatching it to the upstream.
com.google.protobuf.ByteString	getHeadersToRemoveBytes(int index) HTTP entity headers to remove from the original request before dispatching it to the upstream.
int	getHeadersToRemoveCount() HTTP entity headers to remove from the original request before dispatching it to the upstream.
List<String>	getHeadersToRemoveList() HTTP entity headers to remove from the original request before dispatching it to the upstream.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getHeadersList

List<HeaderValueOption> getHeadersList()

 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 `append` field in `HeaderValueOption` 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.
 

repeated .envoy.config.core.v4alpha.HeaderValueOption headers = 2;

getHeaders

HeaderValueOption getHeaders(int index)

 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 `append` field in `HeaderValueOption` 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.
 

repeated .envoy.config.core.v4alpha.HeaderValueOption headers = 2;

getHeadersCount

int getHeadersCount()

 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 `append` field in `HeaderValueOption` 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.
 

repeated .envoy.config.core.v4alpha.HeaderValueOption headers = 2;

getHeadersOrBuilderList

List<? extends HeaderValueOptionOrBuilder> getHeadersOrBuilderList()

 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 `append` field in `HeaderValueOption` 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.
 

repeated .envoy.config.core.v4alpha.HeaderValueOption headers = 2;

getHeadersOrBuilder

HeaderValueOptionOrBuilder getHeadersOrBuilder(int index)

 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 `append` field in `HeaderValueOption` 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.
 

repeated .envoy.config.core.v4alpha.HeaderValueOption headers = 2;

getHeadersToRemoveList

List<String> getHeadersToRemoveList()

 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``.
 

repeated string headers_to_remove = 5;

getHeadersToRemoveCount

int getHeadersToRemoveCount()

 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``.
 

repeated string headers_to_remove = 5;

getHeadersToRemove

String getHeadersToRemove(int index)

 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``.
 

repeated string headers_to_remove = 5;

getHeadersToRemoveBytes

com.google.protobuf.ByteString getHeadersToRemoveBytes(int index)

 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``.
 

repeated string headers_to_remove = 5;