io.envoyproxy.envoy.service.auth.v3

Class OkHttpResponse

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, Serializable

public final class OkHttpResponse
extends com.google.protobuf.GeneratedMessageV3
implements OkHttpResponseOrBuilder

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

Protobuf type envoy.service.auth.v3.OkHttpResponse

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and 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

Field Summary

Fields

Modifier and Type	Field and Description
static int	DYNAMIC_METADATA_FIELD_NUMBER
static int	HEADERS_FIELD_NUMBER
static int	HEADERS_TO_REMOVE_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

Modifier and Type	Method and Description
boolean	equals(Object obj)
static OkHttpResponse	getDefaultInstance()
OkHttpResponse	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Struct	getDynamicMetadata() 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.
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.
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()
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasDynamicMetadata() 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 Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static OkHttpResponse	parseDelimitedFrom(InputStream input)
static OkHttpResponse	parseDelimitedFrom(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(ByteBuffer data)
static OkHttpResponse	parseFrom(ByteBuffer 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(InputStream input)
static OkHttpResponse	parseFrom(InputStream input, 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, 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.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

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

Method Detail

newInstance

protected 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 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.v3.HeaderValueOption headers = 2;

Specified by:

getHeadersList in interface OkHttpResponseOrBuilder

getHeadersOrBuilderList

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

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

getHeadersToRemove

public 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

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

hasDynamicMetadata

@Deprecated
public boolean hasDynamicMetadata()

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

Specified by:

hasDynamicMetadata in interface OkHttpResponseOrBuilder

getDynamicMetadata

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

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

Specified by:

getDynamicMetadata in interface OkHttpResponseOrBuilder

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

Specified by:

getDynamicMetadataOrBuilder in interface OkHttpResponseOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static OkHttpResponse parseFrom(ByteBuffer data)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static OkHttpResponse parseFrom(ByteBuffer data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static OkHttpResponse parseFrom(com.google.protobuf.ByteString data)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static OkHttpResponse parseFrom(com.google.protobuf.ByteString data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static OkHttpResponse parseFrom(byte[] data)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static OkHttpResponse parseFrom(byte[] data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static OkHttpResponse parseFrom(InputStream input)
                                throws IOException

Throws:

IOException

parseFrom

public static OkHttpResponse parseFrom(InputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException

Throws:

IOException

parseDelimitedFrom

public static OkHttpResponse parseDelimitedFrom(InputStream input)
                                         throws IOException

Throws:

IOException

parseDelimitedFrom

public static OkHttpResponse parseDelimitedFrom(InputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws IOException

Throws:

IOException

parseFrom

public static OkHttpResponse parseFrom(com.google.protobuf.CodedInputStream input)
                                throws IOException

Throws:

IOException

parseFrom

public static OkHttpResponse parseFrom(com.google.protobuf.CodedInputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException

Throws:

IOException

newBuilderForType

public OkHttpResponse.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static OkHttpResponse.Builder newBuilder()

newBuilder

public static OkHttpResponse.Builder newBuilder(OkHttpResponse prototype)

toBuilder

public OkHttpResponse.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected OkHttpResponse.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static OkHttpResponse getDefaultInstance()

parser

public static com.google.protobuf.Parser<OkHttpResponse> parser()

getParserForType

public com.google.protobuf.Parser<OkHttpResponse> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public OkHttpResponse getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder