io.envoyproxy.envoy.extensions.filters.http.ext_proc.v3alpha

Interface ExternalProcessorOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ExternalProcessor, ExternalProcessor.Builder

public interface ExternalProcessorOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
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.
boolean	getFailureModeAllow() [#not-implemented-hide:] By default, if the gRPC stream cannot be established, or if it is closed prematurely with an error, the filter will fail.
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	getMessageTimeout() [#not-implemented-hide:] 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() [#not-implemented-hide:] Specifies the timeout for each individual message sent on the stream and when the filter is running in synchronous mode.
ProcessingMode	getProcessingMode() [#not-implemented-hide:] Specifies default options for how HTTP headers, trailers, and bodies are sent.
ProcessingModeOrBuilder	getProcessingModeOrBuilder() [#not-implemented-hide:] 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.
List<String>	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.
List<String>	getResponseAttributesList() [#not-implemented-hide:] Envoy provides a number of :ref:`attributes <arch_overview_attributes>` for expressive policies.
String	getStatPrefix() [#not-implemented-hide:] Optional additional prefix to use when emitting statistics.
com.google.protobuf.ByteString	getStatPrefixBytes() [#not-implemented-hide:] Optional additional prefix to use when emitting statistics.
boolean	hasGrpcService() Configuration for the gRPC service that the filter will communicate with.
boolean	hasMessageTimeout() [#not-implemented-hide:] Specifies the timeout for each individual message sent on the stream and when the filter is running in synchronous mode.
boolean	hasProcessingMode() [#not-implemented-hide:] Specifies default options for how HTTP headers, trailers, and bodies are sent.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasGrpcService

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;

getGrpcService

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;

getGrpcServiceOrBuilder

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;

getFailureModeAllow

boolean getFailureModeAllow()

 [#not-implemented-hide:]
 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;

hasProcessingMode

boolean hasProcessingMode()

 [#not-implemented-hide:]
 Specifies default options for how HTTP headers, trailers, and bodies are
 sent. See ProcessingMode for details.
 

.envoy.extensions.filters.http.ext_proc.v3alpha.ProcessingMode processing_mode = 3;

getProcessingMode

ProcessingMode getProcessingMode()

 [#not-implemented-hide:]
 Specifies default options for how HTTP headers, trailers, and bodies are
 sent. See ProcessingMode for details.
 

.envoy.extensions.filters.http.ext_proc.v3alpha.ProcessingMode processing_mode = 3;

getProcessingModeOrBuilder

ProcessingModeOrBuilder getProcessingModeOrBuilder()

 [#not-implemented-hide:]
 Specifies default options for how HTTP headers, trailers, and bodies are
 sent. See ProcessingMode for details.
 

.envoy.extensions.filters.http.ext_proc.v3alpha.ProcessingMode processing_mode = 3;

getAsyncMode

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;

getRequestAttributesList

List<String> 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;

getRequestAttributesCount

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;

getRequestAttributes

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;

getRequestAttributesBytes

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;

getResponseAttributesList

List<String> 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;

getResponseAttributesCount

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;

getResponseAttributes

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;

getResponseAttributesBytes

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;

hasMessageTimeout

boolean hasMessageTimeout()

 [#not-implemented-hide:]
 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. There is no timeout when
 the filter is running in asynchronous mode. Default is 200 ms.
 

.google.protobuf.Duration message_timeout = 7;

getMessageTimeout

com.google.protobuf.Duration getMessageTimeout()

 [#not-implemented-hide:]
 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. There is no timeout when
 the filter is running in asynchronous mode. Default is 200 ms.
 

.google.protobuf.Duration message_timeout = 7;

getMessageTimeoutOrBuilder

com.google.protobuf.DurationOrBuilder getMessageTimeoutOrBuilder()

 [#not-implemented-hide:]
 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. There is no timeout when
 the filter is running in asynchronous mode. Default is 200 ms.
 

.google.protobuf.Duration message_timeout = 7;

getStatPrefix

String getStatPrefix()

 [#not-implemented-hide:]
 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;

getStatPrefixBytes

com.google.protobuf.ByteString getStatPrefixBytes()

 [#not-implemented-hide:]
 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;