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

FieldDescriptorProto

interface FieldDescriptorProto(source)

Describes a field within a message.

Types

Label

sealed class Label(val number: Int)

Type

sealed class Type(val number: Int)

Properties

defaultValue

abstract val defaultValue: String

For numeric types, contains the original text representation of the value. For booleans, "true" or "false". For strings, contains the default text contents (not escaped in any way). For bytes, contains the C escaped value. All bytes >= 128 are escaped.

defaultValueOrNull

val FieldDescriptorProto.defaultValueOrNull: String?

Returns the value of the defaultValue field if present, otherwise null.

extendee

abstract val extendee: String

For extensions, this is the name of the type being extended. It is resolved in the same manner as type_name.

extendeeOrNull

val FieldDescriptorProto.extendeeOrNull: String?

Returns the value of the extendee field if present, otherwise null.

jsonName

abstract val jsonName: String

JSON name of this field. The value is set by protocol compiler. If the user has set a "json_name" option on this field, that option's value will be used. Otherwise, it's deduced from the field's name by converting it to camelCase.

jsonNameOrNull

val FieldDescriptorProto.jsonNameOrNull: String?

Returns the value of the jsonName field if present, otherwise null.

label

abstract val label: FieldDescriptorProto.Label

labelOrNull

val FieldDescriptorProto.labelOrNull: FieldDescriptorProto.Label?

Returns the value of the label field if present, otherwise null.

name

abstract val name: String

nameOrNull

val FieldDescriptorProto.nameOrNull: String?

Returns the value of the name field if present, otherwise null.

number

abstract val number: Int

numberOrNull

val FieldDescriptorProto.numberOrNull: Int?

Returns the value of the number field if present, otherwise null.

oneofIndex

abstract val oneofIndex: Int

If set, gives the index of a oneof in the containing type's oneof_decl list. This field is a member of that oneof.

oneofIndexOrNull

val FieldDescriptorProto.oneofIndexOrNull: Int?

Returns the value of the oneofIndex field if present, otherwise null.

options

abstract val options: FieldOptions

optionsOrNull

val FieldDescriptorProto.optionsOrNull: FieldOptions?

Returns the value of the options field if present, otherwise null.

presence

val FieldDescriptorProto.presence: FieldDescriptorProtoPresence

Returns the field-presence view for this FieldDescriptorProto instance.

proto3Optional

abstract val proto3Optional: Boolean

If true, this is a proto3 "optional". When a proto3 field is optional, it tracks presence regardless of field type.

proto3OptionalOrNull

val FieldDescriptorProto.proto3OptionalOrNull: Boolean?

Returns the value of the proto3Optional field if present, otherwise null.

type

abstract val type: FieldDescriptorProto.Type

If type_name is set, this need not be set. If both this and type_name are set, this must be one of TYPE_ENUM, TYPE_MESSAGE or TYPE_GROUP.

typeName

abstract val typeName: String

For message and enum types, this is the name of the type. If the name starts with a '.', it is fully-qualified. Otherwise, C++-like scoping rules are used to find the type (i.e. first the nested types within this message are searched, then within the parent, on up to the root namespace).

typeNameOrNull

val FieldDescriptorProto.typeNameOrNull: String?

Returns the value of the typeName field if present, otherwise null.

typeOrNull

val FieldDescriptorProto.typeOrNull: FieldDescriptorProto.Type?

Returns the value of the type field if present, otherwise null.

Functions

copy

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

Copies the original message, including unknown fields.