Api class

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. New usages of this message as an alternative to ServiceDescriptorProto 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.

Constructors

Api.new({String? edition, List<Method>? methods, List<Mixin>? mixins, String? name, List<Option>? options, SourceContext? sourceContext, String? syntax, String? version})

Api.fromJson(Map json_)

Properties

edition ↔ String?

The source edition string, only valid when syntax is SYNTAX_EDITIONS.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

methods ↔ List<Method>?

The methods of this interface, in unspecified order.

getter/setter pair

mixins ↔ List<Mixin>?

Included interfaces.

getter/setter pair

name ↔ String?

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

getter/setter pair

options ↔ List<Option>?

Any metadata attached to the interface.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

sourceContext ↔ SourceContext?

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

getter/setter pair

syntax ↔ String?

The source syntax of the service. Possible string values are:

getter/setter pair

version ↔ String?

A version string for this interface.

getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited