PHPFUI/InstaDoc
 
Copied!

Define a parameter's name and location. The parameter may be passed as either an HTTP header or a URL query parameter, and if both are passed the behavior is implementation-dependent.

Generated from protobuf message google.api.SystemParameter

CloneableInstantiable
Methods
public __construct( $data = NULL)
 

Constructor.

  • param array $data { Optional. Data for populating the Message object. 
    @type string $name
      Define the name of the parameter, such as "api_key" . It is case sensitive.
@type string $http_header
      Define the HTTP header name to use for the parameter. It is case
      insensitive.
@type string $url_query_parameter
      Define the URL query parameter name to use for the parameter. It is case
      sensitive.
    }
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 getHttpHeader()
 

Define the HTTP header name to use for the parameter. It is case insensitive.

Generated from protobuf field string http_header = 2;

  • return string
public getName()
 

Define the name of the parameter, such as "api_key" . It is case sensitive.

Generated from protobuf field string name = 1;

  • return string
public getUrlQueryParameter()
 

Define the URL query parameter name to use for the parameter. It is case sensitive.

Generated from protobuf field string url_query_parameter = 3;

  • return string
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 setHttpHeader( $var)
 

Define the HTTP header name to use for the parameter. It is case insensitive.

Generated from protobuf field string http_header = 2;

  • param string $var
  • return $this
public setName( $var)
 

Define the name of the parameter, such as "api_key" . It is case sensitive.

Generated from protobuf field string name = 1;

  • param string $var
  • return $this
public setUrlQueryParameter( $var)
 

Define the URL query parameter name to use for the parameter. It is case sensitive.

Generated from protobuf field string url_query_parameter = 3;

  • param string $var
  • return $this
Properties
protected $http_header = ''
 

Define the HTTP header name to use for the parameter. It is case insensitive.

Generated from protobuf field string http_header = 2;

protected $name = ''
 

Define the name of the parameter, such as "api_key" . It is case sensitive.

Generated from protobuf field string name = 1;

protected $url_query_parameter = ''
 

Define the URL query parameter name to use for the parameter. It is case sensitive.

Generated from protobuf field string url_query_parameter = 3;

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)
© 2025 Bruce Wells
Search Namespaces \ Classes
Configuration