Class PluginConfig
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.wasm.v3.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: 10]Protobuf type
envoy.extensions.wasm.v3.PluginConfig- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classBase Configuration for Wasm Plugins e.g. filters and services.static enumNested 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 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 TypeMethodDescriptionbooleancom.google.protobuf.BoolValueWhether or not to allow plugin onRequestHeaders and onResponseHeaders callbacks to return FilterHeadersStatus::StopIteration.com.google.protobuf.BoolValueOrBuilderWhether or not to allow plugin onRequestHeaders and onResponseHeaders callbacks to return FilterHeadersStatus::StopIteration.Configuration for restricting Proxy-Wasm capabilities available to modules.Configuration for restricting Proxy-Wasm capabilities available to modules.com.google.protobuf.AnyFilter/service configuration used to configure or reconfigure a plugin (``proxy_on_configure``).com.google.protobuf.AnyOrBuilderFilter/service configuration used to configure or reconfigure a plugin (``proxy_on_configure``).static PluginConfigstatic final com.google.protobuf.Descriptors.DescriptorbooleanDeprecated.envoy.extensions.wasm.v3.PluginConfig.fail_open is deprecated.The failure policy for the plugin.intThe failure policy for the plugin.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.ByteStringA 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>Reload configuration.Reload configuration.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.ByteStringA 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).intTODO: add referential VM configurations.TODO: add referential VM configurations.booleanWhether or not to allow plugin onRequestHeaders and onResponseHeaders callbacks to return FilterHeadersStatus::StopIteration.booleanConfiguration for restricting Proxy-Wasm capabilities available to modules.booleanFilter/service configuration used to configure or reconfigure a plugin (``proxy_on_configure``).inthashCode()booleanReload configuration.booleanTODO: add referential VM configurations.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTablefinal booleanstatic PluginConfig.Builderstatic PluginConfig.BuildernewBuilder(PluginConfig prototype) protected PluginConfig.BuildernewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) protected ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) static PluginConfigparseDelimitedFrom(InputStream input) static PluginConfigparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static PluginConfigparseFrom(byte[] data) static PluginConfigparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static PluginConfigparseFrom(com.google.protobuf.ByteString data) static PluginConfigparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static PluginConfigparseFrom(com.google.protobuf.CodedInputStream input) static PluginConfigparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static PluginConfigparseFrom(InputStream input) static PluginConfigparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static PluginConfigparseFrom(ByteBuffer data) static PluginConfigparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<PluginConfig>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, internalGetMapFieldReflection, 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
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER- See Also:
-
ROOT_ID_FIELD_NUMBER
public static final int ROOT_ID_FIELD_NUMBER- See Also:
-
VM_CONFIG_FIELD_NUMBER
public static final int VM_CONFIG_FIELD_NUMBER- See Also:
-
CONFIGURATION_FIELD_NUMBER
public static final int CONFIGURATION_FIELD_NUMBER- See Also:
-
FAIL_OPEN_FIELD_NUMBER
public static final int FAIL_OPEN_FIELD_NUMBER- See Also:
-
FAILURE_POLICY_FIELD_NUMBER
public static final int FAILURE_POLICY_FIELD_NUMBER- See Also:
-
RELOAD_CONFIG_FIELD_NUMBER
public static final int RELOAD_CONFIG_FIELD_NUMBER- See Also:
-
CAPABILITY_RESTRICTION_CONFIG_FIELD_NUMBER
public static final int CAPABILITY_RESTRICTION_CONFIG_FIELD_NUMBER- See Also:
-
ALLOW_ON_HEADERS_STOP_ITERATION_FIELD_NUMBER
public static final int ALLOW_ON_HEADERS_STOP_ITERATION_FIELD_NUMBER- See Also:
-
-
Method Details
-
newInstance
- Overrides:
newInstancein classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3
-
getVmCase
- Specified by:
getVmCasein interfacePluginConfigOrBuilder
-
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:
getNamein interfacePluginConfigOrBuilder- 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:
getNameBytesin interfacePluginConfigOrBuilder- Returns:
- The bytes for name.
-
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:
getRootIdin interfacePluginConfigOrBuilder- 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:
getRootIdBytesin interfacePluginConfigOrBuilder- Returns:
- The bytes for rootId.
-
hasVmConfig
public boolean hasVmConfig()TODO: add referential VM configurations.
.envoy.extensions.wasm.v3.VmConfig vm_config = 3;- Specified by:
hasVmConfigin interfacePluginConfigOrBuilder- Returns:
- Whether the vmConfig field is set.
-
getVmConfig
TODO: add referential VM configurations.
.envoy.extensions.wasm.v3.VmConfig vm_config = 3;- Specified by:
getVmConfigin interfacePluginConfigOrBuilder- Returns:
- The vmConfig.
-
getVmConfigOrBuilder
TODO: add referential VM configurations.
.envoy.extensions.wasm.v3.VmConfig vm_config = 3;- Specified by:
getVmConfigOrBuilderin interfacePluginConfigOrBuilder
-
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:
hasConfigurationin interfacePluginConfigOrBuilder- 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:
getConfigurationin interfacePluginConfigOrBuilder- 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:
getConfigurationOrBuilderin interfacePluginConfigOrBuilder
-
getFailOpen
Deprecated.envoy.extensions.wasm.v3.PluginConfig.fail_open is deprecated. See envoy/extensions/wasm/v3/wasm.proto;l=185If 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_configure`` return ``false`` on initial startup the proxy will not start. This field is deprecated in favor of the ``failure_policy`` field.
bool fail_open = 5 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];- Specified by:
getFailOpenin interfacePluginConfigOrBuilder- Returns:
- The failOpen.
-
getFailurePolicyValue
public int getFailurePolicyValue()The failure policy for the plugin.
.envoy.extensions.wasm.v3.FailurePolicy failure_policy = 7;- Specified by:
getFailurePolicyValuein interfacePluginConfigOrBuilder- Returns:
- The enum numeric value on the wire for failurePolicy.
-
getFailurePolicy
The failure policy for the plugin.
.envoy.extensions.wasm.v3.FailurePolicy failure_policy = 7;- Specified by:
getFailurePolicyin interfacePluginConfigOrBuilder- Returns:
- The failurePolicy.
-
hasReloadConfig
public boolean hasReloadConfig()Reload configuration. This is only applied when ``failure_policy`` is set to ``FAIL_RELOAD``.
.envoy.extensions.wasm.v3.ReloadConfig reload_config = 8;- Specified by:
hasReloadConfigin interfacePluginConfigOrBuilder- Returns:
- Whether the reloadConfig field is set.
-
getReloadConfig
Reload configuration. This is only applied when ``failure_policy`` is set to ``FAIL_RELOAD``.
.envoy.extensions.wasm.v3.ReloadConfig reload_config = 8;- Specified by:
getReloadConfigin interfacePluginConfigOrBuilder- Returns:
- The reloadConfig.
-
getReloadConfigOrBuilder
Reload configuration. This is only applied when ``failure_policy`` is set to ``FAIL_RELOAD``.
.envoy.extensions.wasm.v3.ReloadConfig reload_config = 8;- Specified by:
getReloadConfigOrBuilderin interfacePluginConfigOrBuilder
-
hasCapabilityRestrictionConfig
public boolean hasCapabilityRestrictionConfig()Configuration for restricting Proxy-Wasm capabilities available to modules.
.envoy.extensions.wasm.v3.CapabilityRestrictionConfig capability_restriction_config = 6;- Specified by:
hasCapabilityRestrictionConfigin interfacePluginConfigOrBuilder- Returns:
- Whether the capabilityRestrictionConfig field is set.
-
getCapabilityRestrictionConfig
Configuration for restricting Proxy-Wasm capabilities available to modules.
.envoy.extensions.wasm.v3.CapabilityRestrictionConfig capability_restriction_config = 6;- Specified by:
getCapabilityRestrictionConfigin interfacePluginConfigOrBuilder- Returns:
- The capabilityRestrictionConfig.
-
getCapabilityRestrictionConfigOrBuilder
Configuration for restricting Proxy-Wasm capabilities available to modules.
.envoy.extensions.wasm.v3.CapabilityRestrictionConfig capability_restriction_config = 6;- Specified by:
getCapabilityRestrictionConfigOrBuilderin interfacePluginConfigOrBuilder
-
hasAllowOnHeadersStopIteration
public boolean hasAllowOnHeadersStopIteration()Whether or not to allow plugin onRequestHeaders and onResponseHeaders callbacks to return FilterHeadersStatus::StopIteration.
.google.protobuf.BoolValue allow_on_headers_stop_iteration = 9;- Specified by:
hasAllowOnHeadersStopIterationin interfacePluginConfigOrBuilder- Returns:
- Whether the allowOnHeadersStopIteration field is set.
-
getAllowOnHeadersStopIteration
public com.google.protobuf.BoolValue getAllowOnHeadersStopIteration()Whether or not to allow plugin onRequestHeaders and onResponseHeaders callbacks to return FilterHeadersStatus::StopIteration.
.google.protobuf.BoolValue allow_on_headers_stop_iteration = 9;- Specified by:
getAllowOnHeadersStopIterationin interfacePluginConfigOrBuilder- Returns:
- The allowOnHeadersStopIteration.
-
getAllowOnHeadersStopIterationOrBuilder
public com.google.protobuf.BoolValueOrBuilder getAllowOnHeadersStopIterationOrBuilder()Whether or not to allow plugin onRequestHeaders and onResponseHeaders callbacks to return FilterHeadersStatus::StopIteration.
.google.protobuf.BoolValue allow_on_headers_stop_iteration = 9;- Specified by:
getAllowOnHeadersStopIterationOrBuilderin interfacePluginConfigOrBuilder
-
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 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
- Throws:
IOException
-
parseFrom
public static PluginConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static PluginConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static PluginConfig 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 PluginConfig.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
-