Api
class Api extends Message (View source)
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.
Generated from protobuf message google.protobuf.Api
Properties
| protected | $name | The fully qualified name of this interface, including package name followed by the interface's simple name. |
|
| protected | $version | A version string for this interface. If specified, must have the form
|
|
| protected | $source_context | Source context for the protocol buffer service represented by this message. |
|
| protected | $syntax | The source syntax of the service. |
Methods
Constructor.
Merges the contents of the specified message into current message.
Parses a json string to protobuf message.
Populates the message from a user-supplied PHP array. Array keys correspond to Message properties and nested message properties.
The fully qualified name of this interface, including package name followed by the interface's simple name.
The fully qualified name of this interface, including package name followed by the interface's simple name.
The methods of this interface, in unspecified order.
Any metadata attached to the interface.
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.
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.
Source context for the protocol buffer service represented by this message.
No description
No description
Source context for the protocol buffer service represented by this message.
Included interfaces. See [Mixin][].
The source syntax of the service.
The source syntax of the service.
Details
__construct($data = NULL)
Constructor.
protected
readWrapperValue($member)
No description
protected
writeWrapperValue($member, $value)
No description
protected
readOneof($number)
No description
protected
hasOneof($number)
No description
protected
writeOneof($number, $value)
No description
protected
whichOneof($oneof_name)
No description
clear()
Clear all containing fields.
discardUnknownFields()
Clear all unknown fields previously parsed.
mergeFrom(object $msg)
Merges the contents of the specified message into current message.
This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Map fields key-value pairs are overwritten. Singular/Oneof sub-messages are recursively merged. All overwritten sub-messages are deep-copied.
mergeFromString(string $data)
Parses a protocol buffer contained in a string.
This function takes a string in the (non-human-readable) binary wire format, matching the encoding output by serializeToString(). See mergeFrom() for merging behavior, if the field is already set in the specified message.
mergeFromJsonString(string $data, $ignore_unknown = false)
Parses a json string to protobuf message.
This function takes a string in the json wire format, matching the encoding output by serializeToJsonString(). See mergeFrom() for merging behavior, if the field is already set in the specified message.
parseFromStream($input)
No description
protected
mergeFromArray(array $array)
Populates the message from a user-supplied PHP array. Array keys correspond to Message properties and nested message properties.
Example:
$message->mergeFromArray([
'name' => 'This is a message name',
'interval' => [
'startTime' => time() - 60,
'endTime' => time(),
]
]);This method will trigger an error if it is passed data that cannot be converted to the correct type. For example, a StringValue field must receive data that is either a string or a StringValue object.
protected
mergeFromJsonArray($array, $ignore_unknown)
No description
parseFromJsonStream($input, $ignore_unknown)
No description
serializeToStream($output)
No description
serializeToJsonStream($output)
No description
string
serializeToString()
Serialize the message to string.
string
serializeToJsonString()
Serialize the message to json string.
byteSize()
No description
jsonByteSize()
No description
string
getName()
The fully qualified name of this interface, including package name followed by the interface's simple name.
Generated from protobuf field string name = 1;
$this
setName(string $var)
The fully qualified name of this interface, including package name followed by the interface's simple name.
Generated from protobuf field string name = 1;
RepeatedField
getMethods()
The methods of this interface, in unspecified order.
Generated from protobuf field repeated .google.protobuf.Method methods = 2;
$this
setMethods(Method[]|RepeatedField $var)
The methods of this interface, in unspecified order.
Generated from protobuf field repeated .google.protobuf.Method methods = 2;
RepeatedField
getOptions()
Any metadata attached to the interface.
Generated from protobuf field repeated .google.protobuf.Option options = 3;
$this
setOptions(Option[]|RepeatedField $var)
Any metadata attached to the interface.
Generated from protobuf field repeated .google.protobuf.Option options = 3;
string
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.
Generated from protobuf field string version = 4;
$this
setVersion(string $var)
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.
Generated from protobuf field string version = 4;
SourceContext|null
getSourceContext()
Source context for the protocol buffer service represented by this message.
Generated from protobuf field .google.protobuf.SourceContext source_context = 5;
hasSourceContext()
No description
clearSourceContext()
No description
$this
setSourceContext(SourceContext $var)
Source context for the protocol buffer service represented by this message.
Generated from protobuf field .google.protobuf.SourceContext source_context = 5;
RepeatedField
getMixins()
Included interfaces. See [Mixin][].
Generated from protobuf field repeated .google.protobuf.Mixin mixins = 6;
$this
setMixins(Mixin[]|RepeatedField $var)
Included interfaces. See [Mixin][].
Generated from protobuf field repeated .google.protobuf.Mixin mixins = 6;
int
getSyntax()
The source syntax of the service.
Generated from protobuf field .google.protobuf.Syntax syntax = 7;
$this
setSyntax(int $var)
The source syntax of the service.
Generated from protobuf field .google.protobuf.Syntax syntax = 7;