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

Class PluginConfig.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, PluginConfigOrBuilder, Cloneable
    Enclosing class:
    PluginConfig
    public static final class PluginConfig.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<PluginConfig.Builder>
implements PluginConfigOrBuilder
     Base Configuration for Wasm Plugins e.g. filters and services.
 [#next-free-field: 7]
    Protobuf type envoy.extensions.wasm.v3.PluginConfig

    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<PluginConfig.Builder>

      • clear

        public PluginConfig.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<PluginConfig.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<PluginConfig.Builder>

      • getDefaultInstanceForType

        public PluginConfig getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

        public PluginConfig build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public PluginConfig buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • clone

        public PluginConfig.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<PluginConfig.Builder>

      • setField

        public PluginConfig.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                     Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<PluginConfig.Builder>

      • clearField

        public PluginConfig.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<PluginConfig.Builder>

      • clearOneof

        public PluginConfig.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<PluginConfig.Builder>

      • setRepeatedField

        public PluginConfig.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                             int index,
                                             Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<PluginConfig.Builder>

      • addRepeatedField

        public PluginConfig.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                             Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<PluginConfig.Builder>

      • mergeFrom

        public PluginConfig.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<PluginConfig.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<PluginConfig.Builder>

      • mergeFrom

        public PluginConfig.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<PluginConfig.Builder>
        Throws:
        IOException

      • getName

        public 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;
        Specified by:
        getName in interface PluginConfigOrBuilder
        Returns:
        The name.

      • getNameBytes

        public 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;
        Specified by:
        getNameBytes in interface PluginConfigOrBuilder
        Returns:
        The bytes for name.

      • setName

        public PluginConfig.Builder setName​(String value)
         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;
        Parameters:
        value - The name to set.
        Returns:
        This builder for chaining.

      • clearName

        public PluginConfig.Builder clearName()
         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:
        This builder for chaining.

      • setNameBytes

        public PluginConfig.Builder setNameBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for name to set.
        Returns:
        This builder for chaining.

      • getRootId

        public 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;
        Specified by:
        getRootId in interface PluginConfigOrBuilder
        Returns:
        The rootId.

      • getRootIdBytes

        public 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;
        Specified by:
        getRootIdBytes in interface PluginConfigOrBuilder
        Returns:
        The bytes for rootId.

      • setRootId

        public PluginConfig.Builder setRootId​(String value)
         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;
        Parameters:
        value - The rootId to set.
        Returns:
        This builder for chaining.

      • clearRootId

        public PluginConfig.Builder clearRootId()
         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:
        This builder for chaining.

      • setRootIdBytes

        public PluginConfig.Builder setRootIdBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for rootId to set.
        Returns:
        This builder for chaining.

      • hasVmConfig

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

      • getVmConfig

        public VmConfig getVmConfig()
         TODO: add referential VM configurations.
        .envoy.extensions.wasm.v3.VmConfig vm_config = 3;
        Specified by:
        getVmConfig in interface PluginConfigOrBuilder
        Returns:
        The vmConfig.

      • setVmConfig

        public PluginConfig.Builder setVmConfig​(VmConfig value)
         TODO: add referential VM configurations.
        .envoy.extensions.wasm.v3.VmConfig vm_config = 3;

      • setVmConfig

        public PluginConfig.Builder setVmConfig​(VmConfig.Builder builderForValue)
         TODO: add referential VM configurations.
        .envoy.extensions.wasm.v3.VmConfig vm_config = 3;

      • mergeVmConfig

        public PluginConfig.Builder mergeVmConfig​(VmConfig value)
         TODO: add referential VM configurations.
        .envoy.extensions.wasm.v3.VmConfig vm_config = 3;

      • clearVmConfig

        public PluginConfig.Builder clearVmConfig()
         TODO: add referential VM configurations.
        .envoy.extensions.wasm.v3.VmConfig vm_config = 3;

      • getVmConfigBuilder

        public VmConfig.Builder getVmConfigBuilder()
         TODO: add referential VM configurations.
        .envoy.extensions.wasm.v3.VmConfig vm_config = 3;

      • hasConfiguration

        public 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;
        Specified by:
        hasConfiguration in interface PluginConfigOrBuilder
        Returns:
        Whether the configuration field is set.

      • getConfiguration

        public 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;
        Specified by:
        getConfiguration in interface PluginConfigOrBuilder
        Returns:
        The configuration.

      • setConfiguration

        public PluginConfig.Builder setConfiguration​(com.google.protobuf.Any value)
         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;

      • setConfiguration

        public PluginConfig.Builder setConfiguration​(com.google.protobuf.Any.Builder builderForValue)
         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;

      • mergeConfiguration

        public PluginConfig.Builder mergeConfiguration​(com.google.protobuf.Any value)
         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;

      • clearConfiguration

        public PluginConfig.Builder clearConfiguration()
         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;

      • getConfigurationBuilder

        public com.google.protobuf.Any.Builder getConfigurationBuilder()
         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;

      • getConfigurationOrBuilder

        public 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;
        Specified by:
        getConfigurationOrBuilder in interface PluginConfigOrBuilder

      • getFailOpen

        public 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;
        Specified by:
        getFailOpen in interface PluginConfigOrBuilder
        Returns:
        The failOpen.

      • setFailOpen

        public PluginConfig.Builder setFailOpen​(boolean value)
         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;
        Parameters:
        value - The failOpen to set.
        Returns:
        This builder for chaining.

      • clearFailOpen

        public PluginConfig.Builder clearFailOpen()
         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:
        This builder for chaining.

      • hasCapabilityRestrictionConfig

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

      • getCapabilityRestrictionConfig

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

      • setCapabilityRestrictionConfig

        public PluginConfig.Builder setCapabilityRestrictionConfig​(CapabilityRestrictionConfig value)
         Configuration for restricting Proxy-Wasm capabilities available to modules.
        .envoy.extensions.wasm.v3.CapabilityRestrictionConfig capability_restriction_config = 6;

      • setCapabilityRestrictionConfig

        public PluginConfig.Builder setCapabilityRestrictionConfig​(CapabilityRestrictionConfig.Builder builderForValue)
         Configuration for restricting Proxy-Wasm capabilities available to modules.
        .envoy.extensions.wasm.v3.CapabilityRestrictionConfig capability_restriction_config = 6;

      • mergeCapabilityRestrictionConfig

        public PluginConfig.Builder mergeCapabilityRestrictionConfig​(CapabilityRestrictionConfig value)
         Configuration for restricting Proxy-Wasm capabilities available to modules.
        .envoy.extensions.wasm.v3.CapabilityRestrictionConfig capability_restriction_config = 6;

      • clearCapabilityRestrictionConfig

        public PluginConfig.Builder clearCapabilityRestrictionConfig()
         Configuration for restricting Proxy-Wasm capabilities available to modules.
        .envoy.extensions.wasm.v3.CapabilityRestrictionConfig capability_restriction_config = 6;

      • getCapabilityRestrictionConfigBuilder

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

      • setUnknownFields

        public final PluginConfig.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<PluginConfig.Builder>

      • mergeUnknownFields

        public final PluginConfig.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<PluginConfig.Builder>