Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. MethodDescriptorProto.php

class MethodDescriptorProto

Describes a method of a service.

Generated from protobuf message <code>google.protobuf.MethodDescriptorProto</code>

Hierarchy

  • class \Google\Protobuf\Internal\Message
    • class \Google\Protobuf\Internal\MethodDescriptorProto extends \Google\Protobuf\Internal\Message

Expanded class hierarchy of MethodDescriptorProto

File

vendor/google/protobuf/src/Google/Protobuf/Internal/MethodDescriptorProto.php, line 18

Namespace

Google\Protobuf\Internal
View source
class MethodDescriptorProto extends \Google\Protobuf\Internal\Message {
    
    /**
     * Generated from protobuf field <code>optional string name = 1;</code>
     */
    protected $name = null;
    
    /**
     * 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 <code>optional string input_type = 2;</code>
     */
    protected $input_type = null;
    
    /**
     * Generated from protobuf field <code>optional string output_type = 3;</code>
     */
    protected $output_type = null;
    
    /**
     * Generated from protobuf field <code>optional .google.protobuf.MethodOptions options = 4;</code>
     */
    protected $options = null;
    
    /**
     * Identifies if client streams multiple client messages
     *
     * Generated from protobuf field <code>optional bool client_streaming = 5 [default = false];</code>
     */
    protected $client_streaming = null;
    
    /**
     * Identifies if server streams multiple server messages
     *
     * Generated from protobuf field <code>optional bool server_streaming = 6 [default = false];</code>
     */
    protected $server_streaming = null;
    
    /**
     * Constructor.
     *
     * @param array $data {
     *     Optional. Data for populating the Message object.
     *
     *     @type string $name
     *     @type string $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.
     *     @type string $output_type
     *     @type \Google\Protobuf\Internal\MethodOptions $options
     *     @type bool $client_streaming
     *           Identifies if client streams multiple client messages
     *     @type bool $server_streaming
     *           Identifies if server streams multiple server messages
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Google\Protobuf\Internal\Descriptor::initOnce();
        parent::__construct($data);
    }
    
    /**
     * Generated from protobuf field <code>optional string name = 1;</code>
     * @return string
     */
    public function getName() {
        return isset($this->name) ? $this->name : '';
    }
    public function hasName() {
        return isset($this->name);
    }
    public function clearName() {
        unset($this->name);
    }
    
    /**
     * Generated from protobuf field <code>optional string name = 1;</code>
     * @param string $var
     * @return $this
     */
    public function setName($var) {
        GPBUtil::checkString($var, True);
        $this->name = $var;
        return $this;
    }
    
