graalvm/tools.elide.meta/GuestPolicy/Builder

Builder

class Builder : GeneratedMessage.Builder<BuilderT> , GuestPolicyOrBuilder

# Language Settings: Policy

Guest "policies" define the access rights granted to a given guest language VM. Policies are defined by the host and
enforced at runtime.

Protobuf type elide.meta.GuestPolicy

Functions

addRepeatedField

open fun addRepeatedField(field: Descriptors.FieldDescriptor, value: Any): BuilderT

abstract fun addRepeatedField(field: Descriptors.FieldDescriptor, value: Any): Message.Builder

build

abstract fun build(): MessageLite

open fun build(): GuestPolicy

buildPartial

abstract fun buildPartial(): MessageLite

open fun buildPartial(): GuestPolicy

clear

open fun clear(): BuilderType

abstract fun clear(): Message.Builder

open fun clear(): GuestPolicy.Builder

clearAllowAll

open fun clearAllowAll(): GuestPolicy.Builder

## Policies: Allow-all.

Allows all host access for the guest language. This means the guest language can load classes, access I/O, and
perform other potentially sensitive or dangerous operations. Exercise extreme caution enabling this policy.

bool allow_all = 1;

clearAllowNative

open fun clearAllowNative(): GuestPolicy.Builder

Whether to allow the guest language to call native code. Defaults to `false`.

bool allow_native = 5;

clearExecutionTime

open fun clearExecutionTime(): GuestPolicy.Builder

Maximum execution time to allow for execution within this guest; there is a sensible Elide-wide default if
unspecified. Expressed in a count of milliseconds. `0` disables the restriction.

uint64 execution_time = 11;

clearField

open fun clearField(field: Descriptors.FieldDescriptor): BuilderT

abstract fun clearField(field: Descriptors.FieldDescriptor): Message.Builder

clearHostEnv

open fun clearHostEnv(): GuestPolicy.Builder

Whether to allow the guest language to access host-side environment. Defaults to `false`.

bool host_env = 8;

clearHostIo

open fun clearHostIo(): GuestPolicy.Builder

Whether to allow the guest language to access host-side I/O. Defaults to `false`.

bool host_io = 6;

clearHostNet

open fun clearHostNet(): GuestPolicy.Builder

Whether to allow the guest language to access host-side networking. Defaults to `false`.

bool host_net = 7;

clearIntegrated

open fun clearIntegrated(): GuestPolicy.Builder

## Policies: Integrated.

Allows some host access for the guest language; this includes values shared in callbacks and invocation bindings.
The guest language can only load certain classes, cannot access host I/O (by default), and is *allowed* to call
native code; this mode should be used when all executing code is under the developer's control.

bool integrated = 2;

clearIsolated

open fun clearIsolated(): GuestPolicy.Builder

## Policies: Isolated.

Allows no host access for the guest language. This means the guest language cannot load classes, access host I/O,
or perform other potentially sensitive or dangerous operations. Resources used by guest languages can be capped
or otherwise controlled.

bool isolated = 3;

clearMaxMemory

open fun clearMaxMemory(): GuestPolicy.Builder

Maximum memory to allow for allocation within this guest language; there is a sensible Elide-wide default if
unspecified. Expressed as a count of bytes. `0` disables the restriction.

uint32 max_memory = 9;

clearOneof

open fun clearOneof(oneof: Descriptors.OneofDescriptor): BuilderType

open fun clearOneof(oneof: Descriptors.OneofDescriptor): BuilderT

abstract fun clearOneof(oneof: Descriptors.OneofDescriptor): Message.Builder

clearPolicy

open fun clearPolicy(): GuestPolicy.Builder

clearProcesses

open fun clearProcesses(): GuestPolicy.Builder

Whether to allow process control for the guest; the guest will be able to launch OS-native processes if this flag
is activated. In most secure operating modes this flag defaults to being off.

bool processes = 12;

clearSandbox

open fun clearSandbox(): GuestPolicy.Builder

## Policies: Sandbox.

Like the `ISOLATED` policy, but applies a stronger sandbox; allows no host access for the guest language. This
means the guest language cannot load classes, access host I/O, or perform other potentially sensitive or
dangerous operations. Resources used by guest languages can be capped or otherwise controlled.

If available, hardware isolation is used; otherwise, software isolation is used.

bool sandbox = 4;

clearStackDepth

open fun clearStackDepth(): GuestPolicy.Builder

Maximum stack depth to allow for execution within this guest; there is a sensible Elide-wide default if
unspecified. Specified as a numeric count. `0` disables the restriction.

uint32 stack_depth = 10;

clearThreads

open fun clearThreads(): GuestPolicy.Builder

Whether to allow thread control for the guest; the guest will be able to launch OS-native threads if this flag is
activated. In most secure operating modes this flag defaults to being off.

bool threads = 13;

clone

open fun clone(): BuilderType

open fun clone(): BuilderT

abstract fun clone(): Message.Builder

findInitializationErrors

open fun findInitializationErrors(): List<String>

getAllFields

open fun getAllFields(): Map<Descriptors.FieldDescriptor, Any>

getAllowAll

open fun getAllowAll(): Boolean

## Policies: Allow-all.

Allows all host access for the guest language. This means the guest language can load classes, access I/O, and
perform other potentially sensitive or dangerous operations. Exercise extreme caution enabling this policy.

bool allow_all = 1;

getAllowNative

open fun getAllowNative(): Boolean

Whether to allow the guest language to call native code. Defaults to `false`.

bool allow_native = 5;

getDefaultInstanceForType

abstract fun getDefaultInstanceForType(): MessageLite

open fun getDefaultInstanceForType(): GuestPolicy

getDescriptor

fun getDescriptor(): Descriptors.Descriptor

getDescriptorForType

open fun getDescriptorForType(): Descriptors.Descriptor

getExecutionTime

open fun getExecutionTime(): Long

Maximum execution time to allow for execution within this guest; there is a sensible Elide-wide default if
unspecified. Expressed in a count of milliseconds. `0` disables the restriction.

uint64 execution_time = 11;

getField

open fun getField(field: Descriptors.FieldDescriptor): Any

getFieldBuilder

open fun getFieldBuilder(field: Descriptors.FieldDescriptor): Message.Builder

getHostEnv

open fun getHostEnv(): Boolean

Whether to allow the guest language to access host-side environment. Defaults to `false`.

bool host_env = 8;

getHostIo

open fun getHostIo(): Boolean

Whether to allow the guest language to access host-side I/O. Defaults to `false`.

bool host_io = 6;

getHostNet

open fun getHostNet(): Boolean

Whether to allow the guest language to access host-side networking. Defaults to `false`.

bool host_net = 7;

getInitializationErrorString

open fun getInitializationErrorString(): String

getIntegrated

open fun getIntegrated(): Boolean

## Policies: Integrated.

Allows some host access for the guest language; this includes values shared in callbacks and invocation bindings.
The guest language can only load certain classes, cannot access host I/O (by default), and is *allowed* to call
native code; this mode should be used when all executing code is under the developer's control.

bool integrated = 2;

getIsolated

open fun getIsolated(): Boolean

## Policies: Isolated.

Allows no host access for the guest language. This means the guest language cannot load classes, access host I/O,
or perform other potentially sensitive or dangerous operations. Resources used by guest languages can be capped
or otherwise controlled.

bool isolated = 3;

getMaxMemory

open fun getMaxMemory(): Int

Maximum memory to allow for allocation within this guest language; there is a sensible Elide-wide default if
unspecified. Expressed as a count of bytes. `0` disables the restriction.

uint32 max_memory = 9;

getOneofFieldDescriptor

open fun getOneofFieldDescriptor(oneof: Descriptors.OneofDescriptor): Descriptors.FieldDescriptor

getPolicyCase

open fun getPolicyCase(): GuestPolicy.PolicyCase

getProcesses

open fun getProcesses(): Boolean

Whether to allow process control for the guest; the guest will be able to launch OS-native processes if this flag
is activated. In most secure operating modes this flag defaults to being off.

