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

Class PluginConfig

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

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  PluginConfig.Builder
      Base Configuration for Wasm Plugins e.g. filters and services.
      static class  PluginConfig.VmCase  

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        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

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(Object obj)  
      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``).
      static PluginConfig getDefaultInstance()  
      PluginConfig getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      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.
      com.google.protobuf.Parser<PluginConfig> getParserForType()  
      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).
      int getSerializedSize()  
      com.google.protobuf.UnknownFieldSet getUnknownFields()  
      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``).
      int hashCode()  
      boolean hasVmConfig()
      TODO: add referential VM configurations.
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static PluginConfig.Builder newBuilder()  
      static PluginConfig.Builder newBuilder​(PluginConfig prototype)  
      PluginConfig.Builder newBuilderForType()  
      protected PluginConfig.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static PluginConfig parseDelimitedFrom​(InputStream input)  
      static PluginConfig parseDelimitedFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static PluginConfig parseFrom​(byte[] data)  
      static PluginConfig parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static PluginConfig parseFrom​(com.google.protobuf.ByteString data)  
      static PluginConfig parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static PluginConfig parseFrom​(com.google.protobuf.CodedInputStream input)  
      static PluginConfig parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static PluginConfig parseFrom​(InputStream input)  
      static PluginConfig parseFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static PluginConfig parseFrom​(ByteBuffer data)  
      static PluginConfig parseFrom​(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<PluginConfig> parser()  
      PluginConfig.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

      • Methods inherited from class com.google.protobuf.GeneratedMessageV3

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, 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, writeStringNoTag

      • Methods inherited from class com.google.protobuf.AbstractMessage

        findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from interface com.google.protobuf.MessageLite

        toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

    • Field Detail

      • CONFIGURATION_FIELD_NUMBER

        public static final int CONFIGURATION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CAPABILITY_RESTRICTION_CONFIG_FIELD_NUMBER

        public static final int CAPABILITY_RESTRICTION_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • 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

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

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

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

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

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

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

      • isInitialized

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

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static PluginConfig parseFrom​(ByteBuffer data)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PluginConfig parseFrom​(ByteBuffer data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PluginConfig parseFrom​(com.google.protobuf.ByteString data)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PluginConfig parseFrom​(com.google.protobuf.ByteString data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PluginConfig parseFrom​(byte[] data)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PluginConfig parseFrom​(byte[] data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PluginConfig parseFrom​(com.google.protobuf.CodedInputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws IOException
        Throws:
        IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected PluginConfig.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static PluginConfig getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<PluginConfig> parser()

      • getParserForType

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

      • getDefaultInstanceForType

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