Class Lua
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.filters.http.lua.v3.Lua
- All Implemented Interfaces:
com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,LuaOrBuilder,Serializable
[#next-free-field: 6]Protobuf type
envoy.extensions.filters.http.lua.v3.Lua- See Also:
-
Nested Class Summary
Nested ClassesNested 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 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 TypeMethodDescriptionbooleanMap of named Lua source codes that can be referenced in :ref:`LuaPerRoute <envoy_v3_api_msg_extensions.filters.http.lua.v3.LuaPerRoute>`.booleancom.google.protobuf.BoolValueIf set to true, the Lua filter will clear the route cache automatically if the request headers are modified by the Lua script.com.google.protobuf.BoolValueOrBuilderIf set to true, the Lua filter will clear the route cache automatically if the request headers are modified by the Lua script.static LuaThe default Lua code that Envoy will execute.The default Lua code that Envoy will execute.static final com.google.protobuf.Descriptors.DescriptorDeprecated.envoy.extensions.filters.http.lua.v3.Lua.inline_code is deprecated.com.google.protobuf.ByteStringDeprecated.envoy.extensions.filters.http.lua.v3.Lua.inline_code is deprecated.com.google.protobuf.Parser<Lua>intDeprecated.intMap of named Lua source codes that can be referenced in :ref:`LuaPerRoute <envoy_v3_api_msg_extensions.filters.http.lua.v3.LuaPerRoute>`.Map of named Lua source codes that can be referenced in :ref:`LuaPerRoute <envoy_v3_api_msg_extensions.filters.http.lua.v3.LuaPerRoute>`.getSourceCodesOrDefault(String key, DataSource defaultValue) Map of named Lua source codes that can be referenced in :ref:`LuaPerRoute <envoy_v3_api_msg_extensions.filters.http.lua.v3.LuaPerRoute>`.Map of named Lua source codes that can be referenced in :ref:`LuaPerRoute <envoy_v3_api_msg_extensions.filters.http.lua.v3.LuaPerRoute>`.Optional additional prefix to use when emitting statistics.com.google.protobuf.ByteStringOptional additional prefix to use when emitting statistics.booleanIf set to true, the Lua filter will clear the route cache automatically if the request headers are modified by the Lua script.booleanThe default Lua code that Envoy will execute.inthashCode()protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTableprotected com.google.protobuf.MapFieldReflectionAccessorinternalGetMapFieldReflection(int number) final booleanstatic Lua.Builderstatic Lua.BuildernewBuilder(Lua prototype) protected Lua.BuildernewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) protected ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) static LuaparseDelimitedFrom(InputStream input) static LuaparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static LuaparseFrom(byte[] data) static LuaparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static LuaparseFrom(com.google.protobuf.ByteString data) static LuaparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static LuaparseFrom(com.google.protobuf.CodedInputStream input) static LuaparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static LuaparseFrom(InputStream input) static LuaparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static LuaparseFrom(ByteBuffer data) static LuaparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<Lua>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, 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
-
INLINE_CODE_FIELD_NUMBER
public static final int INLINE_CODE_FIELD_NUMBER- See Also:
-
SOURCE_CODES_FIELD_NUMBER
public static final int SOURCE_CODES_FIELD_NUMBER- See Also:
-
DEFAULT_SOURCE_CODE_FIELD_NUMBER
public static final int DEFAULT_SOURCE_CODE_FIELD_NUMBER- See Also:
-
STAT_PREFIX_FIELD_NUMBER
public static final int STAT_PREFIX_FIELD_NUMBER- See Also:
-
CLEAR_ROUTE_CACHE_FIELD_NUMBER
public static final int CLEAR_ROUTE_CACHE_FIELD_NUMBER- See Also:
-
-
Method Details
-
newInstance
- Overrides:
newInstancein classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetMapFieldReflection
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number) - Overrides:
internalGetMapFieldReflectionin classcom.google.protobuf.GeneratedMessageV3
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3
-
getInlineCode
Deprecated.envoy.extensions.filters.http.lua.v3.Lua.inline_code is deprecated. See envoy/extensions/filters/http/lua/v3/lua.proto;l=39The Lua code that Envoy will execute. This can be a very small script that further loads code from disk if desired. Note that if JSON configuration is used, the code must be properly escaped. YAML configuration may be easier to read since YAML supports multi-line strings so complex scripts can be easily expressed inline in the configuration. This field is deprecated. Please use :ref:`default_source_code <envoy_v3_api_field_extensions.filters.http.lua.v3.Lua.default_source_code>`. Only one of :ref:`inline_code <envoy_v3_api_field_extensions.filters.http.lua.v3.Lua.inline_code>` or :ref:`default_source_code <envoy_v3_api_field_extensions.filters.http.lua.v3.Lua.default_source_code>` can be set for the Lua filter.
string inline_code = 1 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];- Specified by:
getInlineCodein interfaceLuaOrBuilder- Returns:
- The inlineCode.
-
getInlineCodeBytes
Deprecated.envoy.extensions.filters.http.lua.v3.Lua.inline_code is deprecated. See envoy/extensions/filters/http/lua/v3/lua.proto;l=39The Lua code that Envoy will execute. This can be a very small script that further loads code from disk if desired. Note that if JSON configuration is used, the code must be properly escaped. YAML configuration may be easier to read since YAML supports multi-line strings so complex scripts can be easily expressed inline in the configuration. This field is deprecated. Please use :ref:`default_source_code <envoy_v3_api_field_extensions.filters.http.lua.v3.Lua.default_source_code>`. Only one of :ref:`inline_code <envoy_v3_api_field_extensions.filters.http.lua.v3.Lua.inline_code>` or :ref:`default_source_code <envoy_v3_api_field_extensions.filters.http.lua.v3.Lua.default_source_code>` can be set for the Lua filter.
string inline_code = 1 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];- Specified by:
getInlineCodeBytesin interfaceLuaOrBuilder- Returns:
- The bytes for inlineCode.
-
getSourceCodesCount
public int getSourceCodesCount()Description copied from interface:LuaOrBuilderMap of named Lua source codes that can be referenced in :ref:`LuaPerRoute <envoy_v3_api_msg_extensions.filters.http.lua.v3.LuaPerRoute>`. The Lua source codes can be loaded from inline string or local files. Example: .. code-block:: yaml source_codes: hello.lua: inline_string: | function envoy_on_response(response_handle) -- Do something. end world.lua: filename: /etc/lua/world.luamap<string, .envoy.config.core.v3.DataSource> source_codes = 2;- Specified by:
getSourceCodesCountin interfaceLuaOrBuilder
-
containsSourceCodes
Map of named Lua source codes that can be referenced in :ref:`LuaPerRoute <envoy_v3_api_msg_extensions.filters.http.lua.v3.LuaPerRoute>`. The Lua source codes can be loaded from inline string or local files. Example: .. code-block:: yaml source_codes: hello.lua: inline_string: | function envoy_on_response(response_handle) -- Do something. end world.lua: filename: /etc/lua/world.luamap<string, .envoy.config.core.v3.DataSource> source_codes = 2;- Specified by:
containsSourceCodesin interfaceLuaOrBuilder
-
getSourceCodes
Deprecated.UsegetSourceCodesMap()instead.- Specified by:
getSourceCodesin interfaceLuaOrBuilder
-
getSourceCodesMap
Map of named Lua source codes that can be referenced in :ref:`LuaPerRoute <envoy_v3_api_msg_extensions.filters.http.lua.v3.LuaPerRoute>`. The Lua source codes can be loaded from inline string or local files. Example: .. code-block:: yaml source_codes: hello.lua: inline_string: | function envoy_on_response(response_handle) -- Do something. end world.lua: filename: /etc/lua/world.luamap<string, .envoy.config.core.v3.DataSource> source_codes = 2;- Specified by:
getSourceCodesMapin interfaceLuaOrBuilder
-
getSourceCodesOrDefault
Map of named Lua source codes that can be referenced in :ref:`LuaPerRoute <envoy_v3_api_msg_extensions.filters.http.lua.v3.LuaPerRoute>`. The Lua source codes can be loaded from inline string or local files. Example: .. code-block:: yaml source_codes: hello.lua: inline_string: | function envoy_on_response(response_handle) -- Do something. end world.lua: filename: /etc/lua/world.luamap<string, .envoy.config.core.v3.DataSource> source_codes = 2;- Specified by:
getSourceCodesOrDefaultin interfaceLuaOrBuilder
-
getSourceCodesOrThrow
Map of named Lua source codes that can be referenced in :ref:`LuaPerRoute <envoy_v3_api_msg_extensions.filters.http.lua.v3.LuaPerRoute>`. The Lua source codes can be loaded from inline string or local files. Example: .. code-block:: yaml source_codes: hello.lua: inline_string: | function envoy_on_response(response_handle) -- Do something. end world.lua: filename: /etc/lua/world.luamap<string, .envoy.config.core.v3.DataSource> source_codes = 2;- Specified by:
getSourceCodesOrThrowin interfaceLuaOrBuilder
-
hasDefaultSourceCode
public boolean hasDefaultSourceCode()The default Lua code that Envoy will execute. If no per route config is provided for the request, this Lua code will be applied.
.envoy.config.core.v3.DataSource default_source_code = 3;- Specified by:
hasDefaultSourceCodein interfaceLuaOrBuilder- Returns:
- Whether the defaultSourceCode field is set.
-
getDefaultSourceCode
The default Lua code that Envoy will execute. If no per route config is provided for the request, this Lua code will be applied.
.envoy.config.core.v3.DataSource default_source_code = 3;- Specified by:
getDefaultSourceCodein interfaceLuaOrBuilder- Returns:
- The defaultSourceCode.
-
getDefaultSourceCodeOrBuilder
The default Lua code that Envoy will execute. If no per route config is provided for the request, this Lua code will be applied.
.envoy.config.core.v3.DataSource default_source_code = 3;- Specified by:
getDefaultSourceCodeOrBuilderin interfaceLuaOrBuilder
-
getStatPrefix
Optional additional prefix to use when emitting statistics. By default metrics are emitted in *.lua.* namespace. If multiple lua filters are configured in a filter chain, the stats from each filter instance can be emitted using custom stat prefix to distinguish emitted statistics. For example: .. code-block:: yaml http_filters: - name: envoy.filters.http.lua typed_config: "@type": type.googleapis.com/envoy.extensions.filters.http.lua.v3.Lua stat_prefix: foo_script # This emits lua.foo_script.errors etc. - name: envoy.filters.http.lua typed_config: "@type": type.googleapis.com/envoy.extensions.filters.http.lua.v3.Lua stat_prefix: bar_script # This emits lua.bar_script.errors etc.string stat_prefix = 4;- Specified by:
getStatPrefixin interfaceLuaOrBuilder- Returns:
- The statPrefix.
-
getStatPrefixBytes
public com.google.protobuf.ByteString getStatPrefixBytes()Optional additional prefix to use when emitting statistics. By default metrics are emitted in *.lua.* namespace. If multiple lua filters are configured in a filter chain, the stats from each filter instance can be emitted using custom stat prefix to distinguish emitted statistics. For example: .. code-block:: yaml http_filters: - name: envoy.filters.http.lua typed_config: "@type": type.googleapis.com/envoy.extensions.filters.http.lua.v3.Lua stat_prefix: foo_script # This emits lua.foo_script.errors etc. - name: envoy.filters.http.lua typed_config: "@type": type.googleapis.com/envoy.extensions.filters.http.lua.v3.Lua stat_prefix: bar_script # This emits lua.bar_script.errors etc.string stat_prefix = 4;- Specified by:
getStatPrefixBytesin interfaceLuaOrBuilder- Returns:
- The bytes for statPrefix.
-
hasClearRouteCache
public boolean hasClearRouteCache()If set to true, the Lua filter will clear the route cache automatically if the request headers are modified by the Lua script. If set to false, the Lua filter will not clear the route cache automatically. Default is true for backward compatibility.
.google.protobuf.BoolValue clear_route_cache = 5;- Specified by:
hasClearRouteCachein interfaceLuaOrBuilder- Returns:
- Whether the clearRouteCache field is set.
-
getClearRouteCache
public com.google.protobuf.BoolValue getClearRouteCache()If set to true, the Lua filter will clear the route cache automatically if the request headers are modified by the Lua script. If set to false, the Lua filter will not clear the route cache automatically. Default is true for backward compatibility.
.google.protobuf.BoolValue clear_route_cache = 5;- Specified by:
getClearRouteCachein interfaceLuaOrBuilder- Returns:
- The clearRouteCache.
-
getClearRouteCacheOrBuilder
public com.google.protobuf.BoolValueOrBuilder getClearRouteCacheOrBuilder()If set to true, the Lua filter will clear the route cache automatically if the request headers are modified by the Lua script. If set to false, the Lua filter will not clear the route cache automatically. Default is true for backward compatibility.
.google.protobuf.BoolValue clear_route_cache = 5;- Specified by:
getClearRouteCacheOrBuilderin interfaceLuaOrBuilder
-
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 Lua parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Lua parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Lua parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Lua parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Lua parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static Lua parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static Lua parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static Lua 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 Lua.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
-