wire-schema/com.squareup.wire.schema/Field

Field

data class Field(val namespaces: List<String>, val location: Location, val label: Field.Label?, val name: String, val documentation: String, val tag: Int, val default: String?, elementType: String, val options: Options, val isExtension: Boolean, val isOneOf: Boolean, val declaredJsonName: String?)

Constructors

Field

constructor(namespaces: List<String>, location: Location, label: Field.Label?, name: String, documentation: String, tag: Int, default: String?, elementType: String, options: Options, isExtension: Boolean, isOneOf: Boolean, declaredJsonName: String?)

Types

Companion

object Companion

EncodeMode

enum EncodeMode : Enum<Field.EncodeMode>

Label

enum Label : Enum<Field.Label>

Properties

declaredJsonName

val declaredJsonName: String?

default

val default: String?

documentation

val documentation: String

encodeMode

var encodeMode: Field.EncodeMode?

isDeprecated

val isDeprecated: Boolean

isExtension

val isExtension: Boolean

isOneOf

val isOneOf: Boolean

isPacked

val isPacked: Boolean

isRedacted

var isRedacted: Boolean

isRepeated

val isRepeated: Boolean

isRequired

val isRequired: Boolean

jsonName

var jsonName: String?

label

val label: Field.Label?

May be null for proto3 fields, one-of's, or maps.

location

val location: Location

name

val name: String

namespaces

val namespaces: List<String>

The namespaces in which the field is defined. For top-level extensions in a file that has no package declaration, this may be empty. For normal fields and extensions nested inside a message, the first entry will always be the package name, which might be the empty string if defined in a file that has no package declaration. Subsequent entries will be the names of enclosing messages, outer-most to inner-most.

options

val options: Options

packageName

val packageName: String

Returns the package in which this field is defined. If the file that defined this field has no package declaration, returns the empty string.

qualifiedName

val qualifiedName: String

Returns this field's name, prefixed with its namespaces. Uniquely identifies extension fields, such as in options.

tag

val tag: Int

type

var type: ProtoType?