bool processes = 12;

getRepeatedField

open fun getRepeatedField(field: Descriptors.FieldDescriptor, index: Int): Any

getRepeatedFieldBuilder

open fun getRepeatedFieldBuilder(field: Descriptors.FieldDescriptor, index: Int): Message.Builder

getRepeatedFieldCount

open fun getRepeatedFieldCount(field: Descriptors.FieldDescriptor): Int

getSandbox

open fun getSandbox(): Boolean

## Policies: Sandbox.

Like the `ISOLATED` policy, but applies a stronger sandbox; allows no host access for the guest language. This
means the guest language cannot load classes, access host I/O, or perform other potentially sensitive or
dangerous operations. Resources used by guest languages can be capped or otherwise controlled.

If available, hardware isolation is used; otherwise, software isolation is used.

bool sandbox = 4;

getStackDepth

open fun getStackDepth(): Int

Maximum stack depth to allow for execution within this guest; there is a sensible Elide-wide default if
unspecified. Specified as a numeric count. `0` disables the restriction.

uint32 stack_depth = 10;

getThreads

open fun getThreads(): Boolean

Whether to allow thread control for the guest; the guest will be able to launch OS-native threads if this flag is
activated. In most secure operating modes this flag defaults to being off.

bool threads = 13;

getUnknownFields

fun getUnknownFields(): UnknownFieldSet

hasAllowAll

open fun hasAllowAll(): Boolean

## Policies: Allow-all.

Allows all host access for the guest language. This means the guest language can load classes, access I/O, and
perform other potentially sensitive or dangerous operations. Exercise extreme caution enabling this policy.

bool allow_all = 1;

hasField

open fun hasField(field: Descriptors.FieldDescriptor): Boolean

hasIntegrated

open fun hasIntegrated(): Boolean

## Policies: Integrated.

Allows some host access for the guest language; this includes values shared in callbacks and invocation bindings.
The guest language can only load certain classes, cannot access host I/O (by default), and is *allowed* to call
native code; this mode should be used when all executing code is under the developer's control.

bool integrated = 2;

hasIsolated

open fun hasIsolated(): Boolean

## Policies: Isolated.

Allows no host access for the guest language. This means the guest language cannot load classes, access host I/O,
or perform other potentially sensitive or dangerous operations. Resources used by guest languages can be capped
or otherwise controlled.

bool isolated = 3;

hasOneof

open fun hasOneof(oneof: Descriptors.OneofDescriptor): Boolean

hasSandbox

open fun hasSandbox(): Boolean

## Policies: Sandbox.

Like the `ISOLATED` policy, but applies a stronger sandbox; allows no host access for the guest language. This
means the guest language cannot load classes, access host I/O, or perform other potentially sensitive or
dangerous operations. Resources used by guest languages can be capped or otherwise controlled.

If available, hardware isolation is used; otherwise, software isolation is used.

bool sandbox = 4;

isInitialized

fun isInitialized(): Boolean

mergeDelimitedFrom

open fun mergeDelimitedFrom(input: InputStream, extensionRegistry: ExtensionRegistryLite): Boolean

mergeFrom

abstract fun mergeFrom(other: Message): Message.Builder

open fun mergeFrom(other: Message): GuestPolicy.Builder

open fun mergeFrom(other: GuestPolicy): GuestPolicy.Builder

open fun mergeFrom(input: CodedInputStream, extensionRegistry: ExtensionRegistryLite): GuestPolicy.Builder

mergeUnknownFields

open fun mergeUnknownFields(unknownFields: UnknownFieldSet): BuilderType

open fun mergeUnknownFields(unknownFields: UnknownFieldSet): BuilderT

abstract fun mergeUnknownFields(unknownFields: UnknownFieldSet): Message.Builder

newBuilderForField

open fun newBuilderForField(field: Descriptors.FieldDescriptor): Message.Builder

setAllowAll

open fun setAllowAll(value: Boolean): GuestPolicy.Builder

## Policies: Allow-all.

Allows all host access for the guest language. This means the guest language can load classes, access I/O, and
perform other potentially sensitive or dangerous operations. Exercise extreme caution enabling this policy.

bool allow_all = 1;

setAllowNative

open fun setAllowNative(value: Boolean): GuestPolicy.Builder

Whether to allow the guest language to call native code. Defaults to `false`.

bool allow_native = 5;

setExecutionTime

open fun setExecutionTime(value: Long): GuestPolicy.Builder

Maximum execution time to allow for execution within this guest; there is a sensible Elide-wide default if
unspecified. Expressed in a count of milliseconds. `0` disables the restriction.

uint64 execution_time = 11;

setField

open fun setField(field: Descriptors.FieldDescriptor, value: Any): BuilderT

abstract fun setField(field: Descriptors.FieldDescriptor, value: Any): Message.Builder

setHostEnv

open fun setHostEnv(value: Boolean): GuestPolicy.Builder

Whether to allow the guest language to access host-side environment. Defaults to `false`.

bool host_env = 8;

setHostIo

open fun setHostIo(value: Boolean): GuestPolicy.Builder

Whether to allow the guest language to access host-side I/O. Defaults to `false`.

bool host_io = 6;

setHostNet

open fun setHostNet(value: Boolean): GuestPolicy.Builder

Whether to allow the guest language to access host-side networking. Defaults to `false`.

bool host_net = 7;

setIntegrated

open fun setIntegrated(value: Boolean): GuestPolicy.Builder

## Policies: Integrated.

Allows some host access for the guest language; this includes values shared in callbacks and invocation bindings.
The guest language can only load certain classes, cannot access host I/O (by default), and is *allowed* to call
native code; this mode should be used when all executing code is under the developer's control.

bool integrated = 2;

setIsolated

open fun setIsolated(value: Boolean): GuestPolicy.Builder

## Policies: Isolated.

Allows no host access for the guest language. This means the guest language cannot load classes, access host I/O,
or perform other potentially sensitive or dangerous operations. Resources used by guest languages can be capped
or otherwise controlled.

bool isolated = 3;

setMaxMemory

open fun setMaxMemory(value: Int): GuestPolicy.Builder

Maximum memory to allow for allocation within this guest language; there is a sensible Elide-wide default if
unspecified. Expressed as a count of bytes. `0` disables the restriction.

uint32 max_memory = 9;

setProcesses

open fun setProcesses(value: Boolean): GuestPolicy.Builder

Whether to allow process control for the guest; the guest will be able to launch OS-native processes if this flag
is activated. In most secure operating modes this flag defaults to being off.

bool processes = 12;

setRepeatedField

open fun setRepeatedField(field: Descriptors.FieldDescriptor, index: Int, value: Any): BuilderT

abstract fun setRepeatedField(field: Descriptors.FieldDescriptor, index: Int, value: Any): Message.Builder

setSandbox

open fun setSandbox(value: Boolean): GuestPolicy.Builder

## Policies: Sandbox.

Like the `ISOLATED` policy, but applies a stronger sandbox; allows no host access for the guest language. This
means the guest language cannot load classes, access host I/O, or perform other potentially sensitive or
dangerous operations. Resources used by guest languages can be capped or otherwise controlled.

If available, hardware isolation is used; otherwise, software isolation is used.

bool sandbox = 4;

setStackDepth

open fun setStackDepth(value: Int): GuestPolicy.Builder

Maximum stack depth to allow for execution within this guest; there is a sensible Elide-wide default if
unspecified. Specified as a numeric count. `0` disables the restriction.

uint32 stack_depth = 10;

setThreads

open fun setThreads(value: Boolean): GuestPolicy.Builder

Whether to allow thread control for the guest; the guest will be able to launch OS-native threads if this flag is
activated. In most secure operating modes this flag defaults to being off.

bool threads = 13;

setUnknownFields

open fun setUnknownFields(unknownFields: UnknownFieldSet): BuilderT

abstract fun setUnknownFields(unknownFields: UnknownFieldSet): Message.Builder

toString

open fun toString(): String