    /**
     * 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 <code>optional string input_type = 2;</code>
     * @return string
     */
    public function getInputType() {
        return isset($this->input_type) ? $this->input_type : '';
    }
    public function hasInputType() {
        return isset($this->input_type);
    }
    public function clearInputType() {
        unset($this->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.
     *
     * Generated from protobuf field <code>optional string input_type = 2;</code>
     * @param string $var
     * @return $this
     */
    public function setInputType($var) {
        GPBUtil::checkString($var, True);
        $this->input_type = $var;
        return $this;
    }
    
    /**
     * Generated from protobuf field <code>optional string output_type = 3;</code>
     * @return string
     */
    public function getOutputType() {
        return isset($this->output_type) ? $this->output_type : '';
    }
    public function hasOutputType() {
        return isset($this->output_type);
    }
    public function clearOutputType() {
        unset($this->output_type);
    }
    
    /**
     * Generated from protobuf field <code>optional string output_type = 3;</code>
     * @param string $var
     * @return $this
     */
    public function setOutputType($var) {
        GPBUtil::checkString($var, True);
        $this->output_type = $var;
        return $this;
    }
    
    /**
     * Generated from protobuf field <code>optional .google.protobuf.MethodOptions options = 4;</code>
     * @return \Google\Protobuf\Internal\MethodOptions|null
     */
    public function getOptions() {
        return $this->options;
    }
    public function hasOptions() {
        return isset($this->options);
    }
    public function clearOptions() {
        unset($this->options);
    }
    
    /**
     * Generated from protobuf field <code>optional .google.protobuf.MethodOptions options = 4;</code>
     * @param \Google\Protobuf\Internal\MethodOptions $var
     * @return $this
     */
    public function setOptions($var) {
        GPBUtil::checkMessage($var, \Google\Protobuf\Internal\MethodOptions::class);
        $this->options = $var;
        return $this;
    }
    
    /**
     * Identifies if client streams multiple client messages
     *
     * Generated from protobuf field <code>optional bool client_streaming = 5 [default = false];</code>
     * @return bool
     */
    public function getClientStreaming() {
        return isset($this->client_streaming) ? $this->client_streaming : false;
    }
    public function hasClientStreaming() {
        return isset($this->client_streaming);
    }
    public function clearClientStreaming() {
        unset($this->client_streaming);
    }
    
    /**
     * Identifies if client streams multiple client messages
     *
     * Generated from protobuf field <code>optional bool client_streaming = 5 [default = false];</code>
     * @param bool $var
     * @return $this
     */
    public function setClientStreaming($var) {
        GPBUtil::checkBool($var);
        $this->client_streaming = $var;
        return $this;
    }
    
    /**
     * Identifies if server streams multiple server messages
     *
     * Generated from protobuf field <code>optional bool server_streaming = 6 [default = false];</code>
     * @return bool
     */
    public function getServerStreaming() {
        return isset($this->server_streaming) ? $this->server_streaming : false;
    }
    public function hasServerStreaming() {
        return isset($this->server_streaming);
    }
    public function clearServerStreaming() {
        unset($this->server_streaming);
    }
    
    /**
     * Identifies if server streams multiple server messages
     *
     * Generated from protobuf field <code>optional bool server_streaming = 6 [default = false];</code>
     * @param bool $var
     * @return $this
     */
    public function setServerStreaming($var) {
        GPBUtil::checkBool($var);
        $this->server_streaming = $var;
        return $this;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
Message::$desc private property @ignore
Message::$unknown private property
Message::appendHelper private function
Message::byteSize public function @ignore
Message::clear public function Clear all containing fields.
Message::convertJsonValueToProtoValue private function
Message::defaultValue private function @ignore
Message::discardUnknownFields public function Clear all unknown fields previously parsed.
Message::existField private function @ignore
Message::fieldByteSize private function @ignore
Message::fieldDataOnlyByteSize private function @ignore
Message::fieldDataOnlyJsonByteSize private function @ignore
Message::fieldJsonByteSize private function @ignore
Message::hasOneof protected function
Message::initWithDescriptor private function @ignore
Message::initWithGeneratedPool private function @ignore
Message::jsonByteSize public function @ignore
Message::kvUpdateHelper private function
Message::mergeFrom public function Merges the contents of the specified message into current message.
Message::mergeFromArray protected function Populates the message from a user-supplied PHP array. Array keys
correspond to Message properties and nested message properties.
Message::mergeFromArrayJsonImpl private function
Message::mergeFromJsonArray protected function
Message::mergeFromJsonString public function Parses a json string to protobuf message.
Message::mergeFromString public function Parses a protocol buffer contained in a string.
Message::normalizeArrayElementsToMessageType private static function Tries to normalize the elements in $value into a provided protobuf
wrapper type $class. If $value is any type other than array, we do
not do any conversion, and instead rely on the existing protobuf
type checking. If $value is an array, we process…
Message::normalizeToMessageType private static function Tries to normalize $value into a provided protobuf wrapper type $class.
If $value is any type other than an object, we attempt to construct an
instance of $class and assign $value to it using the setValue method
shared by all wrapper types.
Message::parseFieldFromStream private function @ignore
Message::parseFieldFromStreamNoTag private static function @ignore
Message::parseFromJsonStream public function @ignore
Message::parseFromStream public function @ignore
Message::readOneof protected function
Message::readWrapperValue protected function
Message::repeatedFieldDataOnlyByteSize private function @ignore
Message::serializeFieldToJsonStream private function @ignore
Message::serializeFieldToStream private function @ignore
Message::serializeMapFieldToStream private function @ignore
Message::serializeRepeatedFieldToStream private function @ignore
Message::serializeSingularFieldToStream private function @ignore
Message::serializeToJsonStream public function @ignore
Message::serializeToJsonString public function Serialize the message to json string.
Message::serializeToStream public function @ignore
Message::serializeToString public function Serialize the message to string.
Message::skipField private function @ignore
Message::whichOneof protected function
Message::writeOneof protected function
Message::writeWrapperValue protected function
Message::__debugInfo public function
MethodDescriptorProto::$client_streaming protected property Identifies if client streams multiple client messages
MethodDescriptorProto::$input_type protected property Input and output type names. These are resolved in the same way as
FieldDescriptorProto.type_name, but must refer to a message type.
MethodDescriptorProto::$name protected property Generated from protobuf field &lt;code&gt;optional string name = 1;&lt;/code&gt;
MethodDescriptorProto::$options protected property Generated from protobuf field &lt;code&gt;optional .google.protobuf.MethodOptions options = 4;&lt;/code&gt;
MethodDescriptorProto::$output_type protected property Generated from protobuf field &lt;code&gt;optional string output_type = 3;&lt;/code&gt;
MethodDescriptorProto::$server_streaming protected property Identifies if server streams multiple server messages
MethodDescriptorProto::clearClientStreaming public function
MethodDescriptorProto::clearInputType public function
MethodDescriptorProto::clearName public function
MethodDescriptorProto::clearOptions public function
MethodDescriptorProto::clearOutputType public function
MethodDescriptorProto::clearServerStreaming public function
MethodDescriptorProto::getClientStreaming public function Identifies if client streams multiple client messages
MethodDescriptorProto::getInputType public function Input and output type names. These are resolved in the same way as
FieldDescriptorProto.type_name, but must refer to a message type.
MethodDescriptorProto::getName public function Generated from protobuf field &lt;code&gt;optional string name = 1;&lt;/code&gt;
MethodDescriptorProto::getOptions public function Generated from protobuf field &lt;code&gt;optional .google.protobuf.MethodOptions options = 4;&lt;/code&gt;
MethodDescriptorProto::getOutputType public function Generated from protobuf field &lt;code&gt;optional string output_type = 3;&lt;/code&gt;
MethodDescriptorProto::getServerStreaming public function Identifies if server streams multiple server messages
MethodDescriptorProto::hasClientStreaming public function
MethodDescriptorProto::hasInputType public function
MethodDescriptorProto::hasName public function
MethodDescriptorProto::hasOptions public function
MethodDescriptorProto::hasOutputType public function
MethodDescriptorProto::hasServerStreaming public function
MethodDescriptorProto::setClientStreaming public function Identifies if client streams multiple client messages
MethodDescriptorProto::setInputType public function Input and output type names. These are resolved in the same way as
FieldDescriptorProto.type_name, but must refer to a message type.
MethodDescriptorProto::setName public function Generated from protobuf field &lt;code&gt;optional string name = 1;&lt;/code&gt;
MethodDescriptorProto::setOptions public function Generated from protobuf field &lt;code&gt;optional .google.protobuf.MethodOptions options = 4;&lt;/code&gt;
MethodDescriptorProto::setOutputType public function Generated from protobuf field &lt;code&gt;optional string output_type = 3;&lt;/code&gt;
MethodDescriptorProto::setServerStreaming public function Identifies if server streams multiple server messages
MethodDescriptorProto::__construct public function Constructor. Overrides Message::__construct

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal