public sealed class Api : IMessage<Api>, IEquatable<Api>, IDeepCloneable<Api>, IBufferMessage, IMessageApi 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.WellKnownTypesAssembly
Google.Protobuf.dll
Constructors
Api()
public Api()Api(Api)
public Api(Api other)| Parameter | |
|---|---|
| Name | Description |
other | Api |
Fields
MethodsFieldNumber
public const int MethodsFieldNumber = 2Field number for the "methods" field.
| Field Value | |
|---|---|
| Type | Description |
int | |
MixinsFieldNumber
public const int MixinsFieldNumber = 6Field number for the "mixins" field.
| Field Value | |
|---|---|
| Type | Description |
int | |
NameFieldNumber
public const int NameFieldNumber = 1Field number for the "name" field.
| Field Value | |
|---|---|
| Type | Description |
int | |
OptionsFieldNumber
public const int OptionsFieldNumber = 3Field number for the "options" field.
| Field Value | |
|---|---|
| Type | Description |
int | |
SourceContextFieldNumber
public const int SourceContextFieldNumber = 5Field number for the "source_context" field.
| Field Value | |
|---|---|
| Type | Description |
int | |
SyntaxFieldNumber
public const int SyntaxFieldNumber = 7Field number for the "syntax" field.
| Field Value | |
|---|---|
| Type | Description |
int | |
VersionFieldNumber
public const int VersionFieldNumber = 4Field number for the "version" field.
| Field Value | |
|---|---|
| Type | Description |
int | |
Properties
Descriptor
public static MessageDescriptor Descriptor { get; }| Property Value | |
|---|---|
| Type | Description |
MessageDescriptor | |
Methods
public RepeatedField<Method> Methods { get; }The methods of this interface, in unspecified order.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldMethod | |
Mixins
public RepeatedField<Mixin> Mixins { get; }Included interfaces. See [Mixin][].
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldMixin | |
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.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldOption | |
Parser
public static MessageParser<Api> Parser { get; }| Property Value | |
|---|---|
| Type | Description |
MessageParserApi | |
SourceContext
public SourceContext SourceContext { get; set; }Source context for the protocol buffer service represented by this message.
| Property Value | |
|---|---|
| Type | Description |
SourceContext | |
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()Calculates the size of this message in Protocol Buffer wire format, in bytes.
| Returns | |
|---|---|
| Type | Description |
int | The number of bytes required to write this message to a coded output stream. |
Clone()
public Api Clone()Creates a deep clone of this object.
| Returns | |
|---|---|
| Type | Description |
Api | A deep clone of this object. |
Equals(Api)
public bool Equals(Api other)| Parameter | |
|---|---|
| Name | Description |
other | Api |
| Returns | |
|---|---|
| Type | Description |
bool | |
Equals(object)
public override bool Equals(object other)| Parameter | |
|---|---|
| Name | Description |
other | object |
| Returns | |
|---|---|
| Type | Description |
bool | |
GetHashCode()
public override int GetHashCode()| Returns | |
|---|---|
| Type | Description |
int | |
MergeFrom(CodedInputStream)
public void MergeFrom(CodedInputStream input)Merges the data from the specified coded input stream with the current message.
| Parameter | |
|---|---|
| Name | Description |
input | CodedInputStream |
See the user guide for precise merge semantics.
MergeFrom(Api)
public void MergeFrom(Api other)Merges the given message into this one.
| Parameter | |
|---|---|
| Name | Description |
other | Api |
See the user guide for precise merge semantics.
ToString()
public override string ToString()| Returns | |
|---|---|
| Type | Description |
string | |
WriteTo(CodedOutputStream)
public void WriteTo(CodedOutputStream output)Writes the data to the given coded output stream.
| Parameter | |
|---|---|
| Name | Description |
output | CodedOutputStreamCoded output stream to write the data to. Must not be null. |