Api
class Api extends Message
Api is a light-weight descriptor for a protocol buffer service.
Protobuf type Google\Protobuf\Api
Methods
No description
The fully qualified name of this api, including package name followed by the api's simple name.
The fully qualified name of this api, including package name followed by the api's simple name.
The methods of this api, in unspecified order.
The methods of this api, in unspecified order.
Any metadata attached to the API.
Any metadata attached to the API.
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.
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.
Source context for the protocol buffer service represented by this message.
Source context for the protocol buffer service represented by this message.
Included APIs. See [Mixin][].
Included APIs. See [Mixin][].
The source syntax of the service.
The source syntax of the service.
Details
at line 80
__construct()
at line 92
string
getName()
The fully qualified name of this api, including package name followed by the api's simple name.
Generated from protobuf field string name = 1;
at line 104
setName(string $var)
The fully qualified name of this api, including package name followed by the api's simple name.
Generated from protobuf field string name = 1;
at line 116
RepeatedField
getMethods()
The methods of this api, in unspecified order.
Generated from protobuf field repeated .google.protobuf.Method methods = 2;
at line 127
setMethods(array|RepeatedField $var)
The methods of this api, in unspecified order.
Generated from protobuf field repeated .google.protobuf.Method methods = 2;
at line 139
RepeatedField
getOptions()
Any metadata attached to the API.
Generated from protobuf field repeated .google.protobuf.Option options = 3;
at line 150
setOptions(array|RepeatedField $var)
Any metadata attached to the API.
Generated from protobuf field repeated .google.protobuf.Option options = 3;
at line 179
string
getVersion()
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<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, none-GA apis.
Generated from protobuf field string version = 4;
at line 207
setVersion(string $var)
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<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, none-GA apis.
Generated from protobuf field string version = 4;
at line 220
SourceContext
getSourceContext()
Source context for the protocol buffer service represented by this message.
Generated from protobuf field .google.protobuf.SourceContext source_context = 5;
at line 232
setSourceContext(SourceContext $var)
Source context for the protocol buffer service represented by this message.
Generated from protobuf field .google.protobuf.SourceContext source_context = 5;
at line 244
RepeatedField
getMixins()
Included APIs. See [Mixin][].
Generated from protobuf field repeated .google.protobuf.Mixin mixins = 6;
at line 255
setMixins(array|RepeatedField $var)
Included APIs. See [Mixin][].
Generated from protobuf field repeated .google.protobuf.Mixin mixins = 6;
at line 267
int
getSyntax()
The source syntax of the service.
Generated from protobuf field .google.protobuf.Syntax syntax = 7;
at line 278
setSyntax(int $var)
The source syntax of the service.
Generated from protobuf field .google.protobuf.Syntax syntax = 7;