java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - io.envoyproxy.envoy.service.auth.v3.OkHttpResponse

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, OkHttpResponseOrBuilder, java.io.Serializable
```
public final class OkHttpResponse
extends com.google.protobuf.GeneratedMessageV3
implements OkHttpResponseOrBuilder
```
```
 HTTP attributes for an OK response.
 [#next-free-field: 9]
 
```
Protobuf type envoy.service.auth.v3.OkHttpResponse
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class OkHttpResponse.Builder
HTTP attributes for an OK response.
- Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
  com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
- Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
  com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`DYNAMIC_METADATA_FIELD_NUMBER`
`static int`	`HEADERS_FIELD_NUMBER`
`static int`	`HEADERS_TO_REMOVE_FIELD_NUMBER`
`static int`	`QUERY_PARAMETERS_TO_REMOVE_FIELD_NUMBER`
`static int`	`QUERY_PARAMETERS_TO_SET_FIELD_NUMBER`
`static int`	`RESPONSE_HEADERS_TO_ADD_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`boolean`	`equals(java.lang.Object obj)`
`static OkHttpResponse`	`getDefaultInstance()`
`OkHttpResponse`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`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.
`com.google.protobuf.ProtocolStringList`	`getHeadersToRemoveList()`	HTTP entity headers to remove from the original request before dispatching it to the upstream.
`com.google.protobuf.Parser<OkHttpResponse>`	`getParserForType()`
`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.
`com.google.protobuf.ProtocolStringList`	`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.
`int`	`getSerializedSize()`
`com.google.protobuf.UnknownFieldSet`	`getUnknownFields()`
`boolean`	`hasDynamicMetadata()`	Deprecated. envoy.service.auth.v3.OkHttpResponse.dynamic_metadata is deprecated.
`int`	`hashCode()`
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`static OkHttpResponse.Builder`	`newBuilder()`
`static OkHttpResponse.Builder`	`newBuilder(OkHttpResponse prototype)`
`OkHttpResponse.Builder`	`newBuilderForType()`
`protected OkHttpResponse.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected java.lang.Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static OkHttpResponse`	`parseDelimitedFrom(java.io.InputStream input)`
`static OkHttpResponse`	`parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static OkHttpResponse`	`parseFrom(byte[] data)`
`static OkHttpResponse`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static OkHttpResponse`	`parseFrom(com.google.protobuf.ByteString data)`
`static OkHttpResponse`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static OkHttpResponse`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static OkHttpResponse`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static OkHttpResponse`	`parseFrom(java.io.InputStream input)`
`static OkHttpResponse`	`parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static OkHttpResponse`	`parseFrom(java.nio.ByteBuffer data)`
`static OkHttpResponse`	`parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<OkHttpResponse>`	`parser()`
`OkHttpResponse.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

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

Field Detail
- HEADERS_FIELD_NUMBER
```
public static final int HEADERS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- HEADERS_TO_REMOVE_FIELD_NUMBER
```
public static final int HEADERS_TO_REMOVE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DYNAMIC_METADATA_FIELD_NUMBER
```
public static final int DYNAMIC_METADATA_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- RESPONSE_HEADERS_TO_ADD_FIELD_NUMBER
```
public static final int RESPONSE_HEADERS_TO_ADD_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- QUERY_PARAMETERS_TO_SET_FIELD_NUMBER
```
public static final int QUERY_PARAMETERS_TO_SET_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- QUERY_PARAMETERS_TO_REMOVE_FIELD_NUMBER
```
public static final int QUERY_PARAMETERS_TO_REMOVE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

newInstance

protected java.lang.Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields
```
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
```
Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getHeadersList

public 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;

Specified by:: getHeadersList in interface OkHttpResponseOrBuilder

getHeadersOrBuilderList

public 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;

Specified by:: getHeadersOrBuilderList in interface OkHttpResponseOrBuilder

getHeadersCount

public 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;

Specified by:: getHeadersCount in interface OkHttpResponseOrBuilder

getHeaders

public 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;

Specified by:: getHeaders in interface OkHttpResponseOrBuilder

getHeadersOrBuilder

public 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;

Specified by:: getHeadersOrBuilder in interface OkHttpResponseOrBuilder

getHeadersToRemoveList

public com.google.protobuf.ProtocolStringList 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;

Specified by:: getHeadersToRemoveList in interface OkHttpResponseOrBuilder
Returns:: A list containing the headersToRemove.

getHeadersToRemoveCount

public 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;

Specified by:: getHeadersToRemoveCount in interface OkHttpResponseOrBuilder
Returns:: The count of headersToRemove.

getHeadersToRemove

public 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;

Specified by:: getHeadersToRemove in interface OkHttpResponseOrBuilder
Parameters:: index - The index of the element to return.
Returns:: The headersToRemove at the given index.

getHeadersToRemoveBytes

public 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;

Specified by:: getHeadersToRemoveBytes in interface OkHttpResponseOrBuilder
Parameters:: index - The index of the value to return.
Returns:: The bytes of the headersToRemove at the given index.

hasDynamicMetadata
```
@Deprecated
public 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"];
Specified by:

hasDynamicMetadata in interface OkHttpResponseOrBuilder

Returns:

Whether the dynamicMetadata field is set.

getDynamicMetadata

@Deprecated
public 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"];

Specified by:: getDynamicMetadata in interface OkHttpResponseOrBuilder
Returns:: The dynamicMetadata.

getDynamicMetadataOrBuilder

@Deprecated
public 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"];

Specified by:: getDynamicMetadataOrBuilder in interface OkHttpResponseOrBuilder