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

Interface LuaPerRouteOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
LuaPerRoute, LuaPerRoute.Builder
public interface LuaPerRouteOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    getDisabled()
    Disable the Lua filter for this particular vhost or route.
    com.google.protobuf.Struct
    getFilterContext()
    Optional filter context for Lua script.
    com.google.protobuf.StructOrBuilder
    getFilterContextOrBuilder()
    Optional filter context for Lua script.
    String
    getName()
    A name of a Lua source code stored in :ref:`Lua.source_codes <envoy_v3_api_field_extensions.filters.http.lua.v3.Lua.source_codes>`.
    com.google.protobuf.ByteString
    getNameBytes()
    A name of a Lua source code stored in :ref:`Lua.source_codes <envoy_v3_api_field_extensions.filters.http.lua.v3.Lua.source_codes>`.
    LuaPerRoute.OverrideCase
    getOverrideCase()
     
    DataSource
    getSourceCode()
    A configured per-route Lua source code that can be served by RDS or provided inline.
    DataSourceOrBuilder
    getSourceCodeOrBuilder()
    A configured per-route Lua source code that can be served by RDS or provided inline.
    boolean
    hasDisabled()
    Disable the Lua filter for this particular vhost or route.
    boolean
    hasFilterContext()
    Optional filter context for Lua script.
    boolean
    hasName()
    A name of a Lua source code stored in :ref:`Lua.source_codes <envoy_v3_api_field_extensions.filters.http.lua.v3.Lua.source_codes>`.
    boolean
    hasSourceCode()
    A configured per-route Lua source code that can be served by RDS or provided inline.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • hasDisabled

      boolean hasDisabled()
       Disable the Lua filter for this particular vhost or route. If disabled is specified in
 multiple per-filter-configs, the most specific one will be used.
      bool disabled = 1 [(.validate.rules) = { ... }
      Returns:
      Whether the disabled field is set.

    • getDisabled

      boolean getDisabled()
       Disable the Lua filter for this particular vhost or route. If disabled is specified in
 multiple per-filter-configs, the most specific one will be used.
      bool disabled = 1 [(.validate.rules) = { ... }
      Returns:
      The disabled.

    • hasName

      boolean hasName()
       A name of a Lua source code stored in
 :ref:`Lua.source_codes <envoy_v3_api_field_extensions.filters.http.lua.v3.Lua.source_codes>`.
      string name = 2 [(.validate.rules) = { ... }
      Returns:
      Whether the name field is set.

    • getName

      String getName()
       A name of a Lua source code stored in
 :ref:`Lua.source_codes <envoy_v3_api_field_extensions.filters.http.lua.v3.Lua.source_codes>`.
      string name = 2 [(.validate.rules) = { ... }
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       A name of a Lua source code stored in
 :ref:`Lua.source_codes <envoy_v3_api_field_extensions.filters.http.lua.v3.Lua.source_codes>`.
      string name = 2 [(.validate.rules) = { ... }
      Returns:
      The bytes for name.

    • hasSourceCode

      boolean hasSourceCode()
       A configured per-route Lua source code that can be served by RDS or provided inline.
      .envoy.config.core.v3.DataSource source_code = 3;
      Returns:
      Whether the sourceCode field is set.

    • getSourceCode

      DataSource getSourceCode()
       A configured per-route Lua source code that can be served by RDS or provided inline.
      .envoy.config.core.v3.DataSource source_code = 3;
      Returns:
      The sourceCode.

    • getSourceCodeOrBuilder

      DataSourceOrBuilder getSourceCodeOrBuilder()
       A configured per-route Lua source code that can be served by RDS or provided inline.
      .envoy.config.core.v3.DataSource source_code = 3;

    • hasFilterContext

      boolean hasFilterContext()
       Optional filter context for Lua script. This could be used to pass configuration
 to Lua script. The Lua script can access the filter context using ``handle:filterContext()``.
 For example:

 .. code-block:: lua

   function envoy_on_request(request_handle)
     local filter_context = request_handle:filterContext()
     local filter_context_value = filter_context["key"]
     -- Do something with filter_context_value.
   end
      .google.protobuf.Struct filter_context = 4;
      Returns:
      Whether the filterContext field is set.

    • getFilterContext

      com.google.protobuf.Struct getFilterContext()
       Optional filter context for Lua script. This could be used to pass configuration
 to Lua script. The Lua script can access the filter context using ``handle:filterContext()``.
 For example:

 .. code-block:: lua

   function envoy_on_request(request_handle)
     local filter_context = request_handle:filterContext()
     local filter_context_value = filter_context["key"]
     -- Do something with filter_context_value.
   end
      .google.protobuf.Struct filter_context = 4;
      Returns:
      The filterContext.

    • getFilterContextOrBuilder

      com.google.protobuf.StructOrBuilder getFilterContextOrBuilder()
       Optional filter context for Lua script. This could be used to pass configuration
 to Lua script. The Lua script can access the filter context using ``handle:filterContext()``.
 For example:

 .. code-block:: lua

   function envoy_on_request(request_handle)
     local filter_context = request_handle:filterContext()
     local filter_context_value = filter_context["key"]
     -- Do something with filter_context_value.
   end
      .google.protobuf.Struct filter_context = 4;

    • getOverrideCase

      LuaPerRoute.OverrideCase getOverrideCase()