proto library Client - Class Api (v5.36.2)

Reference documentation and code samples for the proto library Client class Api.

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. New usages of this message as an alternative to ServiceDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.

Generated from protobuf message google.protobuf.Api

Namespace

Google \ Protobuf

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` The fully qualified name of this interface, including package name followed by the interface's simple name.
`↳ methods`	`array<Method>` The methods of this interface, in unspecified order.
`↳ options`	`array<Option>` Any metadata attached to the interface.
`↳ version`	`string` 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.
`↳ source_context`	`SourceContext` Source context for the protocol buffer service represented by this message.
`↳ mixins`	`array<Mixin>` Included interfaces. See Mixin.
`↳ syntax`	`int` The source syntax of the service.
`↳ edition`	`string` The source edition string, only valid when syntax is SYNTAX_EDITIONS.

getName

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

Returns
Type	Description
`string`

setName

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getMethods

The methods of this interface, in unspecified order.

Returns
Type	Description
`RepeatedField<Method>`

setMethods

The methods of this interface, in unspecified order.

Parameter
Name	Description
`var`	`array<Method>`

Returns
Type	Description
`$this`

getOptions

Any metadata attached to the interface.

Returns
Type	Description
`RepeatedField<Option>`

setOptions

Any metadata attached to the interface.

Parameter
Name	Description
`var`	`array<Option>`

Returns
Type	Description
`$this`

getVersion

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.

Returns
Type	Description
`string`

setVersion

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSourceContext

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

Returns
Type	Description
`SourceContext\|null`

hasSourceContext

clearSourceContext

setSourceContext