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

Api

Api is a light-weight descriptor for an API Interface.

Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology.

Properties

methods

abstract val methods: List<Method>

The methods of this interface, in unspecified order.

mixins

abstract val mixins: List<Mixin>

Included interfaces. See Mixin.

name

abstract val name: String

The fully qualified name of this interface, including package name followed by the interface's simple name.

options

abstract val options: List<Option>

Any metadata attached to the interface.

presence

val Api.presence: ApiPresence

Returns the field-presence view for this com.google.protobuf.kotlin.Api instance.

sourceContext

abstract val sourceContext: SourceContext

Source context for the protocol buffer service represented by this message.

syntax

abstract val syntax: Syntax

The source syntax of the service.

version

abstract val version: String

A version string for this interface. If specified, must have the form major-version.minor-version, as in 1.10. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here.

Functions

copy

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

Copies the original message, including unknown fields.