Package io.envoyproxy.envoy.extensions.wasm.v3

Interface PluginConfigOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    PluginConfig, PluginConfig.Builder
    public interface PluginConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      CapabilityRestrictionConfig getCapabilityRestrictionConfig()
      Configuration for restricting Proxy-Wasm capabilities available to modules.
      CapabilityRestrictionConfigOrBuilder getCapabilityRestrictionConfigOrBuilder()
      Configuration for restricting Proxy-Wasm capabilities available to modules.
      com.google.protobuf.Any getConfiguration()
      Filter/service configuration used to configure or reconfigure a plugin (``proxy_on_configure``).
      com.google.protobuf.AnyOrBuilder getConfigurationOrBuilder()
      Filter/service configuration used to configure or reconfigure a plugin (``proxy_on_configure``).
      boolean getFailOpen()
      If there is a fatal error on the VM (e.g. exception, abort(), on_start or on_configure return false), then all plugins associated with the VM will either fail closed (by default), e.g. by returning an HTTP 503 error, or fail open (if 'fail_open' is set to true) by bypassing the filter.
      String getName()
      A unique name for a filters/services in a VM for use in identifying the filter/service if multiple filters/services are handled by the same ``vm_id`` and ``root_id`` and for logging/debugging.
      com.google.protobuf.ByteString getNameBytes()
      A unique name for a filters/services in a VM for use in identifying the filter/service if multiple filters/services are handled by the same ``vm_id`` and ``root_id`` and for logging/debugging.
      String getRootId()
      A unique ID for a set of filters/services in a VM which will share a RootContext and Contexts if applicable (e.g. an Wasm HttpFilter and an Wasm AccessLog).
      com.google.protobuf.ByteString getRootIdBytes()
      A unique ID for a set of filters/services in a VM which will share a RootContext and Contexts if applicable (e.g. an Wasm HttpFilter and an Wasm AccessLog).
      PluginConfig.VmCase getVmCase()  
      VmConfig getVmConfig()
      TODO: add referential VM configurations.
      VmConfigOrBuilder getVmConfigOrBuilder()
      TODO: add referential VM configurations.
      boolean hasCapabilityRestrictionConfig()
      Configuration for restricting Proxy-Wasm capabilities available to modules.
      boolean hasConfiguration()
      Filter/service configuration used to configure or reconfigure a plugin (``proxy_on_configure``).
      boolean hasVmConfig()
      TODO: add referential VM configurations.

      • 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 Detail

      • getName

        String getName()
         A unique name for a filters/services in a VM for use in identifying the filter/service if
 multiple filters/services are handled by the same ``vm_id`` and ``root_id`` and for
 logging/debugging.
        string name = 1;
        Returns:
        The name.

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         A unique name for a filters/services in a VM for use in identifying the filter/service if
 multiple filters/services are handled by the same ``vm_id`` and ``root_id`` and for
 logging/debugging.
        string name = 1;
        Returns:
        The bytes for name.

      • getRootId

        String getRootId()
         A unique ID for a set of filters/services in a VM which will share a RootContext and Contexts
 if applicable (e.g. an Wasm HttpFilter and an Wasm AccessLog). If left blank, all
 filters/services with a blank root_id with the same ``vm_id`` will share Context(s).
        string root_id = 2;
        Returns:
        The rootId.

      • getRootIdBytes

        com.google.protobuf.ByteString getRootIdBytes()
         A unique ID for a set of filters/services in a VM which will share a RootContext and Contexts
 if applicable (e.g. an Wasm HttpFilter and an Wasm AccessLog). If left blank, all
 filters/services with a blank root_id with the same ``vm_id`` will share Context(s).
        string root_id = 2;
        Returns:
        The bytes for rootId.

      • hasVmConfig

        boolean hasVmConfig()
         TODO: add referential VM configurations.
        .envoy.extensions.wasm.v3.VmConfig vm_config = 3;
        Returns:
        Whether the vmConfig field is set.

      • getVmConfig

        VmConfig getVmConfig()
         TODO: add referential VM configurations.
        .envoy.extensions.wasm.v3.VmConfig vm_config = 3;
        Returns:
        The vmConfig.

      • getVmConfigOrBuilder

        VmConfigOrBuilder getVmConfigOrBuilder()
         TODO: add referential VM configurations.
        .envoy.extensions.wasm.v3.VmConfig vm_config = 3;

      • hasConfiguration

        boolean hasConfiguration()
         Filter/service configuration used to configure or reconfigure a plugin
 (``proxy_on_configure``).
 ``google.protobuf.Struct`` is serialized as JSON before
 passing it to the plugin. ``google.protobuf.BytesValue`` and
 ``google.protobuf.StringValue`` are passed directly without the wrapper.
        .google.protobuf.Any configuration = 4;
        Returns:
        Whether the configuration field is set.

      • getConfiguration

        com.google.protobuf.Any getConfiguration()
         Filter/service configuration used to configure or reconfigure a plugin
 (``proxy_on_configure``).
 ``google.protobuf.Struct`` is serialized as JSON before
 passing it to the plugin. ``google.protobuf.BytesValue`` and
 ``google.protobuf.StringValue`` are passed directly without the wrapper.
        .google.protobuf.Any configuration = 4;
        Returns:
        The configuration.

      • getConfigurationOrBuilder

        com.google.protobuf.AnyOrBuilder getConfigurationOrBuilder()
         Filter/service configuration used to configure or reconfigure a plugin
 (``proxy_on_configure``).
 ``google.protobuf.Struct`` is serialized as JSON before
 passing it to the plugin. ``google.protobuf.BytesValue`` and
 ``google.protobuf.StringValue`` are passed directly without the wrapper.
        .google.protobuf.Any configuration = 4;

      • getFailOpen

        boolean getFailOpen()
         If there is a fatal error on the VM (e.g. exception, abort(), on_start or on_configure return false),
 then all plugins associated with the VM will either fail closed (by default), e.g. by returning an HTTP 503 error,
 or fail open (if 'fail_open' is set to true) by bypassing the filter. Note: when on_start or on_configure return false
 during xDS updates the xDS configuration will be rejected and when on_start or on_configuration return false on initial
 startup the proxy will not start.
        bool fail_open = 5;
        Returns:
        The failOpen.

      • hasCapabilityRestrictionConfig

        boolean hasCapabilityRestrictionConfig()
         Configuration for restricting Proxy-Wasm capabilities available to modules.
        .envoy.extensions.wasm.v3.CapabilityRestrictionConfig capability_restriction_config = 6;
        Returns:
        Whether the capabilityRestrictionConfig field is set.

      • getCapabilityRestrictionConfig

        CapabilityRestrictionConfig getCapabilityRestrictionConfig()
         Configuration for restricting Proxy-Wasm capabilities available to modules.
        .envoy.extensions.wasm.v3.CapabilityRestrictionConfig capability_restriction_config = 6;
        Returns:
        The capabilityRestrictionConfig.

      • getCapabilityRestrictionConfigOrBuilder

        CapabilityRestrictionConfigOrBuilder getCapabilityRestrictionConfigOrBuilder()
         Configuration for restricting Proxy-Wasm capabilities available to modules.
        .envoy.extensions.wasm.v3.CapabilityRestrictionConfig capability_restriction_config = 6;