Package io.envoyproxy.envoy.extensions.filters.http.ext_proc.v3

Class ExternalProcessor

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ExternalProcessorOrBuilder, Serializable
    public final class ExternalProcessor
extends com.google.protobuf.GeneratedMessageV3
implements ExternalProcessorOrBuilder
     The filter communicates with an external gRPC service called an "external processor"
 that can do a variety of things with the request and response:
 * Access and modify the HTTP headers on the request, response, or both
 * Access and modify the HTTP request and response bodies
 * Access and modify the dynamic stream metadata
 * Immediately send an HTTP response downstream and terminate other processing
 The filter communicates with the server using a gRPC bidirectional stream. After the initial
 request, the external server is in control over what additional data is sent to it
 and how it should be processed.
 By implementing the protocol specified by the stream, the external server can choose:
 * Whether it receives the response message at all
 * Whether it receives the message body at all, in separate chunks, or as a single buffer
 * Whether subsequent HTTP requests are transmitted synchronously or whether they are
   sent asynchronously.
 * To modify request or response trailers if they already exist
 The filter supports up to six different processing steps. Each is represented by
 a gRPC stream message that is sent to the external processor. For each message, the
 processor must send a matching response.
 * Request headers: Contains the headers from the original HTTP request.
 * Request body: Delivered if they are present and sent in a single message if
   the BUFFERED or BUFFERED_PARTIAL mode is chosen, in multiple messages if the
   STREAMED mode is chosen, and not at all otherwise.
 * Request trailers: Delivered if they are present and if the trailer mode is set
   to SEND.
 * Response headers: Contains the headers from the HTTP response. Keep in mind
   that if the upstream system sends them before processing the request body that
   this message may arrive before the complete body.
 * Response body: Sent according to the processing mode like the request body.
 * Response trailers: Delivered according to the processing mode like the
   request trailers.
 By default, the processor sends only the request and response headers messages.
 This may be changed to include any of the six steps by changing the processing_mode
 setting of the filter configuration, or by setting the mode_override of any response
 from the external processor. The latter is only enabled if allow_mode_override is
 set to true. This way, a processor may, for example, use information
 in the request header to determine whether the message body must be examined, or whether
 the proxy should simply stream it straight through.
 All of this together allows a server to process the filter traffic in fairly
 sophisticated ways. For example:
 * A server may choose to examine all or part of the HTTP message bodies depending
   on the content of the headers.
 * A server may choose to immediately reject some messages based on their HTTP
   headers (or other dynamic metadata) and more carefully examine others.
 * A server may asynchronously monitor traffic coming through the filter by inspecting
   headers, bodies, or both, and then decide to switch to a synchronous processing
   mode, either permanently or temporarily.
 The protocol itself is based on a bidirectional gRPC stream. Envoy will send the
 server
 :ref:`ProcessingRequest <envoy_v3_api_msg_service.ext_proc.v3.ProcessingRequest>`
 messages, and the server must reply with
 :ref:`ProcessingResponse <envoy_v3_api_msg_service.ext_proc.v3.ProcessingResponse>`.
 Stats about each gRPC call are recorded in a :ref:`dynamic filter state
 <arch_overview_advanced_filter_state_sharing>` object in a namespace matching the filter
 name.
 [#next-free-field: 16]
    Protobuf type envoy.extensions.filters.http.ext_proc.v3.ExternalProcessor
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ExternalProcessor.Builder
      The filter communicates with an external gRPC service called an "external processor" that can do a variety of things with the request and response: * Access and modify the HTTP headers on the request, response, or both * Access and modify the HTTP request and response bodies * Access and modify the dynamic stream metadata * Immediately send an HTTP response downstream and terminate other processing The filter communicates with the server using a gRPC bidirectional stream.

      • 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

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(Object obj)  
      boolean getAllowModeOverride()
      If ``allow_mode_override`` is set to true, the filter config :ref:`processing_mode <envoy_v3_api_field_extensions.filters.http.ext_proc.v3.ExternalProcessor.processing_mode>` can be overridden by the response message from the external processing server :ref:`mode_override <envoy_v3_api_field_service.ext_proc.v3.ProcessingResponse.mode_override>`.
      boolean getAsyncMode()
      [#not-implemented-hide:] If true, send each part of the HTTP request or response specified by ProcessingMode asynchronously -- in other words, send the message on the gRPC stream and then continue filter processing.
      static ExternalProcessor getDefaultInstance()  
      ExternalProcessor getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      boolean getDisableClearRouteCache()
      Prevents clearing the route-cache when the :ref:`clear_route_cache <envoy_v3_api_field_service.ext_proc.v3.CommonResponse.clear_route_cache>` field is set in an external processor response.
      boolean getDisableImmediateResponse()
      If set to true, ignore the :ref:`immediate_response <envoy_v3_api_field_service.ext_proc.v3.ProcessingResponse.immediate_response>` message in an external processor response.
      boolean getFailureModeAllow()
      By default, if the gRPC stream cannot be established, or if it is closed prematurely with an error, the filter will fail.
      com.google.protobuf.Struct getFilterMetadata()
      Additional metadata to be added to the filter state for logging purposes.
      com.google.protobuf.StructOrBuilder getFilterMetadataOrBuilder()
      Additional metadata to be added to the filter state for logging purposes.
      HeaderForwardingRules getForwardRules()
      Allow headers matching the ``forward_rules`` to be forwarded to the external processing server.
      HeaderForwardingRulesOrBuilder getForwardRulesOrBuilder()
      Allow headers matching the ``forward_rules`` to be forwarded to the external processing server.
      GrpcService getGrpcService()
      Configuration for the gRPC service that the filter will communicate with.
      GrpcServiceOrBuilder getGrpcServiceOrBuilder()
      Configuration for the gRPC service that the filter will communicate with.
      com.google.protobuf.Duration getMaxMessageTimeout()
      Specify the upper bound of :ref:`override_message_timeout <envoy_v3_api_field_service.ext_proc.v3.ProcessingResponse.override_message_timeout>` If not specified, by default it is 0, which will effectively disable the ``override_message_timeout`` API.
      com.google.protobuf.DurationOrBuilder getMaxMessageTimeoutOrBuilder()
      Specify the upper bound of :ref:`override_message_timeout <envoy_v3_api_field_service.ext_proc.v3.ProcessingResponse.override_message_timeout>` If not specified, by default it is 0, which will effectively disable the ``override_message_timeout`` API.
      com.google.protobuf.Duration getMessageTimeout()
      Specifies the timeout for each individual message sent on the stream and when the filter is running in synchronous mode.
      com.google.protobuf.DurationOrBuilder getMessageTimeoutOrBuilder()
      Specifies the timeout for each individual message sent on the stream and when the filter is running in synchronous mode.
      HeaderMutationRules getMutationRules()
      Rules that determine what modifications an external processing server may make to message headers.
      HeaderMutationRulesOrBuilder getMutationRulesOrBuilder()
      Rules that determine what modifications an external processing server may make to message headers.
      com.google.protobuf.Parser<ExternalProcessor> getParserForType()  
      ProcessingMode getProcessingMode()
      Specifies default options for how HTTP headers, trailers, and bodies are sent.
      ProcessingModeOrBuilder getProcessingModeOrBuilder()
      Specifies default options for how HTTP headers, trailers, and bodies are sent.
      String getRequestAttributes​(int index)
      [#not-implemented-hide:] Envoy provides a number of :ref:`attributes <arch_overview_attributes>` for expressive policies.
      com.google.protobuf.ByteString getRequestAttributesBytes​(int index)
      [#not-implemented-hide:] Envoy provides a number of :ref:`attributes <arch_overview_attributes>` for expressive policies.
      int getRequestAttributesCount()
      [#not-implemented-hide:] Envoy provides a number of :ref:`attributes <arch_overview_attributes>` for expressive policies.
      com.google.protobuf.ProtocolStringList getRequestAttributesList()
      [#not-implemented-hide:] Envoy provides a number of :ref:`attributes <arch_overview_attributes>` for expressive policies.
      String getResponseAttributes​(int index)
      [#not-implemented-hide:] Envoy provides a number of :ref:`attributes <arch_overview_attributes>` for expressive policies.
      com.google.protobuf.ByteString getResponseAttributesBytes​(int index)
      [#not-implemented-hide:] Envoy provides a number of :ref:`attributes <arch_overview_attributes>` for expressive policies.
      int getResponseAttributesCount()
      [#not-implemented-hide:] Envoy provides a number of :ref:`attributes <arch_overview_attributes>` for expressive policies.
      com.google.protobuf.ProtocolStringList getResponseAttributesList()
      [#not-implemented-hide:] Envoy provides a number of :ref:`attributes <arch_overview_attributes>` for expressive policies.
      int getSerializedSize()  
      String getStatPrefix()
      Optional additional prefix to use when emitting statistics.
      com.google.protobuf.ByteString getStatPrefixBytes()
      Optional additional prefix to use when emitting statistics.
      com.google.protobuf.UnknownFieldSet getUnknownFields()  
      boolean hasFilterMetadata()
      Additional metadata to be added to the filter state for logging purposes.
      boolean hasForwardRules()
      Allow headers matching the ``forward_rules`` to be forwarded to the external processing server.
      boolean hasGrpcService()
      Configuration for the gRPC service that the filter will communicate with.
      int hashCode()  
      boolean hasMaxMessageTimeout()
      Specify the upper bound of :ref:`override_message_timeout <envoy_v3_api_field_service.ext_proc.v3.ProcessingResponse.override_message_timeout>` If not specified, by default it is 0, which will effectively disable the ``override_message_timeout`` API.
      boolean hasMessageTimeout()
      Specifies the timeout for each individual message sent on the stream and when the filter is running in synchronous mode.
      boolean hasMutationRules()
      Rules that determine what modifications an external processing server may make to message headers.
      boolean hasProcessingMode()
      Specifies default options for how HTTP headers, trailers, and bodies are sent.
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static ExternalProcessor.Builder newBuilder()  
      static ExternalProcessor.Builder newBuilder​(ExternalProcessor prototype)  
      ExternalProcessor.Builder newBuilderForType()  
      protected ExternalProcessor.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static ExternalProcessor parseDelimitedFrom​(InputStream input)  
      static ExternalProcessor parseDelimitedFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static ExternalProcessor parseFrom​(byte[] data)  
      static ExternalProcessor parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static ExternalProcessor parseFrom​(com.google.protobuf.ByteString data)  
      static ExternalProcessor parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static ExternalProcessor parseFrom​(com.google.protobuf.CodedInputStream input)  
      static ExternalProcessor parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static ExternalProcessor parseFrom​(InputStream input)  
      static ExternalProcessor parseFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static ExternalProcessor parseFrom​(ByteBuffer data)  
      static ExternalProcessor parseFrom​(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<ExternalProcessor> parser()  
      ExternalProcessor.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 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

      • GRPC_SERVICE_FIELD_NUMBER

        public static final int GRPC_SERVICE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • FAILURE_MODE_ALLOW_FIELD_NUMBER

        public static final int FAILURE_MODE_ALLOW_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PROCESSING_MODE_FIELD_NUMBER

        public static final int PROCESSING_MODE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ASYNC_MODE_FIELD_NUMBER

        public static final int ASYNC_MODE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • REQUEST_ATTRIBUTES_FIELD_NUMBER

        public static final int REQUEST_ATTRIBUTES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RESPONSE_ATTRIBUTES_FIELD_NUMBER

        public static final int RESPONSE_ATTRIBUTES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MESSAGE_TIMEOUT_FIELD_NUMBER

        public static final int MESSAGE_TIMEOUT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • STAT_PREFIX_FIELD_NUMBER

        public static final int STAT_PREFIX_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MUTATION_RULES_FIELD_NUMBER

        public static final int MUTATION_RULES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MAX_MESSAGE_TIMEOUT_FIELD_NUMBER

        public static final int MAX_MESSAGE_TIMEOUT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DISABLE_CLEAR_ROUTE_CACHE_FIELD_NUMBER

        public static final int DISABLE_CLEAR_ROUTE_CACHE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • FORWARD_RULES_FIELD_NUMBER

        public static final int FORWARD_RULES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • FILTER_METADATA_FIELD_NUMBER

        public static final int FILTER_METADATA_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ALLOW_MODE_OVERRIDE_FIELD_NUMBER

        public static final int ALLOW_MODE_OVERRIDE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DISABLE_IMMEDIATE_RESPONSE_FIELD_NUMBER

        public static final int DISABLE_IMMEDIATE_RESPONSE_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

      • hasGrpcService

        public boolean hasGrpcService()
         Configuration for the gRPC service that the filter will communicate with.
 The filter supports both the "Envoy" and "Google" gRPC clients.
        .envoy.config.core.v3.GrpcService grpc_service = 1 [(.validate.rules) = { ... }
        Specified by:
        hasGrpcService in interface ExternalProcessorOrBuilder
        Returns:
        Whether the grpcService field is set.

      • getGrpcService

        public GrpcService getGrpcService()
         Configuration for the gRPC service that the filter will communicate with.
 The filter supports both the "Envoy" and "Google" gRPC clients.
        .envoy.config.core.v3.GrpcService grpc_service = 1 [(.validate.rules) = { ... }
        Specified by:
        getGrpcService in interface ExternalProcessorOrBuilder
        Returns:
        The grpcService.

      • getGrpcServiceOrBuilder

        public GrpcServiceOrBuilder getGrpcServiceOrBuilder()
         Configuration for the gRPC service that the filter will communicate with.
 The filter supports both the "Envoy" and "Google" gRPC clients.
        .envoy.config.core.v3.GrpcService grpc_service = 1 [(.validate.rules) = { ... }
        Specified by:
        getGrpcServiceOrBuilder in interface ExternalProcessorOrBuilder

      • getFailureModeAllow

        public boolean getFailureModeAllow()
         By default, if the gRPC stream cannot be established, or if it is closed
 prematurely with an error, the filter will fail. Specifically, if the
 response headers have not yet been delivered, then it will return a 500
 error downstream. If they have been delivered, then instead the HTTP stream to the
 downstream client will be reset.
 With this parameter set to true, however, then if the gRPC stream is prematurely closed
 or could not be opened, processing continues without error.
        bool failure_mode_allow = 2;
        Specified by:
        getFailureModeAllow in interface ExternalProcessorOrBuilder
        Returns:
        The failureModeAllow.

      • hasProcessingMode

        public boolean hasProcessingMode()
         Specifies default options for how HTTP headers, trailers, and bodies are
 sent. See ProcessingMode for details.
        .envoy.extensions.filters.http.ext_proc.v3.ProcessingMode processing_mode = 3;
        Specified by:
        hasProcessingMode in interface ExternalProcessorOrBuilder
        Returns:
        Whether the processingMode field is set.

      • getProcessingMode

        public ProcessingMode getProcessingMode()
         Specifies default options for how HTTP headers, trailers, and bodies are
 sent. See ProcessingMode for details.
        .envoy.extensions.filters.http.ext_proc.v3.ProcessingMode processing_mode = 3;
        Specified by:
        getProcessingMode in interface ExternalProcessorOrBuilder
        Returns:
        The processingMode.

      • getAsyncMode

        public boolean getAsyncMode()
         [#not-implemented-hide:]
 If true, send each part of the HTTP request or response specified by ProcessingMode
 asynchronously -- in other words, send the message on the gRPC stream and then continue
 filter processing. If false, which is the default, suspend filter execution after
 each message is sent to the remote service and wait up to "message_timeout"
 for a reply.
        bool async_mode = 4;
        Specified by:
        getAsyncMode in interface ExternalProcessorOrBuilder
        Returns:
        The asyncMode.

      • getRequestAttributesList

        public com.google.protobuf.ProtocolStringList getRequestAttributesList()
         [#not-implemented-hide:]
 Envoy provides a number of :ref:`attributes <arch_overview_attributes>`
 for expressive policies. Each attribute name provided in this field will be
 matched against that list and populated in the request_headers message.
 See the :ref:`attribute documentation <arch_overview_request_attributes>`
 for the list of supported attributes and their types.
        repeated string request_attributes = 5;
        Specified by:
        getRequestAttributesList in interface ExternalProcessorOrBuilder
        Returns:
        A list containing the requestAttributes.

      • getRequestAttributesCount

        public int getRequestAttributesCount()
         [#not-implemented-hide:]
 Envoy provides a number of :ref:`attributes <arch_overview_attributes>`
 for expressive policies. Each attribute name provided in this field will be
 matched against that list and populated in the request_headers message.
 See the :ref:`attribute documentation <arch_overview_request_attributes>`
 for the list of supported attributes and their types.
        repeated string request_attributes = 5;
        Specified by:
        getRequestAttributesCount in interface ExternalProcessorOrBuilder
        Returns:
        The count of requestAttributes.

      • getRequestAttributes

        public String getRequestAttributes​(int index)
         [#not-implemented-hide:]
 Envoy provides a number of :ref:`attributes <arch_overview_attributes>`
 for expressive policies. Each attribute name provided in this field will be
 matched against that list and populated in the request_headers message.
 See the :ref:`attribute documentation <arch_overview_request_attributes>`
 for the list of supported attributes and their types.
        repeated string request_attributes = 5;
        Specified by:
        getRequestAttributes in interface ExternalProcessorOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The requestAttributes at the given index.

      • getRequestAttributesBytes

        public com.google.protobuf.ByteString getRequestAttributesBytes​(int index)
         [#not-implemented-hide:]
 Envoy provides a number of :ref:`attributes <arch_overview_attributes>`
 for expressive policies. Each attribute name provided in this field will be
 matched against that list and populated in the request_headers message.
 See the :ref:`attribute documentation <arch_overview_request_attributes>`
 for the list of supported attributes and their types.
        repeated string request_attributes = 5;
        Specified by:
        getRequestAttributesBytes in interface ExternalProcessorOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the requestAttributes at the given index.

      • getResponseAttributesList

        public com.google.protobuf.ProtocolStringList getResponseAttributesList()
         [#not-implemented-hide:]
 Envoy provides a number of :ref:`attributes <arch_overview_attributes>`
 for expressive policies. Each attribute name provided in this field will be
 matched against that list and populated in the response_headers message.
 See the :ref:`attribute documentation <arch_overview_attributes>`
 for the list of supported attributes and their types.
        repeated string response_attributes = 6;
        Specified by:
        getResponseAttributesList in interface ExternalProcessorOrBuilder
        Returns:
        A list containing the responseAttributes.

      • getResponseAttributesCount

        public int getResponseAttributesCount()
         [#not-implemented-hide:]
 Envoy provides a number of :ref:`attributes <arch_overview_attributes>`
 for expressive policies. Each attribute name provided in this field will be
 matched against that list and populated in the response_headers message.
 See the :ref:`attribute documentation <arch_overview_attributes>`
 for the list of supported attributes and their types.
        repeated string response_attributes = 6;
        Specified by:
        getResponseAttributesCount in interface ExternalProcessorOrBuilder
        Returns:
        The count of responseAttributes.

      • getResponseAttributes

        public String getResponseAttributes​(int index)
         [#not-implemented-hide:]
 Envoy provides a number of :ref:`attributes <arch_overview_attributes>`
 for expressive policies. Each attribute name provided in this field will be
 matched against that list and populated in the response_headers message.
 See the :ref:`attribute documentation <arch_overview_attributes>`
 for the list of supported attributes and their types.
        repeated string response_attributes = 6;
        Specified by:
        getResponseAttributes in interface ExternalProcessorOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The responseAttributes at the given index.

      • getResponseAttributesBytes

        public com.google.protobuf.ByteString getResponseAttributesBytes​(int index)
         [#not-implemented-hide:]
 Envoy provides a number of :ref:`attributes <arch_overview_attributes>`
 for expressive policies. Each attribute name provided in this field will be
 matched against that list and populated in the response_headers message.
 See the :ref:`attribute documentation <arch_overview_attributes>`
 for the list of supported attributes and their types.
        repeated string response_attributes = 6;
        Specified by:
        getResponseAttributesBytes in interface ExternalProcessorOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the responseAttributes at the given index.

      • hasMessageTimeout

        public boolean hasMessageTimeout()
         Specifies the timeout for each individual message sent on the stream and
 when the filter is running in synchronous mode. Whenever the proxy sends
 a message on the stream that requires a response, it will reset this timer,
 and will stop processing and return an error (subject to the processing mode)
 if the timer expires before a matching response is received. There is no
 timeout when the filter is running in asynchronous mode. Zero is a valid
 config which means the timer will be triggered immediately. If not
 configured, default is 200 milliseconds.
        .google.protobuf.Duration message_timeout = 7 [(.validate.rules) = { ... }
        Specified by:
        hasMessageTimeout in interface ExternalProcessorOrBuilder
        Returns:
        Whether the messageTimeout field is set.

      • getMessageTimeout

        public com.google.protobuf.Duration getMessageTimeout()
         Specifies the timeout for each individual message sent on the stream and
 when the filter is running in synchronous mode. Whenever the proxy sends
 a message on the stream that requires a response, it will reset this timer,
 and will stop processing and return an error (subject to the processing mode)
 if the timer expires before a matching response is received. There is no
 timeout when the filter is running in asynchronous mode. Zero is a valid
 config which means the timer will be triggered immediately. If not
 configured, default is 200 milliseconds.
        .google.protobuf.Duration message_timeout = 7 [(.validate.rules) = { ... }
        Specified by:
        getMessageTimeout in interface ExternalProcessorOrBuilder
        Returns:
        The messageTimeout.

      • getMessageTimeoutOrBuilder

        public com.google.protobuf.DurationOrBuilder getMessageTimeoutOrBuilder()
         Specifies the timeout for each individual message sent on the stream and
 when the filter is running in synchronous mode. Whenever the proxy sends
 a message on the stream that requires a response, it will reset this timer,
 and will stop processing and return an error (subject to the processing mode)
 if the timer expires before a matching response is received. There is no
 timeout when the filter is running in asynchronous mode. Zero is a valid
 config which means the timer will be triggered immediately. If not
 configured, default is 200 milliseconds.
        .google.protobuf.Duration message_timeout = 7 [(.validate.rules) = { ... }
        Specified by:
        getMessageTimeoutOrBuilder in interface ExternalProcessorOrBuilder

      • getStatPrefix

        public String getStatPrefix()
         Optional additional prefix to use when emitting statistics. This allows to distinguish
 emitted statistics between configured *ext_proc* filters in an HTTP filter chain.
        string stat_prefix = 8;
        Specified by:
        getStatPrefix in interface ExternalProcessorOrBuilder
        Returns:
        The statPrefix.

      • getStatPrefixBytes

        public com.google.protobuf.ByteString getStatPrefixBytes()
         Optional additional prefix to use when emitting statistics. This allows to distinguish
 emitted statistics between configured *ext_proc* filters in an HTTP filter chain.
        string stat_prefix = 8;
        Specified by:
        getStatPrefixBytes in interface ExternalProcessorOrBuilder
        Returns:
        The bytes for statPrefix.

      • hasMutationRules

        public boolean hasMutationRules()
         Rules that determine what modifications an external processing server may
 make to message headers. If not set, all headers may be modified except
 for "host", ":authority", ":scheme", ":method", and headers that start
 with the header prefix set via
 :ref:`header_prefix <envoy_v3_api_field_config.bootstrap.v3.Bootstrap.header_prefix>`
 (which is usually "x-envoy").
 Note that changing headers such as "host" or ":authority" may not in itself
 change Envoy's routing decision, as routes can be cached. To also force the
 route to be recomputed, set the
 :ref:`clear_route_cache <envoy_v3_api_field_service.ext_proc.v3.CommonResponse.clear_route_cache>`
 field to true in the same response.
        .envoy.config.common.mutation_rules.v3.HeaderMutationRules mutation_rules = 9;
        Specified by:
        hasMutationRules in interface ExternalProcessorOrBuilder
        Returns:
        Whether the mutationRules field is set.

      • getMutationRules

        public HeaderMutationRules getMutationRules()
         Rules that determine what modifications an external processing server may
 make to message headers. If not set, all headers may be modified except
 for "host", ":authority", ":scheme", ":method", and headers that start
 with the header prefix set via
 :ref:`header_prefix <envoy_v3_api_field_config.bootstrap.v3.Bootstrap.header_prefix>`
 (which is usually "x-envoy").
 Note that changing headers such as "host" or ":authority" may not in itself
 change Envoy's routing decision, as routes can be cached. To also force the
 route to be recomputed, set the
 :ref:`clear_route_cache <envoy_v3_api_field_service.ext_proc.v3.CommonResponse.clear_route_cache>`
 field to true in the same response.
        .envoy.config.common.mutation_rules.v3.HeaderMutationRules mutation_rules = 9;
        Specified by:
        getMutationRules in interface ExternalProcessorOrBuilder
        Returns:
        The mutationRules.

      • getMutationRulesOrBuilder

        public HeaderMutationRulesOrBuilder getMutationRulesOrBuilder()
         Rules that determine what modifications an external processing server may
 make to message headers. If not set, all headers may be modified except
 for "host", ":authority", ":scheme", ":method", and headers that start
 with the header prefix set via
 :ref:`header_prefix <envoy_v3_api_field_config.bootstrap.v3.Bootstrap.header_prefix>`
 (which is usually "x-envoy").
 Note that changing headers such as "host" or ":authority" may not in itself
 change Envoy's routing decision, as routes can be cached. To also force the
 route to be recomputed, set the
 :ref:`clear_route_cache <envoy_v3_api_field_service.ext_proc.v3.CommonResponse.clear_route_cache>`
 field to true in the same response.
        .envoy.config.common.mutation_rules.v3.HeaderMutationRules mutation_rules = 9;
        Specified by:
        getMutationRulesOrBuilder in interface ExternalProcessorOrBuilder

      • hasMaxMessageTimeout

        public boolean hasMaxMessageTimeout()
         Specify the upper bound of
 :ref:`override_message_timeout <envoy_v3_api_field_service.ext_proc.v3.ProcessingResponse.override_message_timeout>`
 If not specified, by default it is 0, which will effectively disable the ``override_message_timeout`` API.
        .google.protobuf.Duration max_message_timeout = 10 [(.validate.rules) = { ... }
        Specified by:
        hasMaxMessageTimeout in interface ExternalProcessorOrBuilder
        Returns:
        Whether the maxMessageTimeout field is set.

      • getMaxMessageTimeout

        public com.google.protobuf.Duration getMaxMessageTimeout()
         Specify the upper bound of
 :ref:`override_message_timeout <envoy_v3_api_field_service.ext_proc.v3.ProcessingResponse.override_message_timeout>`
 If not specified, by default it is 0, which will effectively disable the ``override_message_timeout`` API.
        .google.protobuf.Duration max_message_timeout = 10 [(.validate.rules) = { ... }
        Specified by:
        getMaxMessageTimeout in interface ExternalProcessorOrBuilder
        Returns:
        The maxMessageTimeout.

      • getMaxMessageTimeoutOrBuilder

        public com.google.protobuf.DurationOrBuilder getMaxMessageTimeoutOrBuilder()
         Specify the upper bound of
 :ref:`override_message_timeout <envoy_v3_api_field_service.ext_proc.v3.ProcessingResponse.override_message_timeout>`
 If not specified, by default it is 0, which will effectively disable the ``override_message_timeout`` API.
        .google.protobuf.Duration max_message_timeout = 10 [(.validate.rules) = { ... }
        Specified by:
        getMaxMessageTimeoutOrBuilder in interface ExternalProcessorOrBuilder

      • getDisableClearRouteCache

        public boolean getDisableClearRouteCache()
         Prevents clearing the route-cache when the
 :ref:`clear_route_cache <envoy_v3_api_field_service.ext_proc.v3.CommonResponse.clear_route_cache>`
 field is set in an external processor response.
        bool disable_clear_route_cache = 11;
        Specified by:
        getDisableClearRouteCache in interface ExternalProcessorOrBuilder
        Returns:
        The disableClearRouteCache.

      • hasForwardRules

        public boolean hasForwardRules()
         Allow headers matching the ``forward_rules`` to be forwarded to the external processing server.
 If not set, all headers are forwarded to the external processing server.
        .envoy.extensions.filters.http.ext_proc.v3.HeaderForwardingRules forward_rules = 12;
        Specified by:
        hasForwardRules in interface ExternalProcessorOrBuilder
        Returns:
        Whether the forwardRules field is set.

      • getForwardRules

        public HeaderForwardingRules getForwardRules()
         Allow headers matching the ``forward_rules`` to be forwarded to the external processing server.
 If not set, all headers are forwarded to the external processing server.
        .envoy.extensions.filters.http.ext_proc.v3.HeaderForwardingRules forward_rules = 12;
        Specified by:
        getForwardRules in interface ExternalProcessorOrBuilder
        Returns:
        The forwardRules.

      • getForwardRulesOrBuilder

        public HeaderForwardingRulesOrBuilder getForwardRulesOrBuilder()
         Allow headers matching the ``forward_rules`` to be forwarded to the external processing server.
 If not set, all headers are forwarded to the external processing server.
        .envoy.extensions.filters.http.ext_proc.v3.HeaderForwardingRules forward_rules = 12;
        Specified by:
        getForwardRulesOrBuilder in interface ExternalProcessorOrBuilder

      • hasFilterMetadata

        public boolean hasFilterMetadata()
         Additional metadata to be added to the filter state for logging purposes. The metadata
 will be added to StreamInfo's filter state under the namespace corresponding to the
 ext_proc filter name.
        .google.protobuf.Struct filter_metadata = 13;
        Specified by:
        hasFilterMetadata in interface ExternalProcessorOrBuilder
        Returns:
        Whether the filterMetadata field is set.

      • getFilterMetadata

        public com.google.protobuf.Struct getFilterMetadata()
         Additional metadata to be added to the filter state for logging purposes. The metadata
 will be added to StreamInfo's filter state under the namespace corresponding to the
 ext_proc filter name.
        .google.protobuf.Struct filter_metadata = 13;
        Specified by:
        getFilterMetadata in interface ExternalProcessorOrBuilder
        Returns:
        The filterMetadata.

      • getFilterMetadataOrBuilder

        public com.google.protobuf.StructOrBuilder getFilterMetadataOrBuilder()
         Additional metadata to be added to the filter state for logging purposes. The metadata
 will be added to StreamInfo's filter state under the namespace corresponding to the
 ext_proc filter name.
        .google.protobuf.Struct filter_metadata = 13;
        Specified by:
        getFilterMetadataOrBuilder in interface ExternalProcessorOrBuilder

      • getAllowModeOverride

        public boolean getAllowModeOverride()
         If ``allow_mode_override`` is set to true, the filter config :ref:`processing_mode
 <envoy_v3_api_field_extensions.filters.http.ext_proc.v3.ExternalProcessor.processing_mode>`
 can be overridden by the response message from the external processing server
 :ref:`mode_override <envoy_v3_api_field_service.ext_proc.v3.ProcessingResponse.mode_override>`.
 If not set, ``mode_override`` API in the response message will be ignored.
        bool allow_mode_override = 14;
        Specified by:
        getAllowModeOverride in interface ExternalProcessorOrBuilder
        Returns:
        The allowModeOverride.

      • getDisableImmediateResponse

        public boolean getDisableImmediateResponse()
         If set to true, ignore the
 :ref:`immediate_response <envoy_v3_api_field_service.ext_proc.v3.ProcessingResponse.immediate_response>`
 message in an external processor response. In such case, no local reply will be sent.
 Instead, the stream to the external processor will be closed. There will be no
 more external processing for this stream from now on.
        bool disable_immediate_response = 15;
        Specified by:
        getDisableImmediateResponse in interface ExternalProcessorOrBuilder
        Returns:
        The disableImmediateResponse.

      • 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 ExternalProcessor parseFrom​(ByteBuffer data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ExternalProcessor parseFrom​(ByteBuffer data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ExternalProcessor parseFrom​(com.google.protobuf.ByteString data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ExternalProcessor parseFrom​(com.google.protobuf.ByteString data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ExternalProcessor parseFrom​(byte[] data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ExternalProcessor parseFrom​(byte[] data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ExternalProcessor parseFrom​(com.google.protobuf.CodedInputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws IOException
        Throws:
        IOException

      • newBuilderForType

        public ExternalProcessor.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public ExternalProcessor.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected ExternalProcessor.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<ExternalProcessor> 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 ExternalProcessor getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder