graalvm/tools.elide.model/FieldPersistenceOptions

FieldPersistenceOptions

class FieldPersistenceOptions : GeneratedMessage, FieldPersistenceOptionsOrBuilder

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

Protobuf type elide.model.FieldPersistenceOptions

Types

Builder

class Builder : GeneratedMessage.Builder<BuilderT> , FieldPersistenceOptionsOrBuilder

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

Protobuf type elide.model.FieldPersistenceOptions

Properties

DESCRIPTION_FIELD_NUMBER

val DESCRIPTION_FIELD_NUMBER: Int = 9

EXPLICIT_FIELD_NUMBER

val EXPLICIT_FIELD_NUMBER: Int = 7

IMMUTABLE_FIELD_NUMBER

val IMMUTABLE_FIELD_NUMBER: Int = 6

READ_ONLY_FIELD_NUMBER

val READ_ONLY_FIELD_NUMBER: Int = 5

STAMP_CREATE_FIELD_NUMBER

val STAMP_CREATE_FIELD_NUMBER: Int = 4

STAMP_UPDATE_FIELD_NUMBER

val STAMP_UPDATE_FIELD_NUMBER: Int = 3

SUMMARY_FIELD_NUMBER

val SUMMARY_FIELD_NUMBER: Int = 2

TYPE_FIELD_NUMBER

val TYPE_FIELD_NUMBER: Int = 1

VISIBILITY_FIELD_NUMBER

val VISIBILITY_FIELD_NUMBER: Int = 8

Functions

copy

inline fun FieldPersistenceOptions.copy(block: FieldPersistenceOptionsKt.Dsl.() -> Unit): FieldPersistenceOptions

equals

open fun equals(obj: Any): Boolean

findInitializationErrors

open fun findInitializationErrors(): List<String>

getAllFields

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

getDefaultInstance

open fun getDefaultInstance(): FieldPersistenceOptions

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

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

getParserForType

abstract fun getParserForType(): Parser<out Message>

abstract fun getParserForType(): Parser<out MessageLite>

open fun getParserForType(): Parser<FieldPersistenceOptions>

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

getRepeatedFieldCount

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

getSerializedSize

open fun getSerializedSize(): 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

open 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

hashCode

open fun hashCode(): Int

hasOneof

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

isInitialized

fun isInitialized(): Boolean

newBuilder

open fun newBuilder(): FieldPersistenceOptions.Builder

open fun newBuilder(prototype: FieldPersistenceOptions): FieldPersistenceOptions.Builder

newBuilderForType

open fun newBuilderForType(): FieldPersistenceOptions.Builder

newFileScopedGeneratedExtension

open fun <ContainingT : Message?, T> newFileScopedGeneratedExtension(singularType: Class<out Any>, defaultInstance: Message): GeneratedMessage.GeneratedExtension<ContainingT, T>

newMessageScopedGeneratedExtension

open fun <ContainingT : Message?, T> newMessageScopedGeneratedExtension(scope: Message, descriptorIndex: Int, singularType: Class<out Any>, defaultInstance: Message): GeneratedMessage.GeneratedExtension<ContainingT, T>

parseDelimitedFrom

open fun parseDelimitedFrom(input: InputStream): FieldPersistenceOptions

open fun parseDelimitedFrom(input: InputStream, extensionRegistry: ExtensionRegistryLite): FieldPersistenceOptions

parseFrom

open fun parseFrom(data: Array<Byte>): FieldPersistenceOptions

open fun parseFrom(data: ByteString): FieldPersistenceOptions

open fun parseFrom(input: CodedInputStream): FieldPersistenceOptions

open fun parseFrom(input: InputStream): FieldPersistenceOptions

open fun parseFrom(data: ByteBuffer): FieldPersistenceOptions

open fun parseFrom(data: Array<Byte>, extensionRegistry: ExtensionRegistryLite): FieldPersistenceOptions

open fun parseFrom(data: ByteString, extensionRegistry: ExtensionRegistryLite): FieldPersistenceOptions

open fun parseFrom(input: CodedInputStream, extensionRegistry: ExtensionRegistryLite): FieldPersistenceOptions

open fun parseFrom(input: InputStream, extensionRegistry: ExtensionRegistryLite): FieldPersistenceOptions

open fun parseFrom(data: ByteBuffer, extensionRegistry: ExtensionRegistryLite): FieldPersistenceOptions

parser

open fun parser(): Parser<FieldPersistenceOptions>

toBuilder

open fun toBuilder(): FieldPersistenceOptions.Builder

toByteArray

open fun toByteArray(): Array<Byte>

toByteString

open fun toByteString(): ByteString

toString

fun toString(): String

writeDelimitedTo

open fun writeDelimitedTo(output: OutputStream)

writeTo

open fun writeTo(output: CodedOutputStream)