1. class
  2. Google
  3. \
  4. Api
  5. \
  6. RoutingParameter

RoutingParameter

class RoutingParameter extends Message

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

Generated from protobuf message google.api.RoutingParameter

Properties

protected $field A request field to extract the header key-value pair from.
protected $path_template A pattern matching the key-value field. Optional.

Methods

__construct(array $data = NULL)

Constructor.

string
getField()

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

$this
setField(string $var)

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

string
getPathTemplate()

A pattern matching the key-value field. Optional.

$this
setPathTemplate(string $var)

A pattern matching the key-value field. Optional.

Details

at line 133
__construct(array $data = NULL)

Constructor.

Parameters

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/*/{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.

}

at line 144
string getField()

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

Generated from protobuf field string field = 1;

Return Value

string

at line 156
$this setField(string $var)

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

Generated from protobuf field string field = 1;

Parameters

string $var

Return Value

$this

at line 215
string 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 Value

string

at line 272
$this setPathTemplate(string $var)

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;

Parameters

string $var

Return Value

$this