public final class ExternalProcessor extends com.google.protobuf.GeneratedMessageV3 implements ExternalProcessorOrBuilder
[#next-free-field: 9]Protobuf type
envoy.extensions.filters.http.ext_proc.v3alpha.ExternalProcessor| Modifier and Type | Class and Description |
|---|---|
static class |
ExternalProcessor.Builder
[#next-free-field: 9]
Protobuf type
envoy.extensions.filters.http.ext_proc.v3alpha.ExternalProcessor |
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| Modifier and Type | Field and Description |
|---|---|
static int |
ASYNC_MODE_FIELD_NUMBER |
static int |
FAILURE_MODE_ALLOW_FIELD_NUMBER |
static int |
GRPC_SERVICE_FIELD_NUMBER |
static int |
MESSAGE_TIMEOUT_FIELD_NUMBER |
static int |
PROCESSING_MODE_FIELD_NUMBER |
static int |
REQUEST_ATTRIBUTES_FIELD_NUMBER |
static int |
RESPONSE_ATTRIBUTES_FIELD_NUMBER |
static int |
STAT_PREFIX_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
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 |
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.
|
com.google.protobuf.Parser<ExternalProcessor> |
getParserForType() |
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.
|
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()
[#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.
|
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
boolean |
hasGrpcService()
Configuration for the gRPC service that the filter will communicate with.
|
int |
hashCode() |
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.
|
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(ByteBuffer data) |
static ExternalProcessor |
parseFrom(ByteBuffer 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 com.google.protobuf.Parser<ExternalProcessor> |
parser() |
ExternalProcessor.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
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, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int GRPC_SERVICE_FIELD_NUMBER
public static final int FAILURE_MODE_ALLOW_FIELD_NUMBER
public static final int PROCESSING_MODE_FIELD_NUMBER
public static final int ASYNC_MODE_FIELD_NUMBER
public static final int REQUEST_ATTRIBUTES_FIELD_NUMBER
public static final int RESPONSE_ATTRIBUTES_FIELD_NUMBER
public static final int MESSAGE_TIMEOUT_FIELD_NUMBER
public static final int STAT_PREFIX_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields in interface com.google.protobuf.MessageOrBuildergetUnknownFields in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public 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;hasGrpcService in interface ExternalProcessorOrBuilderpublic 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;getGrpcService in interface ExternalProcessorOrBuilderpublic 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;getGrpcServiceOrBuilder in interface ExternalProcessorOrBuilderpublic 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;getFailureModeAllow in interface ExternalProcessorOrBuilderpublic 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;hasProcessingMode in interface ExternalProcessorOrBuilderpublic 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;getProcessingMode in interface ExternalProcessorOrBuilderpublic 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;getProcessingModeOrBuilder in interface ExternalProcessorOrBuilderpublic 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;getAsyncMode in interface ExternalProcessorOrBuilderpublic 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;getRequestAttributesList in interface ExternalProcessorOrBuilderpublic 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;getRequestAttributesCount in interface ExternalProcessorOrBuilderpublic 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;getRequestAttributes in interface ExternalProcessorOrBuilderpublic 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;getRequestAttributesBytes in interface ExternalProcessorOrBuilderpublic 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;getResponseAttributesList in interface ExternalProcessorOrBuilderpublic 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;getResponseAttributesCount in interface ExternalProcessorOrBuilderpublic 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;getResponseAttributes in interface ExternalProcessorOrBuilderpublic 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;getResponseAttributesBytes in interface ExternalProcessorOrBuilderpublic 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;hasMessageTimeout in interface ExternalProcessorOrBuilderpublic 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;getMessageTimeout in interface ExternalProcessorOrBuilderpublic 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;getMessageTimeoutOrBuilder in interface ExternalProcessorOrBuilderpublic 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;getStatPrefix in interface ExternalProcessorOrBuilderpublic 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;getStatPrefixBytes in interface ExternalProcessorOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static ExternalProcessor parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ExternalProcessor parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ExternalProcessor parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ExternalProcessor parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ExternalProcessor parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ExternalProcessor parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ExternalProcessor parseFrom(InputStream input) throws IOException
IOExceptionpublic static ExternalProcessor parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static ExternalProcessor parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static ExternalProcessor parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static ExternalProcessor parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static ExternalProcessor parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic ExternalProcessor.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static ExternalProcessor.Builder newBuilder()
public static ExternalProcessor.Builder newBuilder(ExternalProcessor prototype)
public ExternalProcessor.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected ExternalProcessor.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static ExternalProcessor getDefaultInstance()
public static com.google.protobuf.Parser<ExternalProcessor> parser()
public com.google.protobuf.Parser<ExternalProcessor> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public ExternalProcessor getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2018–2021 The Envoy Project. All rights reserved.