Stay organized with collections Save and categorize content based on your preferences.

Google.Protobuf.WellKnownTypes.Api

Api is a light-weight descriptor for a protocol buffer service.

Summary

Inheritance

Inherits from: pb::IMessage< Api >

Constructors and Destructors

Api()
Api(Api other)

Properties

Descriptor
pbr::MessageDescriptor
Descriptor
pbr::MessageDescriptor pb::IMessage.
Methods
pbc::RepeatedField< global::Google.Protobuf.WellKnownTypes.Method >
The methods of this api, in unspecified order.
Mixins
pbc::RepeatedField< global::Google.Protobuf.WellKnownTypes.Mixin >
Included APIs.
Name
string
The fully qualified name of this api, including package name followed by the api's simple name.
Options
pbc::RepeatedField< global::Google.Protobuf.WellKnownTypes.Option >
Any metadata attached to the API.
Parser
pb::MessageParser< Api >
SourceContext
global::Google.Protobuf.WellKnownTypes.SourceContext
Source context for the protocol buffer service represented by this message.
Syntax
global::Google.Protobuf.WellKnownTypes.Syntax
The source syntax of the service.
Version
string
A version string for this api.

Public attributes

MethodsFieldNumber = 2
const int
Field number for the "methods" field.
MixinsFieldNumber = 6
const int
Field number for the "mixins" field.
NameFieldNumber = 1
const int
Field number for the "name" field.
OptionsFieldNumber = 3
const int
Field number for the "options" field.
SourceContextFieldNumber = 5
const int
Field number for the "source_context" field.
SyntaxFieldNumber = 7
const int
Field number for the "syntax" field.
VersionFieldNumber = 4
const int
Field number for the "version" field.

Public functions

CalculateSize()
int
Clone()
Api
Equals(object other)
override bool
Equals(Api other)
bool
GetHashCode()
override int
MergeFrom(Api other)
void
MergeFrom(pb::CodedInputStream input)
void
ToString()
override string
WriteTo(pb::CodedOutputStream output)
void

Properties

Descriptor

pbr::MessageDescriptor Descriptor

Descriptor

pbr::MessageDescriptor pb::IMessage. Descriptor

Methods

pbc::RepeatedField< global::Google.Protobuf.WellKnownTypes.Method > Methods

The methods of this api, in unspecified order.

Mixins

pbc::RepeatedField< global::Google.Protobuf.WellKnownTypes.Mixin > Mixins

Included APIs.

See [Mixin][].

Name

string Name

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

Options

pbc::RepeatedField< global::Google.Protobuf.WellKnownTypes.Option > Options

Any metadata attached to the API.

Parser

pb::MessageParser< Api > Parser

SourceContext

global::Google.Protobuf.WellKnownTypes.SourceContext SourceContext

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

Syntax

global::Google.Protobuf.WellKnownTypes.Syntax Syntax

The source syntax of the service.

Version

string Version

A version string for this api.

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 API, which must end in v, 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, none-GA apis.

Public attributes

MethodsFieldNumber

const int MethodsFieldNumber = 2

Field number for the "methods" field.

MixinsFieldNumber

const int MixinsFieldNumber = 6

Field number for the "mixins" field.

NameFieldNumber

const int NameFieldNumber = 1

Field number for the "name" field.

OptionsFieldNumber

const int OptionsFieldNumber = 3

Field number for the "options" field.

SourceContextFieldNumber

const int SourceContextFieldNumber = 5

Field number for the "source_context" field.

SyntaxFieldNumber

const int SyntaxFieldNumber = 7

Field number for the "syntax" field.

VersionFieldNumber

const int VersionFieldNumber = 4

Field number for the "version" field.

Public functions

Api

 Api()

Api

 Api(
  Api other
)

CalculateSize

int CalculateSize()

Clone

Api Clone()

Equals

override bool Equals(
  object other
)

Equals

bool Equals(
  Api other
)

GetHashCode

override int GetHashCode()

MergeFrom

void MergeFrom(
  Api other
)

MergeFrom

void MergeFrom(
  pb::CodedInputStream input
)

ToString

override string ToString()

WriteTo

void WriteTo(
  pb::CodedOutputStream output
)