class MethodDescriptorProto extends Message (View source)

Describes a method of a service.

Generated from protobuf message google.protobuf.MethodDescriptorProto

Properties

protected $name

Generated from protobuf field optional string name = 1;

protected $input_type

Input and output type names. These are resolved in the same way as FieldDescriptorProto.type_name, but must refer to a message type.

protected $output_type

Generated from protobuf field optional string output_type = 3;

protected $options

Generated from protobuf field optional .google.protobuf.MethodOptions options = 4;

protected $client_streaming

Identifies if client streams multiple client messages

protected $server_streaming

Identifies if server streams multiple server messages

Methods

__construct($data = NULL)

Constructor.

readWrapperValue($member)

No description

from  Message
writeWrapperValue($member, $value)

No description

from  Message
readOneof($number)

No description

from  Message
hasOneof($number)

No description

from  Message
writeOneof($number, $value)

No description

from  Message
whichOneof($oneof_name)

No description

from  Message
clear()

Clear all containing fields.

from  Message
discardUnknownFields()

Clear all unknown fields previously parsed.

from  Message
mergeFrom(object $msg)

Merges the contents of the specified message into current message.

from  Message
mergeFromString(string $data)

Parses a protocol buffer contained in a string.

from  Message
mergeFromJsonString(string $data, $ignore_unknown = false)

Parses a json string to protobuf message.

from  Message
parseFromStream($input)

No description

from  Message
mergeFromArray(array $array)

Populates the message from a user-supplied PHP array. Array keys correspond to Message properties and nested message properties.

from  Message
mergeFromJsonArray($array, $ignore_unknown)

No description

from  Message
parseFromJsonStream($input, $ignore_unknown)

No description

from  Message
serializeToStream($output)

No description

from  Message
serializeToJsonStream($output)

No description

from  Message
string
serializeToString()

Serialize the message to string.

from  Message
string
serializeToJsonString()

Serialize the message to json string.

from  Message
byteSize()

No description

from  Message
jsonByteSize()

No description

from  Message
string
getName()

Generated from protobuf field optional string name = 1;

hasName()

No description

clearName()

No description

$this
setName(string $var)

Generated from protobuf field optional string name = 1;

string
getInputType()

Input and output type names. These are resolved in the same way as FieldDescriptorProto.type_name, but must refer to a message type.

hasInputType()

No description

clearInputType()

No description

$this
setInputType(string $var)

Input and output type names. These are resolved in the same way as FieldDescriptorProto.type_name, but must refer to a message type.

string
getOutputType()

Generated from protobuf field optional string output_type = 3;

hasOutputType()

No description

clearOutputType()

No description

$this
setOutputType(string $var)

Generated from protobuf field optional string output_type = 3;

getOptions()

Generated from protobuf field optional .google.protobuf.MethodOptions options = 4;

hasOptions()

No description

clearOptions()

No description

$this
setOptions(MethodOptions $var)

Generated from protobuf field optional .google.protobuf.MethodOptions options = 4;

bool
getClientStreaming()

Identifies if client streams multiple client messages

hasClientStreaming()

No description

clearClientStreaming()

No description

$this
setClientStreaming(bool $var)

Identifies if client streams multiple client messages

bool
getServerStreaming()

Identifies if server streams multiple server messages

hasServerStreaming()

No description

clearServerStreaming()

No description

$this
setServerStreaming(bool $var)

Identifies if server streams multiple server messages

Details

__construct($data = NULL)

Constructor.

Parameters

$data

protected readWrapperValue($member)

No description

Parameters

$member

protected writeWrapperValue($member, $value)

No description

Parameters

$member
$value

protected readOneof($number)

No description

Parameters

$number

protected hasOneof($number)

No description

Parameters

$number

protected writeOneof($number, $value)

No description

Parameters

$number
$value

protected whichOneof($oneof_name)

No description

Parameters

$oneof_name

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.

Parameters

object $msg

Protobuf message to be merged from.

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.

Parameters

string $data

Binary protobuf data.

Exceptions

Exception

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.

Parameters

string $data

Json protobuf data.

$ignore_unknown

Exceptions

Exception

parseFromStream($input)

No description

Parameters

$input

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.

Parameters

array $array

An array containing message properties and values.

protected mergeFromJsonArray($array, $ignore_unknown)

No description

Parameters

$array
$ignore_unknown

parseFromJsonStream($input, $ignore_unknown)

No description

Parameters

$input
$ignore_unknown

serializeToStream($output)

No description

Parameters

$output

serializeToJsonStream($output)

No description

Parameters

$output

string serializeToString()

Serialize the message to string.

Return Value

string

Serialized binary protobuf data.

string serializeToJsonString()

Serialize the message to json string.

Return Value

string

Serialized json protobuf data.

byteSize()

No description

jsonByteSize()

No description

string getName()

Generated from protobuf field optional string name = 1;

Return Value

string

hasName()

No description

clearName()

No description

$this setName(string $var)

Generated from protobuf field optional string name = 1;

Parameters

string $var

Return Value

$this

string getInputType()

Input and output type names. These are resolved in the same way as FieldDescriptorProto.type_name, but must refer to a message type.

Generated from protobuf field optional string input_type = 2;

Return Value

string

hasInputType()

No description

clearInputType()

No description

$this setInputType(string $var)

Input and output type names. These are resolved in the same way as FieldDescriptorProto.type_name, but must refer to a message type.

Generated from protobuf field optional string input_type = 2;

Parameters

string $var

Return Value

$this

string getOutputType()

Generated from protobuf field optional string output_type = 3;

Return Value

string

hasOutputType()

No description

clearOutputType()

No description

$this setOutputType(string $var)

Generated from protobuf field optional string output_type = 3;

Parameters

string $var

Return Value

$this

MethodOptions|null getOptions()

Generated from protobuf field optional .google.protobuf.MethodOptions options = 4;

Return Value

MethodOptions|null

hasOptions()

No description

clearOptions()

No description

$this setOptions(MethodOptions $var)

Generated from protobuf field optional .google.protobuf.MethodOptions options = 4;

Parameters

MethodOptions $var

Return Value

$this

bool getClientStreaming()

Identifies if client streams multiple client messages

Generated from protobuf field optional bool client_streaming = 5 [default = false];

Return Value

bool

hasClientStreaming()

No description

clearClientStreaming()

No description

$this setClientStreaming(bool $var)

Identifies if client streams multiple client messages

Generated from protobuf field optional bool client_streaming = 5 [default = false];

Parameters

bool $var

Return Value

$this

bool getServerStreaming()

Identifies if server streams multiple server messages

Generated from protobuf field optional bool server_streaming = 6 [default = false];

Return Value

bool

hasServerStreaming()

No description

clearServerStreaming()

No description

$this setServerStreaming(bool $var)

Identifies if server streams multiple server messages

Generated from protobuf field optional bool server_streaming = 6 [default = false];

Parameters

bool $var

Return Value

$this