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.
Namespace
Google.Protobuf.WellKnownTypes
Assembly
Google.Protobuf.dll
Constructors
Api()
Api(Api)
| Parameter |
|---|
| Name | Description |
other | Api
|
Fields
MethodsFieldNumber
public const int MethodsFieldNumber = null
Field number for the "methods" field.
| Field Value |
|---|
| Type | Description |
Int32 | |
MixinsFieldNumber
public const int MixinsFieldNumber = null
Field number for the "mixins" field.
| Field Value |
|---|
| Type | Description |
Int32 | |
NameFieldNumber
public const int NameFieldNumber = null
Field number for the "name" field.
| Field Value |
|---|
| Type | Description |
Int32 | |
OptionsFieldNumber
public const int OptionsFieldNumber = null
Field number for the "options" field.
| Field Value |
|---|
| Type | Description |
Int32 | |
SourceContextFieldNumber
public const int SourceContextFieldNumber = null
Field number for the "source_context" field.
| Field Value |
|---|
| Type | Description |
Int32 | |
SyntaxFieldNumber
public const int SyntaxFieldNumber = null
Field number for the "syntax" field.
| Field Value |
|---|
| Type | Description |
Int32 | |
VersionFieldNumber
public const int VersionFieldNumber = null
Field number for the "version" field.
| Field Value |
|---|
| Type | Description |
Int32 | |
Properties
Descriptor
public static MessageDescriptor Descriptor { get; }
Methods
public RepeatedField<Method> Methods { get; }
The methods of this interface, in unspecified order.
Mixins
public RepeatedField<Mixin> Mixins { get; }
Included interfaces. See [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 |
|---|
| Type | Description |
String | |
Options
public RepeatedField<Option> Options { get; }
Any metadata attached to the interface.
Parser
public static MessageParser<Api> Parser { get; }
SourceContext
public SourceContext SourceContext { get; set; }
Source context for the protocol buffer service represented by this
message.
Syntax
public Syntax Syntax { get; set; }
The source syntax of the service.
| Property Value |
|---|
| Type | Description |
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<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 |
|---|
| Type | Description |
String | |
Methods
CalculateSize()
public int CalculateSize()
| Returns |
|---|
| Type | Description |
Int32 | |
Clone()
| Returns |
|---|
| Type | Description |
Api | |
Equals(Api)
public bool Equals(Api other)
| Parameter |
|---|
| Name | Description |
other | Api
|
Equals(Object)
public override bool Equals(object other)
| Parameter |
|---|
| Name | Description |
other | Object
|
GetHashCode()
public override int GetHashCode()
| Returns |
|---|
| Type | Description |
Int32 | |
public void MergeFrom(CodedInputStream input)
MergeFrom(Api)
public void MergeFrom(Api other)
| Parameter |
|---|
| Name | Description |
other | Api
|
ToString()
public override string ToString()
WriteTo(CodedOutputStream)
public void WriteTo(CodedOutputStream output)
Explicit Interface Implementations
IBufferMessage.InternalMergeFrom(ref ParseContext)
void IBufferMessage.InternalMergeFrom(ref ParseContext input)
IBufferMessage.InternalWriteTo(ref WriteContext)
void IBufferMessage.InternalWriteTo(ref WriteContext output)
IMessage.Descriptor
MessageDescriptor IMessage.Descriptor { get; }
