graalvm/tools.elide.model/FieldPersistenceOptions/Builder

Builder

class Builder : GeneratedMessage.Builder<BuilderT> , FieldPersistenceOptionsOrBuilder

Persistence/data engine options specific to an individual message field.

Protobuf type elide.model.FieldPersistenceOptions

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(): FieldPersistenceOptions

buildPartial

abstract fun buildPartial(): MessageLite

open fun buildPartial(): FieldPersistenceOptions

clear

open fun clear(): BuilderType

abstract fun clear(): Message.Builder

open fun clear(): FieldPersistenceOptions.Builder

clearDescription

open fun ~~clearDescription~~(): FieldPersistenceOptions.Builder

Provided for backwards compatibility. Do not use.

string description = 9 [deprecated = true];

clearExplicit

open fun clearExplicit(): FieldPersistenceOptions.Builder

This field should always be explicitly listed with a value, even if it is set to the default value. This function
is especially useful for enums with default values, when there is a desire to have consistent indexes.

bool explicit = 7;

clearField

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

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

clearImmutable

open fun clearImmutable(): FieldPersistenceOptions.Builder

This field should allow writes when the model that contains it is written, but then, henceforth, the model should
not allow this field to be mutated.

bool immutable = 6;

clearOneof

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

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

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

clearReadOnly

open fun clearReadOnly(): FieldPersistenceOptions.Builder

This field should not allow writes, but rather produce its value dynamically. Fields marked in this manner cannot
be set by external code at any point in time.

bool read_only = 5;

clearStampCreate

open fun clearStampCreate(): FieldPersistenceOptions.Builder

This item is a timestamp, and we would like it to be automatically set when the model is created. After that point,
we would like this field to be read-only.

bool stamp_create = 4;

clearStampUpdate

open fun clearStampUpdate(): FieldPersistenceOptions.Builder

This item is a timestamp, and we would like it to be automatically updated each time the model that contains it is
modified in underlying storage. The field should be read-only.

bool stamp_update = 3;

clearSummary

open fun clearSummary(): FieldPersistenceOptions.Builder

Summary for this field, which provides a narrative description. It should be suitable for use in external
circumstances, like documentation.

string summary = 2;

clearType

open fun clearType(): FieldPersistenceOptions.Builder

Field type, for special-case fields.

.elide.model.FieldType type = 1;

clearVisibility

open fun clearVisibility(): FieldPersistenceOptions.Builder

Describes the visibility level of a given field in a tree of fields. This value applies recursively under message
fields on which it is applied. Depending on the visibility level active when data is deserialized or serialized,
certain data may be withheld corresponding to the invoking user or system's access level.

.elide.model.FieldVisibility visibility = 8;

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>

getDefaultInstanceForType

abstract fun getDefaultInstanceForType(): MessageLite

open fun getDefaultInstanceForType(): FieldPersistenceOptions

getDescription

open fun ~~getDescription~~(): String

Provided for backwards compatibility. Do not use.

string description = 9 [deprecated = true];

getDescriptionBytes

open fun ~~getDescriptionBytes~~(): ByteString

Provided for backwards compatibility. Do not use.

string description = 9 [deprecated = true];

getDescriptor

fun getDescriptor(): Descriptors.Descriptor

getDescriptorForType

open fun getDescriptorForType(): Descriptors.Descriptor

getExplicit

open fun getExplicit(): Boolean

This field should always be explicitly listed with a value, even if it is set to the default value. This function
is especially useful for enums with default values, when there is a desire to have consistent indexes.

bool explicit = 7;

getField

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

getFieldBuilder

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

getImmutable

open fun getImmutable(): Boolean

This field should allow writes when the model that contains it is written, but then, henceforth, the model should
not allow this field to be mutated.

bool immutable = 6;

getInitializationErrorString

open fun getInitializationErrorString(): String

getOneofFieldDescriptor

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

getReadOnly

open fun getReadOnly(): Boolean

This field should not allow writes, but rather produce its value dynamically. Fields marked in this manner cannot
be set by external code at any point in time.

bool read_only = 5;

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

getStampCreate

open fun getStampCreate(): Boolean

This item is a timestamp, and we would like it to be automatically set when the model is created. After that point,
we would like this field to be read-only.

bool stamp_create = 4;

getStampUpdate

open fun getStampUpdate(): Boolean

This item is a timestamp, and we would like it to be automatically updated each time the model that contains it is
modified in underlying storage. The field should be read-only.

bool stamp_update = 3;

getSummary

open fun getSummary(): String

Summary for this field, which provides a narrative description. It should be suitable for use in external
circumstances, like documentation.

string summary = 2;

getSummaryBytes

open fun getSummaryBytes(): ByteString

Summary for this field, which provides a narrative description. It should be suitable for use in external
circumstances, like documentation.

string summary = 2;

getType

open fun getType(): FieldType

Field type, for special-case fields.

.elide.model.FieldType type = 1;

getTypeValue

open fun getTypeValue(): Int

Field type, for special-case fields.

.elide.model.FieldType type = 1;

getUnknownFields

fun getUnknownFields(): UnknownFieldSet

getVisibility

open fun getVisibility(): FieldVisibility

Describes the visibility level of a given field in a tree of fields. This value applies recursively under message
fields on which it is applied. Depending on the visibility level active when data is deserialized or serialized,
certain data may be withheld corresponding to the invoking user or system's access level.

.elide.model.FieldVisibility visibility = 8;

getVisibilityValue

open fun getVisibilityValue(): Int

Describes the visibility level of a given field in a tree of fields. This value applies recursively under message
fields on which it is applied. Depending on the visibility level active when data is deserialized or serialized,
certain data may be withheld corresponding to the invoking user or system's access level.

.elide.model.FieldVisibility visibility = 8;

hasField

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

hasOneof

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

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): FieldPersistenceOptions.Builder

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

open fun mergeFrom(input: CodedInputStream, extensionRegistry: ExtensionRegistryLite): FieldPersistenceOptions.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

setDescription

open fun ~~setDescription~~(value: String): FieldPersistenceOptions.Builder

Provided for backwards compatibility. Do not use.

string description = 9 [deprecated = true];

setDescriptionBytes

open fun ~~setDescriptionBytes~~(value: ByteString): FieldPersistenceOptions.Builder

Provided for backwards compatibility. Do not use.

string description = 9 [deprecated = true];

setExplicit

open fun setExplicit(value: Boolean): FieldPersistenceOptions.Builder

This field should always be explicitly listed with a value, even if it is set to the default value. This function
is especially useful for enums with default values, when there is a desire to have consistent indexes.

bool explicit = 7;

setField

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

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

setImmutable

open fun setImmutable(value: Boolean): FieldPersistenceOptions.Builder

This field should allow writes when the model that contains it is written, but then, henceforth, the model should
not allow this field to be mutated.

bool immutable = 6;

setReadOnly

open fun setReadOnly(value: Boolean): FieldPersistenceOptions.Builder

This field should not allow writes, but rather produce its value dynamically. Fields marked in this manner cannot
be set by external code at any point in time.

bool read_only = 5;

setRepeatedField

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

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

setStampCreate

open fun setStampCreate(value: Boolean): FieldPersistenceOptions.Builder

This item is a timestamp, and we would like it to be automatically set when the model is created. After that point,
we would like this field to be read-only.

bool stamp_create = 4;

setStampUpdate

open fun setStampUpdate(value: Boolean): FieldPersistenceOptions.Builder

This item is a timestamp, and we would like it to be automatically updated each time the model that contains it is
modified in underlying storage. The field should be read-only.

bool stamp_update = 3;

setSummary

open fun setSummary(value: String): FieldPersistenceOptions.Builder

Summary for this field, which provides a narrative description. It should be suitable for use in external
circumstances, like documentation.

string summary = 2;

setSummaryBytes

open fun setSummaryBytes(value: ByteString): FieldPersistenceOptions.Builder

Summary for this field, which provides a narrative description. It should be suitable for use in external
circumstances, like documentation.

string summary = 2;

setType

open fun setType(value: FieldType): FieldPersistenceOptions.Builder

Field type, for special-case fields.

.elide.model.FieldType type = 1;

setTypeValue

open fun setTypeValue(value: Int): FieldPersistenceOptions.Builder

Field type, for special-case fields.

.elide.model.FieldType type = 1;

setUnknownFields

open fun setUnknownFields(unknownFields: UnknownFieldSet): BuilderT

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

setVisibility

open fun setVisibility(value: FieldVisibility): FieldPersistenceOptions.Builder

Describes the visibility level of a given field in a tree of fields. This value applies recursively under message
fields on which it is applied. Depending on the visibility level active when data is deserialized or serialized,
certain data may be withheld corresponding to the invoking user or system's access level.

.elide.model.FieldVisibility visibility = 8;

setVisibilityValue

open fun setVisibilityValue(value: Int): FieldPersistenceOptions.Builder

Describes the visibility level of a given field in a tree of fields. This value applies recursively under message
fields on which it is applied. Depending on the visibility level active when data is deserialized or serialized,
certain data may be withheld corresponding to the invoking user or system's access level.

.elide.model.FieldVisibility visibility = 8;

toString

open fun toString(): String