Struct google_api_proto::google::api::RoutingParameter

pub struct RoutingParameter {
    pub field: String,
    pub path_template: String,
}

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

Fields

field: String

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

path_template: String

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.

Trait Implementations

impl Clone for RoutingParameter

fn clone(&self) -> RoutingParameter

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RoutingParameter

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for RoutingParameter

fn default() -> Self

Returns the “default value” for a type.

impl Message for RoutingParameter

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for RoutingParameter

fn eq(&self, other: &RoutingParameter) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for RoutingParameter