kotlinx-rpc-protobuf-wkt/com.google.protobuf.kotlin/Field

Field

interface Field(source)

A single field of a message type.

New usages of this message as an alternative to FieldDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.

Types

sealed class Cardinality(val number: Int)

Whether a field is optional, required, or repeated.

sealed class Kind(val number: Int)

Basic field types.

Properties

abstract val cardinality: Field.Cardinality

The field cardinality.

abstract val defaultValue: String

The string value of the default value of this field. Proto2 syntax only.

abstract val jsonName: String

The field JSON name.

abstract val kind: Field.Kind

The field type.

abstract val name: String

The field name.

abstract val number: Int

The field number.

abstract val oneofIndex: Int

The index of the field type in Type.oneofs, for message or enumeration types. The first type has index 1; zero means the type is not in the list.

abstract val options: List<Option>

The protocol buffer options.

abstract val packed: Boolean

Whether to use alternative packed wire representation.

abstract val typeUrl: String

The field type URL, without the scheme, for message or enumeration types. Example: "type.googleapis.com/google.protobuf.Timestamp".

Functions

fun Field.copy(body: ERROR CLASS: Symbol not found for Field.Builder.() -> Unit = {}): Field

Copies the original message, including unknown fields.