1. class
  2. Google
  3. \
  4. Protobuf
  5. \
  6. Method

Method

class Method extends Message (View source)

Method represents a method of an API interface.

New usages of this message as an alternative to MethodDescriptorProto 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.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 deprecated $syntax

The source syntax of this method.
protected deprecated $edition

The source edition string, only valid when syntax is SYNTAX_EDITIONS.

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
null
clear()

Clear all containing fields.

from  Message
null
discardUnknownFields()

Clear all unknown fields previously parsed.

from  Message
null
mergeFrom(object $msg)

Merges the contents of the specified message into current message.

from  Message
null
mergeFromString(string $data)

Parses a protocol buffer contained in a string.

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

Parses a json string to protobuf message.

from  Message
parseFromStream($input)

No description

from  Message
null
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($options = 0)

Serialize the message to json string.

from  Message
byteSize()

No description

from  Message
jsonByteSize($options = 0)

No description

from  Message
__debugInfo()

No description

from  Message
string
getName()

The simple name of this method.

$this
setName(string $var)

The simple name of this method.

string
getRequestTypeUrl()

A URL of the input message type.

$this
setRequestTypeUrl(string $var)

A URL of the input message type.

bool
getRequestStreaming()

If true, the request is streamed.

$this
setRequestStreaming(bool $var)

If true, the request is streamed.

string
getResponseTypeUrl()

The URL of the output message type.

$this
setResponseTypeUrl(string $var)

The URL of the output message type.

bool
getResponseStreaming()

If true, the response is streamed.

$this
setResponseStreaming(bool $var)

If true, the response is streamed.

Option>
getOptions()

Any metadata attached to the method.

$this
setOptions(Option[] $var)

Any metadata attached to the method.

int
getSyntax() deprecated

The source syntax of this method.

$this
setSyntax(int $var) deprecated

The source syntax of this method.

string
getEdition() deprecated

The source edition string, only valid when syntax is SYNTAX_EDITIONS.

$this
setEdition(string $var) deprecated

The source edition string, only valid when syntax is SYNTAX_EDITIONS.

Details

at line 106
__construct($data = NULL)

Constructor.

Parameters

$data

in Message at line 158
protected readWrapperValue($member)

No description

Parameters

$member

in Message at line 175
protected writeWrapperValue($member, $value)

No description

Parameters

$member
$value

in Message at line 194
protected readOneof($number)

No description

Parameters

$number

in Message at line 207
protected hasOneof($number)

No description

Parameters

$number

in Message at line 216
protected writeOneof($number, $value)

No description

Parameters

$number
$value

in Message at line 231
protected whichOneof($oneof_name)

No description

Parameters

$oneof_name

in Message at line 527
null clear()

Clear all containing fields.

Return Value

null

in Message at line 637
null discardUnknownFields()

Clear all unknown fields previously parsed.

Return Value

null

in Message at line 683
null 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.

Return Value

null

in Message at line 751
null 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.

Return Value

null

Exceptions

Exception

in Message at line 770
null mergeFromJsonString(string $data, bool $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.
bool $ignore_unknown

Return Value

null

Exceptions

Exception

in Message at line 779
parseFromStream($input)

No description

Parameters

$input

in Message at line 1037
protected null 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.

Return Value

null

in Message at line 1126
protected mergeFromJsonArray($array, $ignore_unknown)

No description

Parameters

$array
$ignore_unknown

in Message at line 1322
parseFromJsonStream($input, $ignore_unknown)

No description

Parameters

$input
$ignore_unknown

in Message at line 1455
serializeToStream($output)

No description

Parameters

$output

in Message at line 1470
serializeToJsonStream($output)

No description

Parameters

$output

in Message at line 1562
string serializeToString()

Serialize the message to string.

Return Value

string

Serialized binary protobuf data.

in Message at line 1573
string serializeToJsonString($options = 0)

Serialize the message to json string.

Parameters

$options

Return Value

string

Serialized json protobuf data.

in Message at line 1941
byteSize()

No description

in Message at line 1982
jsonByteSize($options = 0)

No description

Parameters

$options

in Message at line 2057
__debugInfo()

No description

at line 117
string getName()

The simple name of this method.

Generated from protobuf field string name = 1;

Return Value

string

at line 129
$this setName(string $var)

The simple name of this method.

Generated from protobuf field string name = 1;

Parameters

string $var

Return Value

$this

at line 143
string getRequestTypeUrl()

A URL of the input message type.

Generated from protobuf field string request_type_url = 2;

Return Value

string

at line 155
$this setRequestTypeUrl(string $var)

A URL of the input message type.

Generated from protobuf field string request_type_url = 2;

Parameters

string $var

Return Value

$this

at line 169
bool getRequestStreaming()

If true, the request is streamed.

Generated from protobuf field bool request_streaming = 3;

Return Value

bool

at line 181
$this setRequestStreaming(bool $var)

If true, the request is streamed.

Generated from protobuf field bool request_streaming = 3;

Parameters

bool $var

Return Value

$this

at line 195
string getResponseTypeUrl()

The URL of the output message type.

Generated from protobuf field string response_type_url = 4;

Return Value

string

at line 207
$this setResponseTypeUrl(string $var)

The URL of the output message type.

Generated from protobuf field string response_type_url = 4;

Parameters

string $var

Return Value

$this

at line 221
bool getResponseStreaming()

If true, the response is streamed.

Generated from protobuf field bool response_streaming = 5;

Return Value

bool

at line 233
$this setResponseStreaming(bool $var)

If true, the response is streamed.

Generated from protobuf field bool response_streaming = 5;

Parameters

bool $var

Return Value

$this

at line 247
Option> getOptions()

Any metadata attached to the method.

Generated from protobuf field repeated .google.protobuf.Option options = 6;

Return Value

Option>

at line 259
$this setOptions(Option[] $var)

Any metadata attached to the method.

Generated from protobuf field repeated .google.protobuf.Option options = 6;

Parameters

Option[] $var

Return Value

$this

at line 276
int getSyntax() deprecated

deprecated

The source syntax of this method.

This field should be ignored, instead the syntax should be inherited from Api. This is similar to Field and EnumValue.

Generated from protobuf field .google.protobuf.Syntax syntax = 7 [deprecated = true];

Return Value

int

at line 294
$this setSyntax(int $var) deprecated

deprecated

The source syntax of this method.

This field should be ignored, instead the syntax should be inherited from Api. This is similar to Field and EnumValue.

Generated from protobuf field .google.protobuf.Syntax syntax = 7 [deprecated = true];

Parameters

int $var

Return Value

$this

at line 312
string getEdition() deprecated

deprecated

The source edition string, only valid when syntax is SYNTAX_EDITIONS.

This field should be ignored, instead the edition should be inherited from Api. This is similar to Field and EnumValue.

Generated from protobuf field string edition = 8 [deprecated = true];

Return Value

string

at line 330
$this setEdition(string $var) deprecated

deprecated

The source edition string, only valid when syntax is SYNTAX_EDITIONS.

This field should be ignored, instead the edition should be inherited from Api. This is similar to Field and EnumValue.

Generated from protobuf field string edition = 8 [deprecated = true];

Parameters

string $var

Return Value

$this