PHPFUI/InstaDoc

A projection from an input message to the GRPC or REST header.

Generated from protobuf message google.api.RoutingParameter

CloneableInstantiable

Extends
Google\Protobuf\Internal\Message

Public
Protected

Methods

public __construct( $data = NULL)

Constructor.

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

@type string $field
      A request field to extract the header key-value pair from.
@type string $path_template
      A pattern matching the key-value field. Optional.
      If not specified, the whole field specified in the `field` field will be
      taken as value, and its name used as key. If specified, it MUST contain
      exactly one named segment (along with any number of unnamed segments) The
      pattern will be matched over the field specified in the `field` field, then
      if the match is successful:
      - the name of the single named segment will be used as a header name,
      - the match value of the segment will be used as a header value;
      if the match is NOT successful, nothing will be sent.
      Example:
                    -- This is a field in the request message
                   |   that the header value will be extracted from.
                   |
                   |                     -- This is the key name in the
                   |                    |   routing header.
                   V                    |
          field: "table_name"           v
          path_template: "projects/&#42;&#47;{table_location=instances/&#42;}/tables/&#42;"
                                                     ^            ^
                                                     |            |
            In the } brackets is the pattern that --             |
            specifies what to extract from the                    |
            field as a value to be sent.                          |
                                                                  |
           The string in the field must match the whole pattern --
           before brackets, inside brackets, after brackets.
      When looking at this specific example, we can see that:
      - A key-value pair with the key `table_location`
        and the value matching `instances/&#42;` should be added
        to the x-goog-request-params routing header.
      - The value is extracted from the request message's `table_name` field
        if it matches the full pattern specified:
        `projects/&#42;&#47;instances/&#42;&#47;tables/&#42;`.
      **NB:** If the `path_template` field is not provided, the key name is
      equal to the field name, and the whole field should be sent as a value.
      This makes the pattern for the field and the value functionally equivalent
      to `**`, and the configuration
          {
            field: "table_name"
          }
      is a functionally equivalent shorthand to:
          {
            field: "table_name"
            path_template: "{table_name=**}"
          }
      See Example 1 for more details.

}

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 getField()

A request field to extract the header key-value pair from.

Generated from protobuf field string field = 1;

return string

public getPathTemplate()

A pattern matching the key-value field. Optional.

If not specified, the whole field specified in the field field will be taken as value, and its name used as key. If specified, it MUST contain exactly one named segment (along with any number of unnamed segments) The pattern will be matched over the field specified in the field field, then if the match is successful:

the name of the single named segment will be used as a header name,
the match value of the segment will be used as a header value; if the match is NOT successful, nothing will be sent. Example: -- This is a field in the request message | that the header value will be extracted from. | | -- This is the key name in the | | routing header. V | field: "table_name" v path_template: "projects/*/{table_location=instances/*}/tables/*" ^ ^ | | In the } brackets is the pattern that -- | specifies what to extract from the | field as a value to be sent. | | The string in the field must match the whole pattern -- before brackets, inside brackets, after brackets. When looking at this specific example, we can see that:
A key-value pair with the key table_location and the value matching instances/* should be added to the x-goog-request-params routing header.
The value is extracted from the request message's table_name field if it matches the full pattern specified: projects/*/instances/*/tables/*. NB: If the path_template field is not provided, the key name is equal to the field name, and the whole field should be sent as a value. This makes the pattern for the field and the value functionally equivalent to **, and the configuration { field: "table_name" } is a functionally equivalent shorthand to: { field: "table_name" path_template: "{table_name=**}" } See Example 1 for more details.

Generated from protobuf field string path_template = 2;

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 setField( $var)

A request field to extract the header key-value pair from.

Generated from protobuf field string field = 1;

param string $var
return $this

public setPathTemplate( $var)

A pattern matching the key-value field. Optional.

the name of the single named segment will be used as a header name,
the match value of the segment will be used as a header value; if the match is NOT successful, nothing will be sent. Example: -- This is a field in the request message | that the header value will be extracted from. | | -- This is the key name in the | | routing header. V | field: "table_name" v path_template: "projects/*/{table_location=instances/*}/tables/*" ^ ^ | | In the } brackets is the pattern that -- | specifies what to extract from the | field as a value to be sent. | | The string in the field must match the whole pattern -- before brackets, inside brackets, after brackets. When looking at this specific example, we can see that:
A key-value pair with the key table_location and the value matching instances/* should be added to the x-goog-request-params routing header.
The value is extracted from the request message's table_name field if it matches the full pattern specified: projects/*/instances/*/tables/*. NB: If the path_template field is not provided, the key name is equal to the field name, and the whole field should be sent as a value. This makes the pattern for the field and the value functionally equivalent to **, and the configuration { field: "table_name" } is a functionally equivalent shorthand to: { field: "table_name" path_template: "{table_name=**}" } See Example 1 for more details.

Generated from protobuf field string path_template = 2;

param string $var
return $this

Properties

protected $field = ''

A request field to extract the header key-value pair from.

Generated from protobuf field string field = 1;

protected $path_template = ''

A pattern matching the key-value field. Optional.

the name of the single named segment will be used as a header name,
the match value of the segment will be used as a header value; if the match is NOT successful, nothing will be sent. Example: -- This is a field in the request message | that the header value will be extracted from. | | -- This is the key name in the | | routing header. V | field: "table_name" v path_template: "projects/*/{table_location=instances/*}/tables/*" ^ ^ | | In the } brackets is the pattern that -- | specifies what to extract from the | field as a value to be sent. | | The string in the field must match the whole pattern -- before brackets, inside brackets, after brackets. When looking at this specific example, we can see that:
A key-value pair with the key table_location and the value matching instances/* should be added to the x-goog-request-params routing header.
The value is extracted from the request message's table_name field if it matches the full pattern specified: projects/*/instances/*/tables/*. NB: If the path_template field is not provided, the key name is equal to the field name, and the whole field should be sent as a value. This makes the pattern for the field and the value functionally equivalent to **, and the configuration { field: "table_name" } is a functionally equivalent shorthand to: { field: "table_name" path_template: "{table_name=**}" } See Example 1 for more details.

Generated from protobuf field string path_template = 2;

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)