Method
class Method extends Message (View source)
Method represents a method of an API interface.
Generated from protobuf message google.protobuf.Method
Properties
| protected | $name | The simple name of this method. |
|
| protected | $request_type_url | A URL of the input message type. |
|
| protected | $request_streaming | If true, the request is streamed. |
|
| protected | $response_type_url | The URL of the output message type. |
|
| protected | $response_streaming | If true, the response is streamed. |
|
| protected | $syntax | The source syntax of this method. |
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 simple name of this method.
The simple name of this method.
A URL of the input message type.
A URL of the input message type.
If true, the request is streamed.
If true, the request is streamed.
The URL of the output message type.
The URL of the output message type.
If true, the response is streamed.
If true, the response is streamed.
Any metadata attached to the method.
The source syntax of this method.
The source syntax of this method.
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 simple name of this method.
Generated from protobuf field string name = 1;
$this
setName(string $var)
The simple name of this method.
Generated from protobuf field string name = 1;
string
getRequestTypeUrl()
A URL of the input message type.
Generated from protobuf field string request_type_url = 2;
$this
setRequestTypeUrl(string $var)
A URL of the input message type.
Generated from protobuf field string request_type_url = 2;
bool
getRequestStreaming()
If true, the request is streamed.
Generated from protobuf field bool request_streaming = 3;
$this
setRequestStreaming(bool $var)
If true, the request is streamed.
Generated from protobuf field bool request_streaming = 3;
string
getResponseTypeUrl()
The URL of the output message type.
Generated from protobuf field string response_type_url = 4;
$this
setResponseTypeUrl(string $var)
The URL of the output message type.
Generated from protobuf field string response_type_url = 4;
bool
getResponseStreaming()
If true, the response is streamed.
Generated from protobuf field bool response_streaming = 5;
$this
setResponseStreaming(bool $var)
If true, the response is streamed.
Generated from protobuf field bool response_streaming = 5;
RepeatedField
getOptions()
Any metadata attached to the method.
Generated from protobuf field repeated .google.protobuf.Option options = 6;
$this
setOptions(Option[]|RepeatedField $var)
Any metadata attached to the method.
Generated from protobuf field repeated .google.protobuf.Option options = 6;
int
getSyntax()
The source syntax of this method.
Generated from protobuf field .google.protobuf.Syntax syntax = 7;
$this
setSyntax(int $var)
The source syntax of this method.
Generated from protobuf field .google.protobuf.Syntax syntax = 7;