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

Modifier and Type	Method and Description
com.google.protobuf.Any	getConfiguration() Filter/service configuration used to configure or reconfigure a plugin (proxy_on_configuration).
com.google.protobuf.AnyOrBuilder	getConfigurationOrBuilder() Filter/service configuration used to configure or reconfigure a plugin (proxy_on_configuration).
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	hasConfiguration() Filter/service configuration used to configure or reconfigure a plugin (proxy_on_configuration).
boolean	hasVmConfig() TODO: add referential VM configurations.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

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;

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;

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;

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;

hasVmConfig

boolean hasVmConfig()

 TODO: add referential VM configurations.
 

.envoy.extensions.wasm.v3.VmConfig vm_config = 3;

getVmConfig

VmConfig getVmConfig()

 TODO: add referential VM configurations.
 

.envoy.extensions.wasm.v3.VmConfig vm_config = 3;

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_configuration).
 `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;

getConfiguration

com.google.protobuf.Any getConfiguration()

 Filter/service configuration used to configure or reconfigure a plugin
 (proxy_on_configuration).
 `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

com.google.protobuf.AnyOrBuilder getConfigurationOrBuilder()

 Filter/service configuration used to configure or reconfigure a plugin
 (proxy_on_configuration).
 `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;

getVmCase

PluginConfig.VmCase getVmCase()