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

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method	Description
`com.google.protobuf.Struct`	`getDynamicMetadata()`	Deprecated. envoy.service.auth.v3.OkHttpResponse.dynamic_metadata is deprecated.
`com.google.protobuf.StructOrBuilder`	`getDynamicMetadataOrBuilder()`	Deprecated.
`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.
`java.util.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.
`java.util.List<? extends HeaderValueOptionOrBuilder>`	`getHeadersOrBuilderList()`	HTTP entity headers in addition to the original request headers.
`java.lang.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.
`java.util.List<java.lang.String>`	`getHeadersToRemoveList()`	HTTP entity headers to remove from the original request before dispatching it to the upstream.
`java.lang.String`	`getQueryParametersToRemove(int index)`	This field allows the authorization service to specify which query parameters should be removed from the original request before it is sent upstream.
`com.google.protobuf.ByteString`	`getQueryParametersToRemoveBytes(int index)`	This field allows the authorization service to specify which query parameters should be removed from the original request before it is sent upstream.
`int`	`getQueryParametersToRemoveCount()`	This field allows the authorization service to specify which query parameters should be removed from the original request before it is sent upstream.
`java.util.List<java.lang.String>`	`getQueryParametersToRemoveList()`	This field allows the authorization service to specify which query parameters should be removed from the original request before it is sent upstream.
`QueryParameter`	`getQueryParametersToSet(int index)`	This field allows the authorization service to set (and overwrite) query string parameters on the original request before it is sent upstream.
`int`	`getQueryParametersToSetCount()`	This field allows the authorization service to set (and overwrite) query string parameters on the original request before it is sent upstream.
`java.util.List<QueryParameter>`	`getQueryParametersToSetList()`	This field allows the authorization service to set (and overwrite) query string parameters on the original request before it is sent upstream.
`QueryParameterOrBuilder`	`getQueryParametersToSetOrBuilder(int index)`	This field allows the authorization service to set (and overwrite) query string parameters on the original request before it is sent upstream.
`java.util.List<? extends QueryParameterOrBuilder>`	`getQueryParametersToSetOrBuilderList()`	This field allows the authorization service to set (and overwrite) query string parameters on the original request before it is sent upstream.
`HeaderValueOption`	`getResponseHeadersToAdd(int index)`	This field allows the authorization service to send HTTP response headers to the downstream client on success.
`int`	`getResponseHeadersToAddCount()`	This field allows the authorization service to send HTTP response headers to the downstream client on success.
`java.util.List<HeaderValueOption>`	`getResponseHeadersToAddList()`	This field allows the authorization service to send HTTP response headers to the downstream client on success.
`HeaderValueOptionOrBuilder`	`getResponseHeadersToAddOrBuilder(int index)`	This field allows the authorization service to send HTTP response headers to the downstream client on success.
`java.util.List<? extends HeaderValueOptionOrBuilder>`	`getResponseHeadersToAddOrBuilderList()`	This field allows the authorization service to send HTTP response headers to the downstream client on success.
`boolean`	`hasDynamicMetadata()`	Deprecated. envoy.service.auth.v3.OkHttpResponse.dynamic_metadata is deprecated.

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Method Detail

getHeadersList

java.util.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 :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.

repeated .envoy.config.core.v3.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 :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.

repeated .envoy.config.core.v3.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 :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.

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

getHeadersOrBuilderList

java.util.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 :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.

repeated .envoy.config.core.v3.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 :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.

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

getHeadersToRemoveList

java.util.List<java.lang.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;

Returns:: A list containing the headersToRemove.

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;

Returns:: The count of headersToRemove.

getHeadersToRemove

java.lang.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;

Parameters:: index - The index of the element to return.
Returns:: The headersToRemove at the given index.

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;

Parameters:: index - The index of the value to return.
Returns:: The bytes of the headersToRemove at the given index.

hasDynamicMetadata

@Deprecated
boolean hasDynamicMetadata()

Deprecated.

envoy.service.auth.v3.OkHttpResponse.dynamic_metadata is deprecated. See envoy/service/auth/v3/external_auth.proto;l=98

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

.google.protobuf.Struct dynamic_metadata = 3 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];

Returns:: Whether the dynamicMetadata field is set.

getDynamicMetadata

@Deprecated
com.google.protobuf.Struct getDynamicMetadata()

Deprecated.

envoy.service.auth.v3.OkHttpResponse.dynamic_metadata is deprecated. See envoy/service/auth/v3/external_auth.proto;l=98

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

.google.protobuf.Struct dynamic_metadata = 3 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];

Returns:: The dynamicMetadata.

getDynamicMetadataOrBuilder

@Deprecated
com.google.protobuf.StructOrBuilder getDynamicMetadataOrBuilder()

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

.google.protobuf.Struct dynamic_metadata = 3 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];