io.envoyproxy.envoy.extensions.wasm.v3

Class PluginConfig.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<PluginConfig.Builder>

io.envoyproxy.envoy.extensions.wasm.v3.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: 6]
 

Protobuf type envoy.extensions.wasm.v3.PluginConfig

Method Summary

Modifier and Type	Method and Description
PluginConfig.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
PluginConfig	build()
PluginConfig	buildPartial()
PluginConfig.Builder	clear()
PluginConfig.Builder	clearConfiguration() Filter/service configuration used to configure or reconfigure a plugin (proxy_on_configuration).
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.
PluginConfig.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
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.
PluginConfig.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
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).
PluginConfig.Builder	clearVm()
PluginConfig.Builder	clearVmConfig() TODO: add referential VM configurations.
PluginConfig.Builder	clone()
com.google.protobuf.Any	getConfiguration() Filter/service configuration used to configure or reconfigure a plugin (proxy_on_configuration).
com.google.protobuf.Any.Builder	getConfigurationBuilder() 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).
PluginConfig	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
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.
VmConfig.Builder	getVmConfigBuilder() 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.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
PluginConfig.Builder	mergeConfiguration(com.google.protobuf.Any value) Filter/service configuration used to configure or reconfigure a plugin (proxy_on_configuration).
PluginConfig.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
PluginConfig.Builder	mergeFrom(com.google.protobuf.Message other)
PluginConfig.Builder	mergeFrom(PluginConfig other)
PluginConfig.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
PluginConfig.Builder	mergeVmConfig(VmConfig value) TODO: add referential VM configurations.
PluginConfig.Builder	setConfiguration(com.google.protobuf.Any.Builder builderForValue) Filter/service configuration used to configure or reconfigure a plugin (proxy_on_configuration).
PluginConfig.Builder	setConfiguration(com.google.protobuf.Any value) Filter/service configuration used to configure or reconfigure a plugin (proxy_on_configuration).
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.
PluginConfig.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
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.
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.
PluginConfig.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
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).
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).
PluginConfig.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
PluginConfig.Builder	setVmConfig(VmConfig.Builder builderForValue) TODO: add referential VM configurations.
PluginConfig.Builder	setVmConfig(VmConfig value) TODO: add referential VM configurations.

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

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

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

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

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

addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

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

mergeFrom

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>

mergeFrom

public PluginConfig.Builder mergeFrom(PluginConfig other)

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

getVmCase

public PluginConfig.VmCase getVmCase()

Specified by:

getVmCase in interface PluginConfigOrBuilder

clearVm

public PluginConfig.Builder clearVm()

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

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

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;

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;

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;

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

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

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;

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;

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;

hasVmConfig

public boolean hasVmConfig()

 TODO: add referential VM configurations.
 

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

Specified by:

hasVmConfig in interface PluginConfigOrBuilder

getVmConfig

public VmConfig getVmConfig()

 TODO: add referential VM configurations.
 

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

Specified by:

getVmConfig in interface PluginConfigOrBuilder

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;

getVmConfigOrBuilder

public VmConfigOrBuilder getVmConfigOrBuilder()

 TODO: add referential VM configurations.
 

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

Specified by:

getVmConfigOrBuilder in interface PluginConfigOrBuilder

hasConfiguration

public 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;

Specified by:

hasConfiguration in interface PluginConfigOrBuilder

getConfiguration

public 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;

Specified by:

getConfiguration in interface PluginConfigOrBuilder

setConfiguration

public PluginConfig.Builder setConfiguration(com.google.protobuf.Any value)

 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;

setConfiguration

public PluginConfig.Builder setConfiguration(com.google.protobuf.Any.Builder builderForValue)

 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;

mergeConfiguration

public PluginConfig.Builder mergeConfiguration(com.google.protobuf.Any value)

 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;

clearConfiguration

public PluginConfig.Builder clearConfiguration()

 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;

getConfigurationBuilder

public com.google.protobuf.Any.Builder getConfigurationBuilder()

 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

public 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;

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

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;

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;

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>