io.envoyproxy.envoy.extensions.wasm.v3

Interface VmConfigOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

VmConfig, VmConfig.Builder

public interface VmConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	getAllowPrecompiled() Allow the wasm file to include pre-compiled code on VMs which support it.
AsyncDataSource	getCode() The Wasm code that Envoy will execute.
AsyncDataSourceOrBuilder	getCodeOrBuilder() The Wasm code that Envoy will execute.
com.google.protobuf.Any	getConfiguration() The Wasm configuration used in initialization of a new VM (proxy_on_start).
com.google.protobuf.AnyOrBuilder	getConfigurationOrBuilder() The Wasm configuration used in initialization of a new VM (proxy_on_start).
boolean	getNackOnCodeCacheMiss() If true and the code needs to be remotely fetched and it is not in the cache then NACK the configuration update and do a background fetch to fill the cache, otherwise fetch the code asynchronously and enter warming state.
String	getRuntime() The Wasm runtime type.
com.google.protobuf.ByteString	getRuntimeBytes() The Wasm runtime type.
String	getVmId() An ID which will be used along with a hash of the wasm code (or the name of the registered Null VM plugin) to determine which VM will be used for the plugin.
com.google.protobuf.ByteString	getVmIdBytes() An ID which will be used along with a hash of the wasm code (or the name of the registered Null VM plugin) to determine which VM will be used for the plugin.
boolean	hasCode() The Wasm code that Envoy will execute.
boolean	hasConfiguration() The Wasm configuration used in initialization of a new VM (proxy_on_start).

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

getVmId

String getVmId()

 An ID which will be used along with a hash of the wasm code (or the name of the registered Null
 VM plugin) to determine which VM will be used for the plugin. All plugins which use the same
 *vm_id* and code will use the same VM. May be left blank. Sharing a VM between plugins can
 reduce memory utilization and make sharing of data easier which may have security implications.
 See ref: "TODO: add ref" for details.
 

string vm_id = 1;

getVmIdBytes

com.google.protobuf.ByteString getVmIdBytes()

 An ID which will be used along with a hash of the wasm code (or the name of the registered Null
 VM plugin) to determine which VM will be used for the plugin. All plugins which use the same
 *vm_id* and code will use the same VM. May be left blank. Sharing a VM between plugins can
 reduce memory utilization and make sharing of data easier which may have security implications.
 See ref: "TODO: add ref" for details.
 

string vm_id = 1;

getRuntime

String getRuntime()

 The Wasm runtime type.
 Available Wasm runtime types are registered as extensions. The following runtimes are included
 in Envoy code base:
 .. _extension_envoy.wasm.runtime.null:
 **envoy.wasm.runtime.null**: Null sandbox, the Wasm module must be compiled and linked into the
 Envoy binary. The registered name is given in the *code* field as *inline_string*.
 .. _extension_envoy.wasm.runtime.v8:
 **envoy.wasm.runtime.v8**: `V8 <https://v8.dev/>`_-based WebAssembly runtime.
 .. _extension_envoy.wasm.runtime.wavm:
 **envoy.wasm.runtime.wavm**: `WAVM <https://wavm.github.io/>`_-based WebAssembly runtime.
 This runtime is not enabled in the official build.
 .. _extension_envoy.wasm.runtime.wasmtime:
 **envoy.wasm.runtime.wasmtime**: `Wasmtime <https://wasmtime.dev/>`_-based WebAssembly runtime.
 This runtime is not enabled in the official build.
 

string runtime = 2 [(.validate.rules) = { ... }

getRuntimeBytes

com.google.protobuf.ByteString getRuntimeBytes()

 The Wasm runtime type.
 Available Wasm runtime types are registered as extensions. The following runtimes are included
 in Envoy code base:
 .. _extension_envoy.wasm.runtime.null:
 **envoy.wasm.runtime.null**: Null sandbox, the Wasm module must be compiled and linked into the
 Envoy binary. The registered name is given in the *code* field as *inline_string*.
 .. _extension_envoy.wasm.runtime.v8:
 **envoy.wasm.runtime.v8**: `V8 <https://v8.dev/>`_-based WebAssembly runtime.
 .. _extension_envoy.wasm.runtime.wavm:
 **envoy.wasm.runtime.wavm**: `WAVM <https://wavm.github.io/>`_-based WebAssembly runtime.
 This runtime is not enabled in the official build.
 .. _extension_envoy.wasm.runtime.wasmtime:
 **envoy.wasm.runtime.wasmtime**: `Wasmtime <https://wasmtime.dev/>`_-based WebAssembly runtime.
 This runtime is not enabled in the official build.
 

string runtime = 2 [(.validate.rules) = { ... }

hasCode

boolean hasCode()

 The Wasm code that Envoy will execute.
 

.envoy.config.core.v3.AsyncDataSource code = 3;

getCode

AsyncDataSource getCode()

 The Wasm code that Envoy will execute.
 

.envoy.config.core.v3.AsyncDataSource code = 3;

getCodeOrBuilder

AsyncDataSourceOrBuilder getCodeOrBuilder()

 The Wasm code that Envoy will execute.
 

.envoy.config.core.v3.AsyncDataSource code = 3;

hasConfiguration

boolean hasConfiguration()

 The Wasm configuration used in initialization of a new VM
 (proxy_on_start). `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()

 The Wasm configuration used in initialization of a new VM
 (proxy_on_start). `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()

 The Wasm configuration used in initialization of a new VM
 (proxy_on_start). `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;

getAllowPrecompiled

boolean getAllowPrecompiled()

 Allow the wasm file to include pre-compiled code on VMs which support it.
 Warning: this should only be enable for trusted sources as the precompiled code is not
 verified.
 

bool allow_precompiled = 5;

getNackOnCodeCacheMiss

boolean getNackOnCodeCacheMiss()

 If true and the code needs to be remotely fetched and it is not in the cache then NACK the configuration
 update and do a background fetch to fill the cache, otherwise fetch the code asynchronously and enter
 warming state.
 

bool nack_on_code_cache_miss = 6;