PHPFUI/InstaDoc

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

CloneableInstantiable

Extends
Google\Protobuf\Internal\Message

Methods

public __construct( $data = NULL)

Constructor.

param array $data { Optional. Data for populating the Message object.

@type string $name
      The simple name of this method.
@type string $request_type_url
      A URL of the input message type.
@type bool $request_streaming
      If true, the request is streamed.
@type string $response_type_url
      The URL of the output message type.
@type bool $response_streaming
      If true, the response is streamed.
@type \Google\Protobuf\Option[] $options
      Any metadata attached to the method.
@type int $syntax
      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.
@type string $edition
      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.

}

public Google\Protobuf\Internal\Message::__debugInfo()

public Google\Protobuf\Internal\Message::byteSize()

ignore

public Google\Protobuf\Internal\Message::clear()

Clear all containing fields.

return null

public Google\Protobuf\Internal\Message::discardUnknownFields()

Clear all unknown fields previously parsed.

return null

public getEdition()

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 string
deprecated

public getName()

The simple name of this method.

Generated from protobuf field string name = 1;

return string

public getOptions()

Any metadata attached to the method.

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

return \RepeatedField<\Google\Protobuf\Option>

public getRequestStreaming()

If true, the request is streamed.

Generated from protobuf field bool request_streaming = 3;

return bool

public getRequestTypeUrl()

A URL of the input message type.

Generated from protobuf field string request_type_url = 2;

return string

public getResponseStreaming()

If true, the response is streamed.

Generated from protobuf field bool response_streaming = 5;

return bool

public getResponseTypeUrl()

The URL of the output message type.

Generated from protobuf field string response_type_url = 4;

return string

public getSyntax()

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 int
deprecated

public Google\Protobuf\Internal\Message::jsonByteSize( $options = 0)

ignore

public Google\Protobuf\Internal\Message::mergeFrom( $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.

param object $msg Protobuf message to be merged from.
return null

public Google\Protobuf\Internal\Message::mergeFromJsonString( $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.

param string $data Json protobuf data.
param bool $ignore_unknown
return null
throws \Exception Invalid data.

public Google\Protobuf\Internal\Message::mergeFromString( $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.

param string $data Binary protobuf data.
return null
throws \Exception Invalid data.

public Google\Protobuf\Internal\Message::parseFromJsonStream( $input, $ignore_unknown)

ignore

public Google\Protobuf\Internal\Message::parseFromStream( $input)

ignore

public Google\Protobuf\Internal\Message::serializeToJsonStream( $output)

ignore

public Google\Protobuf\Internal\Message::serializeToJsonString( $options = 0)

Serialize the message to json string.

return string Serialized json protobuf data.

public Google\Protobuf\Internal\Message::serializeToStream( $output)

ignore

public Google\Protobuf\Internal\Message::serializeToString()

Serialize the message to string.

return string Serialized binary protobuf data.

public setEdition( $var)

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];

param string $var
return $this
deprecated

public setName( $var)

The simple name of this method.

Generated from protobuf field string name = 1;

param string $var
return $this

public setOptions( $var)

Any metadata attached to the method.

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

param \Google\Protobuf\Option[] $var
return $this

public setRequestStreaming( $var)

If true, the request is streamed.

Generated from protobuf field bool request_streaming = 3;

param bool $var
return $this

public setRequestTypeUrl( $var)

A URL of the input message type.

Generated from protobuf field string request_type_url = 2;

param string $var
return $this

public setResponseStreaming( $var)

If true, the response is streamed.

Generated from protobuf field bool response_streaming = 5;

param bool $var
return $this

public setResponseTypeUrl( $var)

The URL of the output message type.

Generated from protobuf field string response_type_url = 4;

param string $var
return $this

public setSyntax( $var)

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];

param int $var
return $this
deprecated

Properties

protected $edition = ''

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];

deprecated

protected $name = ''

The simple name of this method.

Generated from protobuf field string name = 1;

protected $request_streaming = false

If true, the request is streamed.

Generated from protobuf field bool request_streaming = 3;

protected $request_type_url = ''

A URL of the input message type.

Generated from protobuf field string request_type_url = 2;

protected $response_streaming = false

If true, the response is streamed.

Generated from protobuf field bool response_streaming = 5;

protected $response_type_url = ''

The URL of the output message type.

Generated from protobuf field string response_type_url = 4;

protected $syntax = 0

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];

deprecated

Methods

protected Google\Protobuf\Internal\Message::hasOneof( $number)

protected Google\Protobuf\Internal\Message::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.

param array $array An array containing message properties and values.
return null

protected Google\Protobuf\Internal\Message::mergeFromJsonArray( $array, $ignore_unknown)

protected Google\Protobuf\Internal\Message::readOneof( $number)

protected Google\Protobuf\Internal\Message::readWrapperValue( $member)

protected Google\Protobuf\Internal\Message::whichOneof( $oneof_name)

protected Google\Protobuf\Internal\Message::writeOneof( $number, $value)

protected Google\Protobuf\Internal\Message::writeWrapperValue( $member, $value)

Properties

private $options = NULL

Any metadata attached to the method.

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