Class ProcessingMode
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.filters.http.ext_proc.v3.ProcessingMode
- All Implemented Interfaces:
com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,ProcessingModeOrBuilder,Serializable
public final class ProcessingMode
extends com.google.protobuf.GeneratedMessageV3
implements ProcessingModeOrBuilder
[#next-free-field: 7]Protobuf type
envoy.extensions.filters.http.ext_proc.v3.ProcessingMode- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumControl how the request and response bodies are handled When body mutation by external processor is enabled, ext_proc filter will always remove the content length header in four cases below because content length can not be guaranteed to be set correctly: 1) STREAMED BodySendMode: header processing completes before body mutation comes back. 2) BUFFERED_PARTIAL BodySendMode: body is buffered and could be injected in different phases. 3) BUFFERED BodySendMode + SKIP HeaderSendMode: header processing (e.g., update content-length) is skipped. 4) FULL_DUPLEX_STREAMED BodySendMode: header processing completes before body mutation comes back.static final class[#next-free-field: 7]static enumControl how headers and trailers are handledNested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, 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
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleanstatic ProcessingModestatic final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Parser<ProcessingMode>How to handle the request body.intHow to handle the request body.How to handle the request header.intHow to handle the request header.How to handle the request trailers.intHow to handle the request trailers.How do handle the response body.intHow do handle the response body.How to handle the response header.intHow to handle the response header.How to handle the response trailers.intHow to handle the response trailers.intinthashCode()protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTablefinal booleanstatic ProcessingMode.Builderstatic ProcessingMode.BuildernewBuilder(ProcessingMode prototype) protected ProcessingMode.BuildernewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) protected ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) static ProcessingModeparseDelimitedFrom(InputStream input) static ProcessingModeparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ProcessingModeparseFrom(byte[] data) static ProcessingModeparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ProcessingModeparseFrom(com.google.protobuf.ByteString data) static ProcessingModeparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ProcessingModeparseFrom(com.google.protobuf.CodedInputStream input) static ProcessingModeparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ProcessingModeparseFrom(InputStream input) static ProcessingModeparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ProcessingModeparseFrom(ByteBuffer data) static ProcessingModeparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<ProcessingMode>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, 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, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
REQUEST_HEADER_MODE_FIELD_NUMBER
public static final int REQUEST_HEADER_MODE_FIELD_NUMBER- See Also:
-
RESPONSE_HEADER_MODE_FIELD_NUMBER
public static final int RESPONSE_HEADER_MODE_FIELD_NUMBER- See Also:
-
REQUEST_BODY_MODE_FIELD_NUMBER
public static final int REQUEST_BODY_MODE_FIELD_NUMBER- See Also:
-
RESPONSE_BODY_MODE_FIELD_NUMBER
public static final int RESPONSE_BODY_MODE_FIELD_NUMBER- See Also:
-
REQUEST_TRAILER_MODE_FIELD_NUMBER
public static final int REQUEST_TRAILER_MODE_FIELD_NUMBER- See Also:
-
RESPONSE_TRAILER_MODE_FIELD_NUMBER
public static final int RESPONSE_TRAILER_MODE_FIELD_NUMBER- See Also:
-
-
Method Details
-
newInstance
- Overrides:
newInstancein classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3
-
getRequestHeaderModeValue
public int getRequestHeaderModeValue()How to handle the request header. Default is "SEND". Note this field is ignored in :ref:`mode_override <envoy_v3_api_field_service.ext_proc.v3.ProcessingResponse.mode_override>`, since mode overrides can only affect messages exchanged after the request header is processed.
.envoy.extensions.filters.http.ext_proc.v3.ProcessingMode.HeaderSendMode request_header_mode = 1 [(.validate.rules) = { ... }- Specified by:
getRequestHeaderModeValuein interfaceProcessingModeOrBuilder- Returns:
- The enum numeric value on the wire for requestHeaderMode.
-
getRequestHeaderMode
How to handle the request header. Default is "SEND". Note this field is ignored in :ref:`mode_override <envoy_v3_api_field_service.ext_proc.v3.ProcessingResponse.mode_override>`, since mode overrides can only affect messages exchanged after the request header is processed.
.envoy.extensions.filters.http.ext_proc.v3.ProcessingMode.HeaderSendMode request_header_mode = 1 [(.validate.rules) = { ... }- Specified by:
getRequestHeaderModein interfaceProcessingModeOrBuilder- Returns:
- The requestHeaderMode.
-
getResponseHeaderModeValue
public int getResponseHeaderModeValue()How to handle the response header. Default is "SEND".
.envoy.extensions.filters.http.ext_proc.v3.ProcessingMode.HeaderSendMode response_header_mode = 2 [(.validate.rules) = { ... }- Specified by:
getResponseHeaderModeValuein interfaceProcessingModeOrBuilder- Returns:
- The enum numeric value on the wire for responseHeaderMode.
-
getResponseHeaderMode
How to handle the response header. Default is "SEND".
.envoy.extensions.filters.http.ext_proc.v3.ProcessingMode.HeaderSendMode response_header_mode = 2 [(.validate.rules) = { ... }- Specified by:
getResponseHeaderModein interfaceProcessingModeOrBuilder- Returns:
- The responseHeaderMode.
-
getRequestBodyModeValue
public int getRequestBodyModeValue()How to handle the request body. Default is "NONE".
.envoy.extensions.filters.http.ext_proc.v3.ProcessingMode.BodySendMode request_body_mode = 3 [(.validate.rules) = { ... }- Specified by:
getRequestBodyModeValuein interfaceProcessingModeOrBuilder- Returns:
- The enum numeric value on the wire for requestBodyMode.
-
getRequestBodyMode
How to handle the request body. Default is "NONE".
.envoy.extensions.filters.http.ext_proc.v3.ProcessingMode.BodySendMode request_body_mode = 3 [(.validate.rules) = { ... }- Specified by:
getRequestBodyModein interfaceProcessingModeOrBuilder- Returns:
- The requestBodyMode.
-
getResponseBodyModeValue
public int getResponseBodyModeValue()How do handle the response body. Default is "NONE".
.envoy.extensions.filters.http.ext_proc.v3.ProcessingMode.BodySendMode response_body_mode = 4 [(.validate.rules) = { ... }- Specified by:
getResponseBodyModeValuein interfaceProcessingModeOrBuilder- Returns:
- The enum numeric value on the wire for responseBodyMode.
-
getResponseBodyMode
How do handle the response body. Default is "NONE".
.envoy.extensions.filters.http.ext_proc.v3.ProcessingMode.BodySendMode response_body_mode = 4 [(.validate.rules) = { ... }- Specified by:
getResponseBodyModein interfaceProcessingModeOrBuilder- Returns:
- The responseBodyMode.
-
getRequestTrailerModeValue
public int getRequestTrailerModeValue()How to handle the request trailers. Default is "SKIP".
.envoy.extensions.filters.http.ext_proc.v3.ProcessingMode.HeaderSendMode request_trailer_mode = 5 [(.validate.rules) = { ... }- Specified by:
getRequestTrailerModeValuein interfaceProcessingModeOrBuilder- Returns:
- The enum numeric value on the wire for requestTrailerMode.
-
getRequestTrailerMode
How to handle the request trailers. Default is "SKIP".
.envoy.extensions.filters.http.ext_proc.v3.ProcessingMode.HeaderSendMode request_trailer_mode = 5 [(.validate.rules) = { ... }- Specified by:
getRequestTrailerModein interfaceProcessingModeOrBuilder- Returns:
- The requestTrailerMode.
-
getResponseTrailerModeValue
public int getResponseTrailerModeValue()How to handle the response trailers. Default is "SKIP".
.envoy.extensions.filters.http.ext_proc.v3.ProcessingMode.HeaderSendMode response_trailer_mode = 6 [(.validate.rules) = { ... }- Specified by:
getResponseTrailerModeValuein interfaceProcessingModeOrBuilder- Returns:
- The enum numeric value on the wire for responseTrailerMode.
-
getResponseTrailerMode
How to handle the response trailers. Default is "SKIP".
.envoy.extensions.filters.http.ext_proc.v3.ProcessingMode.HeaderSendMode response_trailer_mode = 6 [(.validate.rules) = { ... }- Specified by:
getResponseTrailerModein interfaceProcessingModeOrBuilder- Returns:
- The responseTrailerMode.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessageV3- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessageV3
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static ProcessingMode parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ProcessingMode parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ProcessingMode parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ProcessingMode parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ProcessingMode parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ProcessingMode parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static ProcessingMode parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static ProcessingMode parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static ProcessingMode parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static ProcessingMode parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected ProcessingMode.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) - Specified by:
newBuilderForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-