Class Api

public sealed class Api : object, IMessage<Api>, IEquatable<Api>, IDeepCloneable<Api>, IBufferMessage, IMessage

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.

Inheritance

Object > Api

Implements

IMessage<Api>, IEquatable<Api>, IDeepCloneable<Api>, IBufferMessage, IMessage

Namespace

Google.Protobuf.WellKnownTypes

Assembly

Google.Protobuf.dll

Constructors

Api()

public Api()

Api(Api)

public Api(Api other)
Parameter
TypeNameDescription
Apiother

Fields

MethodsFieldNumber

public const int MethodsFieldNumber = null

Field number for the "methods" field.

Field Value
TypeDescription
Int32

MixinsFieldNumber

public const int MixinsFieldNumber = null

Field number for the "mixins" field.

Field Value
TypeDescription
Int32

NameFieldNumber

public const int NameFieldNumber = null

Field number for the "name" field.

Field Value
TypeDescription
Int32

OptionsFieldNumber

public const int OptionsFieldNumber = null

Field number for the "options" field.

Field Value
TypeDescription
Int32

SourceContextFieldNumber

public const int SourceContextFieldNumber = null

Field number for the "source_context" field.

Field Value
TypeDescription
Int32

SyntaxFieldNumber

public const int SyntaxFieldNumber = null

Field number for the "syntax" field.

Field Value
TypeDescription
Int32

VersionFieldNumber

public const int VersionFieldNumber = null

Field number for the "version" field.

Field Value
TypeDescription
Int32

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }
Property Value
TypeDescription
MessageDescriptor

Methods

public RepeatedField<Method> Methods { get; }

The methods of this interface, in unspecified order.

Property Value
TypeDescription
RepeatedField<Method>

Mixins

public RepeatedField<Mixin> Mixins { get; }

Included interfaces. See [Mixin][].

Property Value
TypeDescription
RepeatedField<Mixin>

Name

public string Name { get; set; }

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

Property Value
TypeDescription
String

Options

public RepeatedField<Option> Options { get; }

Any metadata attached to the interface.

Property Value
TypeDescription
RepeatedField<Option>

Parser

public static MessageParser<Api> Parser { get; }
Property Value
TypeDescription
MessageParser<Api>

SourceContext

public SourceContext SourceContext { get; set; }

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

Property Value
TypeDescription
SourceContext

Syntax

public Syntax Syntax { get; set; }

The source syntax of the service.

Property Value
TypeDescription
Syntax

Version

public string Version { get; set; }

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.

The versioning schema uses semantic versioning where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan.

The major version is also reflected in the package name of the interface, which must end in v&lt;major-version>, as in google.feature.v1. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces.

Property Value
TypeDescription
String

Methods

CalculateSize()

public int CalculateSize()
Returns
TypeDescription
Int32

Clone()

public Api Clone()
Returns
TypeDescription
Api

Equals(Api)

public bool Equals(Api other)
Parameter
TypeNameDescription
Apiother
Returns
TypeDescription
Boolean

Equals(Object)

public override bool Equals(object other)
Parameter
TypeNameDescription
Objectother
Returns
TypeDescription
Boolean

GetHashCode()

public override int GetHashCode()
Returns
TypeDescription
Int32

MergeFrom(CodedInputStream)

public void MergeFrom(CodedInputStream input)
Parameter
TypeNameDescription
CodedInputStreaminput

MergeFrom(Api)

public void MergeFrom(Api other)
Parameter
TypeNameDescription
Apiother

ToString()

public override string ToString()
Returns
TypeDescription
String

WriteTo(CodedOutputStream)

public void WriteTo(CodedOutputStream output)
Parameter
TypeNameDescription
CodedOutputStreamoutput

Explicit Interface Implementations

IBufferMessage.InternalMergeFrom(ref ParseContext)

void IBufferMessage.InternalMergeFrom(ref ParseContext input)
Parameter
TypeNameDescription
ParseContextinput

IBufferMessage.InternalWriteTo(ref WriteContext)

void IBufferMessage.InternalWriteTo(ref WriteContext output)
Parameter
TypeNameDescription
WriteContextoutput

IMessage.Descriptor

MessageDescriptor IMessage.Descriptor { get; }
Returns
TypeDescription
MessageDescriptor

Implements

IEquatable<>